Biometric Authentication Webhooks

post

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

Webhook notifications for Biometric Authentication. For setup and authentication, see Webhooks.

Path Params

verificationId

string

required

Our unique identifier for the Client Authentication 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

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 ClientConfirmation
Validation: Expected value
Errors: Must be set to ClientConfirmation

sla

object

Information about the SLA for case processing.

messages

object

Information about the case status.

dataRectified

boolean

required

• true: We corrected some data entered by the client after the case has been successfully completed.
• false: We didn’t correct any data after the case has been successfully completed.
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.