Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Webhooks

Document Authentication Webhooks

Webhook notifications for <a href="https://docs.fourthline.com/docs/authentication-solutions#document-authentication">Document Authentication</a>. For setup and authentication, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>.

post/docauth/{verificationId}

Path parameters

verificationIdstring required

Our unique identifier for the Document Authentication case. <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

verificationIdstring required

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

hashstring

The hash code of the case zipfile. <br /><br />Format: MD5 hash <br />Errors: Invalid MD5 hash

status'new' | 'pending' | 'inconsistent_data' | 'invalid_data' | 'completed' required

The case status. <br />Validation: Valid enum value <br />Errors: Invalid enum value.

processTypestring required

The type of workflow. <br />Expected value: Always ClientDocumentRenewal <br />Validation: Expected value <br />Errors: Must be set to ClientDocumentRenewal

dataRectifiedboolean required

• true: We corrected some data entered by the client after the case has been successfully completed. <br />• false: We didn’t correct any data after the case has been successfully completed. <br />Validation: true or false value <br />Errors: Invalid boolean value.

timestampstring required

The timestamp for this notification. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: 2020-07-10 15:00:00.000 <br />Validation: Valid datetime <br />Errors: Invalid datetime

Response

Return HTTP 2xx to acknowledge receipt. See Handle webhook deliveries.

object required

A successful response is empty.