Skip to main content

Webhook Structure

Zyphe sends the KYC results to your registered webhook URL using a POST request with JSON payload.

  • Set Up a Listener Endpoint: Your server needs to have an endpoint ready to listen for incoming POST requests from Zyphe. This endpoint is the webhook URL you registered with Zyphe.

    For example, if your registered webhook URL is https://yourdomain.com/webhook/kyc, your server should have an endpoint set up to handle requests at /webhook/kyc.

  • Handle JSON Payloads: Ensure your server can parse JSON payloads sent by Zyphe. The KYC results will be sent as a JSON object in the body of the POST request.

  • Secure Your Endpoint: It's a good practice to secure your webhook endpoint. Consider using HTTPS and implementing security measures such as verifying the source of incoming requests.

  • Verify signature: To verify the authenticity and origin of each webhook call, a signature header is included, ensuring it originates from the Zyphe platform and is specific to your organization

Process KYC Results​

  • Webhook Payload: Your endpoint needs to handle both success and failure scenarios. The structure of these payloads is detailed in the documentation, with keys for result_id, event, data. Each specific result type is contained in the data property and includes any custom properties that has been specified in the verification link in the customData property of the object (see details in the Webhook Payload page)
  • Parse and Use the Data: Extract and use the KYC data as per your application's requirements. This might involve updating the user's verification status in your database or triggering other processes based on the KYC result.