Identity Verification Webhooks

post

https://mysite.com/api/fourthline/idv/{verificationId}

Webhook notifications for Identity Verification. For setup and authentication, see Webhooks.

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 Get case status.

Path Params

verificationId

string

required

Our unique identifier for the Identity Verification case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Body Params

verificationId

string

required

Our unique identifier for the case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0
Validations: uuid format, verificationId exists
Errors: Format is incorrect or doesn’t exist

hash

string

The hash code of the XML file.

Format: MD5 hash
Validation: MD5 hash
Errors: Invalid MD5 hash

status

string

enum

required

The case status.
Validation: Valid enum value
Errors: Invalid enum value.

Allowed:

processType

string

required

Defaults to NaturalPersons

The type of workflow.
Expected value: Always NaturalPersons
Validation: Expected value
Errors: Must be set to NaturalPersons.

flowVariant

string

enum

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.

Enum:
• eIDVerification: the client completed eID
• DocumentVerification: the client completed verification with a physical ID document

Allowed:

sla

object

Information about the SLA for case processing.

messages

object

Information about the case status.

dataRectified

boolean

required

The marker for whether the notification was triggered by a post-completion QA data correction. This field is included in every webhook notification.

• true: A Fourthline QA analyst has corrected case data after the verification was completed.
• false: Standard notification. No post-completion QA correction has been applied.

This feature is only active if Fourthline has enabled QA corrections for your account. Contact your delivery manager for more information.
Validation: true or false value
Errors: Invalid boolean value.

timestamp

string

required

The timestamp for this notification.

Format: ISO 8601 UTC date and time

Example: 2020-07-10 15:00:00.000
Validation: Valid datetime
Errors: Invalid datetime

Responses

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

401Fourthline could not authenticate with your webhook endpoint. See troubleshooting.

403Fourthline could not authenticate with your webhook endpoint. See troubleshooting.

404Fourthline can reach your server, but the webhook endpoint could not be found. See troubleshooting.

500Your server received the request but could not process it successfully. See troubleshooting.