Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Identity Verification

Reset multiple documents

Use this endpoint to clear multiple clients’ ID document data from their profile so they can re-start an Identity Verification workflow with the same document, using the clientId. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/idv-integration#duplicated-id-document-check">integration guide</a>.

post/whitelisting/batch

Headers

Content-Typestring
Authorizationstring required

The access_token returned in your most recent Create access token response.

Request body

clientsstring[] required

The unique identifiers of the clients whose documents you want to reset, returned in the Create workflow responses. <br /><br />Maximum: 10,000 <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Response

Documents reset completed

requestedinteger

The number of client profiles you requested to reset.

affectedinteger

The number of documents to which the request has been applied.

clientIdsstring[]

The unique identifiers for the client profiles.

statusstring

The status of the reset request.

messagestring

More information about the reset request.