Error codes

api_keys.scope

HTTP status

403

Message

the API key has no {scope} scope

Returned by

• POST/v1/uploads/{upload_id}/completeComplete an upload
• POST/v1/appsCreate an OAuth app
• POST/v1/sourcesCreate a source
• POST/v1/uploadsStart a multipart upload
• DELETE/v1/apps/{app_id}Delete an OAuth app
• DELETE/v1/app-authorizations/{authorization_id}Revoke an employee authorization
• DELETE/v1/sources/{source_id}Delete a source
• DELETE/v1/uploads/{upload_id}Cancel an upload
• GET/v1/api-logs/{request_id}Get an API request
• GET/v1/api-usageGet API usage
• GET/v1/apps/{app_id}Get an OAuth app
• GET/v1/push/sources/{source_id}/documents/{external_id}Get the result of a document
• GET/v1/sources/{source_id}Get a source
• GET/v1/webhook-events/{event_id}Get an event
• GET/v1/api-logsList API requests
• GET/v1/app-authorizationsList app authorizations
• GET/v1/appsList OAuth apps
• GET/v1/push/sources/{source_id}/syncs/{sync_number}/documentsList document results of a sync
• GET/v1/webhook-eventsList events
• POST/v1/push/sources/{source_id}/syncs/{sync_number}/closeClose a sync
• DELETE/v1/push/sources/{source_id}/documents/{external_id}Delete a document
• GET/v1/push/sources/{source_id}/syncs/{sync_number}Get a sync
• POST/v1/push/sources/{source_id}/syncsOpen a sync
• GET/v1/push/sources/{source_id}Check the key and get the state of a custom source
• POST/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirm documents without sending them again
• POST/v1/push/sources/{source_id}/documentsSend a document (create or replace)
• POST/v1/push/sources/{source_id}/documents/batchSend a batch of documents
• POST/v1/apps/{app_id}/rotate-secretRotate the client secret
• PATCH/v1/apps/{app_id}Update an OAuth app
• PATCH/v1/sources/{source_id}Update a source
• PATCH/v1/sources/{source_id}/settingsUpdate source settings
• PUT/v1/uploads/{upload_id}/parts/{n}Send an upload part
• POST/v1/users/{user_id}/offboardOffboard a user
• POST/v1/users/importImport users from CSV

error.code is the code on this page; error.request_id matches the X-Request-Id header; error.doc_url links to this page.