Custom Fields

You can include custom data into the URL that you give to users, which is handy to track the KYC process via the webhook and reconcile on your server.

You will always receive the users email in the webhook under the identityEmail key but for example you might have a Unique User ID in your own database. To send that through, add it to the link:

https://verify.zyphe.com/<flow_slug>/kyc/<step_slug>?uid=123

In this example, uid will come back in the customData keys on the webhook responses, e.g:

{
  "result_id": "936f35a8-4921-430e-b016-15be48968886",
  "event": "COMPLETED",
  "data": {
    "dv": {
      "version": 0,
      "id": "d65fa9a0-596e-4d7e-afd1-59a23bfb5a74",
      "verificationRequestId": "cf52e18e-28d1-4a2f-8304-c04ef5a75d0f",
      "flowId": "2d8285d7-f4ba-42df-ab3f-681d9870d37a",
      "flowStepId": "03559a0f-be8e-4ab7-964d-1ff4745d92a4",
      "createdAt": "2025-04-25T19:32:14.558006634Z",
      "customData": {},
      "status": "PASSED",
      "reason": null,
      "documentId": "d41bc0ea-3b5c-4342-a1ae-a46dd0a770f8",
      "documentType": "Driving License",
      "class": null,
      "platform": null,
      "browser": null,
      "scoreBiometricSelfie": 99,
      "errorMessage": null,
      "processAdditionalData": {},
      "identityEmail": "admin@zyphe.com"
    }
  },
  "custom": null
}

You can add multiple parameters to the link:

https://verify.zyphe.com/<flow_slug>/kyc/<step_slug>?uid=123&product=exchange