FOfourthline
Webhooks

Identity Verification Webhooks

Webhook notifications for <a href="https://docs.fourthline.com/docs/idv-solutions">Identity Verification</a>. For setup and authentication, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>. <br /><br />flowVariant is returned when the workflow offers both eID and verification with a physical ID document. When the workflow does not offer both, the property is absent. eIDVerification means the client completed eID. DocumentVerification means the client completed verification with a physical ID document. Confirm the value with <a href="https://docs.fourthline.com/reference/get-case-status">Get case status</a>.

post/idv/{verificationId}

Request

  • Base URL
    https://mysite.com/api/fourthline
  • URL
    https://mysite.com/api/fourthline/idv/{verificationId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Path parameters

verificationIdstring required

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

Headers

Authorizationstring required

Your Basic or Bearer access token. <br />The examples we’ve provided show Bearer. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>More information: Webhooks – Specify authentication method

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 XML file. <br /><br />Format: MD5 hash <br />Validation: 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 NaturalPersons <br />Validation: Expected value <br />Errors: Must be set to NaturalPersons.

flowVariant'eIDVerification' | 'DocumentVerification'

Returned when the workflow offers both eID and verification with a physical ID document. When the workflow does not offer both, the property is absent. Confirm the value with Get case status. <br /><br />Enum: <br />• eIDVerification: the client completed eID <br />• DocumentVerification: the client completed verification with a physical ID document

dataRectifiedboolean required

The marker for whether the notification was triggered by a post-completion QA data correction. This field is included in every webhook notification. <br /><br />• true: A Fourthline QA analyst has corrected case data after the verification was completed. <br />• false: Standard notification. No post-completion QA correction has been applied. <br /><br />This feature is only active if Fourthline has enabled QA corrections for your account. Contact your delivery manager for more information. <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.

Changes

No recorded changes to this operation across all 1 revision of this API.