Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Document Authentication

Create Document Authentication

Use this endpoint to create a Document Authentication case with the clientId from a previous successful Identity Verification case. <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/docauth-integration-api">integration guide</a>.

post/v1/clients/{clientId}/verifications (DocumentAuthentication)

Path parameters

clientIdstring required

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

Headers

Authorizationstring required

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

Request body

providerProcessIdstring required

Your unique identifier for the case. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: To create multiple cases for the same clientId, you must specify a unique providerProcessId for each separate case.

processTypestring required

The case type: ClientConfirmation= Biometric Authentication case

branchstring

Your configuration for this product. <br />Set the string provided by your Fourthline delivery manager.<br />If not set, we use your default configuration. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this parameter for case configuration in older setups.

Response

Document authentication case created

verificationIdstring

Our unique identifier for the case. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br />Validations: uuid format, verificationId exists <br />Errors: Format is incorrect or doesn’t exist

providerProcessIdstring

Your unique identifier for the case.

statusstring

The case status.