Webhook Integration

This documentation will guide you through the integration process of the KYC feature provided by Zyphe.

Prerequisites

Ensure that you have created a Flow in the Zyphe Dashboard, with your webhook URL configured.

Integration Steps

Follow the steps below to integrate the KYC feature into your website:

1. Register the webhook URL Contact Zyphe's support team to register your webhook URL. Zyphe will send the KYC result to this URL.
2. Create a link Create a link on your website that directs to your Flow link. You can copy the link from the Zyphe Dashboard.
3. User Verification The user clicks the link on your website and is redirected to the Zyphe platform.
4. Zyphe sends results to your webhook The message will be sent via POST method as JSON, using the following structure for success:

{
  "result_id": "f49d3a83-3dac-464a-b97a-bd8f7f1fa9b9",
  "event": "success",
  "data": {
    "kyc": {
      "id": "f49d3a83-3dac-464a-b97a-bd8f7f1fa9b9",
      "kycInquiryId": "e0da16b2-bebc-46ee-aa23-3d92a4dc818e",
      "createdAt": "2023-10-03T10:31:51.303476Z",
      "tenantId": "6098ca37-d11e-4b66-9344-3837dd3852f9",
      "customData": null,
      "status": "success",
      "documentId": "f915626947e64baf9a1454c6e662ecd1",
      "documentType": "GB_DrivingLicense_2015",
      "class": "web-mobile",
      "platform": "iOS",
      "browser": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1",
      "scoreDocumentTotal": 0.9968421,
      "scoreBiometricLifeProof": 0.90229774,
      "scoreBiometricSelfie": 0.99972534,
      "scoreBiometricPhotoId": 0.99972534,
      "scoreBiometricDuplicateAttack": 0.55731136,
      "processCode": "ProcessCompleted",
      "processType": "info",
      "processMessage": "The process has been successfully completed",
      "processAdditionalData": null,
      "identityId": "user@gmail.com"
    }
  },
  "custom": null
}

And for failure:

{
  "result_id": "7fd1c306-7830-4261-b372-181f742055ef",
  "event": "failed",
  "data": {
    "kyc": {
      "id": "7fd1c306-7830-4261-b372-181f742055ef",
      "kycInquiryId": "d72b7afc-6841-4478-9d21-3e8dd3d26695",
      "createdAt": "2023-10-03T10:05:51.851407Z",
      "tenantId": "6098ca37-d11e-4b66-9344-3837dd3852f9",
      "customData": null,
      "status": "failed",
      "documentId": "abcc8e8b7b354cb9978c40b66de2bae3",
      "documentType": "GB_DrivingLicense_2015",
      "class": "web-mobile",
      "platform": "iOS",
      "browser": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1",
      "scoreDocumentTotal": 0.6977895,
      "scoreBiometricLifeProof": 0.828225,
      "scoreBiometricSelfie": 0.9996347,
      "scoreBiometricPhotoId": 0.9996347,
      "scoreBiometricDuplicateAttack": 0.87014455,
      "processCode": "ProcessCompleted",
      "processType": "info",
      "processMessage": "The process has been successfully completed",
      "processAdditionalData": null,
      "identityId": "user@gmail.com"
    }
  },
  "custom": null
}

By following these integration steps, you can easily add the KYC feature to your website and receive the KYC result via webhook. This feature allows users to perform KYC on the Zyphe platform, which can improve security and trust on your website.