KYC

You can expect to receive KYC webhook events whenever you update a user's KYC data, submit KYC to unlock a rail, or receive KYC status updates for any rail you've submitted.

Event Category:

KYC

Event Type:

KYC.DATA.UPDATE: Updates to the user's KYC data.
KYC.STATUS.CREATE: Submission of the user's KYC status for any rail.
KYC.STATUS.UPDATE: Update of the user's KYC status for any rail.

Example KYC.DATA Webhook Event

The data object is expected to have the same structure as the response from the Get KYC Data endpoint.

{
  "eventId": "evt_19571191645da9be1",
  "eventCategory": "KYC",
  "eventType": "KYC.DATA.UPDATE",
  "eventAction": "UPDATE",
  "data": {
    "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
    "kycInfo": {
      "type": "individual",
      "email": "[email protected]",
      "phone": null,
      "idType": null,
      "address": {
        "city": "New York",
        "country": "USA",
        "postalCode": "12345",
        "addressLine1": "123 Main St.",
        "stateProvinceRegion": "NY"
      },
      "purpose": null,
      "idNumber": null,
      "lastName": "Yang",
      "firstName": "William",
      "govIdType": null,
      "ipAddress": null,
      "middleName": null,
      "dateOfBirth": "2000-01-16T00:00:00+00:00",
      "govIdNumber": null,
      "nationality": null,
      "govIdBackUrl": null,
      "govIdCountry": null,
      "govIdFrontUrl": null,
      "lastNameLocal": null,
      "countryOfBirth": null,
      "firstNameLocal": null,
      "middleNameLocal": null,
      "additionalIdType": null,
      "govIdHandHoldUrl": null,
      "supplementaryUrl": null,
      "govIdIssuanceDate": null,
      "proofOfAddressUrl": null,
      "supplementaryInfo": null,
      "additionalIdNumber": null,
      "proofOfAddressType": null,
      "sofEuQuestionnaire": null,
      "govIdExpirationDate": null,
      "govIdIssuanceAuthority": null,
      "productServiceCategory": null,
      "taxIdentificationNumber": null
    }
  },
  "createdAt": "2025-03-07T14:53:44.443Z",
  "timestamp": "2025-03-07T14:54:00.326Z",
  "version": "v2"
}

Example KYC.STATUS Webhook Event

The data object is expected to have the same structure as the response from the Get KYC Status endpoint.

{
  "eventId": "evt_195711af0545510a78",
  "eventCategory": "KYC",
  "eventType": "KYC.STATUS.CREATE",
  "eventAction": "CREATE",
  "data": {
    "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
    "SOUTH_AMERICA_LIGHT": {
      "limit": {},
      "onRamp": {
        "brl": {
          "pix": {
            "status": "PENDING",
            "message": "",
            "warnings": []
          }
        }
      },
      "status": "PENDING",
      "message": "",
      "offRamp": {
        "ars": {
          "transfers": {
            "status": "PENDING",
            "message": "",
            "warnings": []
          }
        },
        "brl": {
          "pix": {
            "status": "PENDING",
            "message": "",
            "warnings": []
          }
        },
        "cop": {
          "achCop": {
            "status": "PENDING",
            "message": "",
            "warnings": []
          }
        },
        "mxn": {
          "spei": {
            "status": "PENDING",
            "message": "",
            "warnings": []
          }
        }
      },
      "warnings": []
    }
  },
  "createdAt": "2025-03-07T14:55:45.780Z",
  "timestamp": "2025-03-07T14:56:00.355Z",
  "version": "v2"
}