Receive Veriff session event webhook

POST /kyc/callback/veriff/event

Parameters

id string Required

The unique ID of the resource being addressed. See the id field in the parent resource's list or GET-by-ID response.

attemptId string Required

The unique ID of a KYC (or KYB) attempt. Returned as id from the create-attempt endpoints — e.g. POST /kyc/veriff/session, POST /kyc/nexeraid/*, or POST /kyb/* — and listed by GET /kyc/attempts.

feature enum Required

No description.

Possible values: selfid

code number Required

No description.

action enum Required

No description.

Possible values: submittedstarted

vendorData string Required

No description.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

curl -X POST "https://heimdall.qa.zoniqx.com/kyc/callback/veriff/event" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "attemptId": "string", "feature": "selfid", "code": 0, "action": "submitted", "vendorData": "string" }'

const response = await fetch("https://heimdall.qa.zoniqx.com/kyc/callback/veriff/event", { method: "POST", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "id": "string", "attemptId": "string", "feature": "selfid", "code": 0, "action": "submitted", "vendorData": "string" }), }); const data = await response.json();

type KycController_veriffEventResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/kyc/callback/veriff/event", { method: "POST", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "id": "string", "attemptId": "string", "feature": "selfid", "code": 0, "action": "submitted", "vendorData": "string" }), }); const data: KycController_veriffEventResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/kyc/callback/veriff/event" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "id": "string", "attemptId": "string", "feature": "selfid", "code": 0, "action": "submitted", "vendorData": "string" } response = requests.post(url, headers=headers, json=payload) data = response.json()