API Reference
Log In
API Reference

Approve Applicant Documents

Approve secure documents for an applicant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to approve one or more secure documents by their data keys.

Send a JSON request body with these fields:

FieldRequiredDescription
data_keysYesAn array of data keys for the documents to approve.
attribute_to_system_userNoSet to true to show the account's System Account user, rather than the account owner, as the actor for the approval in the History panel. Omit it to attribute the approval to the account owner.
{
  "data_keys": ["driver_license", "resume"],
  "attribute_to_system_user": true
}

The response returns the approved secure documents. The request returns 422 Unprocessable Entity if data_keys is missing, includes no document, or includes a document with a pending reupload request.

Path Params
string
required
Body Params
data_keys
array of strings
required

Array of data field keys associated with the documents to approve

data_keys*
boolean

When true, attributes the approval to the account's System Account user (rather than the account owner) in the History panel.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json