Skip to main content

Custom Fields

Custom fields let you correlate a Zyphe result with records in your system without encoding business context into the webhook URL itself.

Add query parameters to the verification link you give the user:

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

The values are returned in two places:

{
  "data": {
    "dv": {
      "customData": {
        "uid": "123",
        "product": "exchange"
      }
    }
  },
  "custom": {
    "uid": "123",
    "product": "exchange"
  }
}
  • custom is the flow-level value used for reconciliation and routing.
  • data.<type>.customData is the custom-data snapshot attached to that verification request.

Use opaque identifiers rather than sensitive personal information in query parameters. URLs may appear in browser history, analytics, logs, and referrer headers.

For the surrounding envelope and step fields, see Receiving Webhooks and Webhook Payload.