v2

post

https://mysite.com/{workflowId}

Webhook notifications for v2. Fourthline sends workflow events to your configured callback endpoint.

Note Note: v2 notifications follow a polymorphic model. The schema of the details object depends on the product or workflow type associated with the event.

The request body is a single JSON object. Properties with a null value are omitted.

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. It is on the event, next to workflowId. eIDVerification means the client completed eID. DocumentVerification means the client completed verification with a physical ID document. Confirm the value with Get workflow status.

Path Params

workflowId

uuid

required

Unique identifier for the workflow.

Format: uuid

Example: f97f23d2-d0ca-4d15-9de4-d2e19c89b9aa

Body Params

One v2 webhook notification (camelCase). Each POST contains a single object.

One v2 webhook notification. Each POST body is this object. Properties with a null value are omitted.

workflowId

uuid

required

The unique identifier of the workflow.

Format: uuid

Example: f97f23d2-d0ca-4d15-9de4-d2e19c89b9aa

workflow

string

required

The Hub workflow configuration name for the products in this flow.

Example: BiometricsOnly, PaymentsOnly, IdvWorkflow

flowVariant

string

enum

Returned on the event, next to workflowId, 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 workflow status.

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

Allowed:

details

required

Product-specific notification payload. The shape depends on details.name.

Response

200Your server acknowledges receipt. Return HTTP 2xx (typically 200) with an empty body ({}) or no body.