Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Identity Verification

Reset document by verificationId

Use this endpoint to clear a client’s ID document data from their profile so they can re-start an Identity Verification workflow with the same document, using the verificationId. <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>.

put/whitelisting/verification/{verificationId}

Path parameters

verificationIdstring required

The unique identifier for the Identity Verification case. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as the workflowId returned in the Create workflow response. Use this as the case reference number for any questions.

Headers

Content-Typestring
Authorizationstring required

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

Response

Document reset completed

verificationstring

The unique identifier for the Identity Verification case. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as the workflowId returned in the Create workflow response.

clientstring

Our unique identifier for the client, returned in your first Create workflow request for this client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

statusstring

The status of the reset request.

messagestring

More information about the reset request.