Unapprove secure documents for an applicant.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Use this endpoint to unapprove one or more approved secure documents by their data keys. Each unapproved document returns to "Ready for review".
Send a JSON request body with these fields:
| Field | Required | Description |
|---|---|---|
data_keys | Yes | An array of data keys for the documents to unapprove. |
attribute_to_system_user | No | Set to true to show the account's System Account user, rather than the account owner, as the actor for the unapproval in the History panel. Omit it to attribute the unapproval to the account owner. |
{
"data_keys": ["driver_license", "resume"],
"attribute_to_system_user": true
}The response returns the secure documents in their current state, with approved set to false. It also returns unapproved_by, the user the request is attributed to, and unapproved_at, the time of the request.
A document that is already unapproved is returned unchanged, so retrying a request is safe.
The request returns 422 Unprocessable Entity if data_keys is missing, is not an array of strings, or includes a key with no document. In that case no document is unapproved.
Each document is unapproved on its own. If the request fails with a 500 partway through, the documents before the failure stay unapproved and have sent their webhooks. Retry the same request: it skips the documents already unapproved and finishes the rest.
Each document the request unapproves sends one file status webhook. Its payload has approved: false and document_status: "Ready for review", and it omits approved_at and approved_by. A document that was already unapproved sends no webhook.