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)

Request

  • Base URL
    https://api.ext-sandbox.fourthline.com
  • URL
    https://api.ext-sandbox.fourthline.com/v1/clients/{clientId}/verifications (DocumentAuthentication)
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Path parameters

clientIdstring required

Our unique identifier for the client, returned in the Create workflow response. Whether clientData is required depends on your configuration and integration method. Contact your delivery manager to confirm the fields required for your setup. <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

The unique identifier for the case. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

providerProcessIdstring

Your unique identifier for the case.

statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.