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: Updates to the user's KYC data.
KYC.STATUS: Submission or updates to the user's KYC status for any rail.

Event Action:

CREATE
UPDATE

Example webhook event

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

{
  "eventId": "evt_1934b4ba519144dc90",
  "eventCategory": "KYC",
  "eventType": "KYC.STATUS",
  "eventAction": "UPDATE",
  "createdAt": "2024-11-20T20:37:49.162Z",
  "timestamp": "2024-11-20T20:38:00.933Z",
  "data": {
    "userId": "3b0d06c8-85dd-498c-ae37-1a1d5c4ea35a",
    "USD_EURO": {
      "onRamp": {
        "usd": {
          "achPull": {
            "status": "ACTIVE",
            "message": "",
            "warnings": []
          },
          "achPush": {
            "status": "ACTIVE",
            "message": "",
            "warnings": []
          }
        },
        "euro": {
          "sepa": {
            "status": "INACTIVE",
            "message": "SEPA onRamp will be available in near future",
            "warnings": []
          }
        }
      },
      "status": "ACTIVE",
      "message": "",
      "offRamp": {
        "usd": {
          "ach": {
            "status": "ACTIVE",
            "message": "",
            "warnings": []
          }
        },
        "euro": {
          "sepa": {
            "status": "ACTIVE",
            "message": "",
            "warnings": []
          }
        }
      },
      "warnings": []
    }
  }
}