Check KYC status

The following API provides KYC status of a customer.

Retrieves the details of a Know Your Customer (KYC) application for a specified customer.

get

Retrieves the details of a Know Your Customer (KYC) application for a specified customer. This includes the KYC status, any missing documents, and details about any issues or rejections in the KYC process.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations
Path parameters
idstringRequired
  • The external identifier for the customer for whom to retrieve KYC details.
Responses
200

Ok

application/json
get
GET /api/v2/customer/{id}/bank-transfer/kyc HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "SOFT_KYC_FAILED",
    "docsMissing": [
      {
        "docType": "PASSPORT"
      },
      {
        "docType": "DRIVERS"
      },
      {
        "docType": "ID_CARD"
      },
      {
        "docType": "RESIDENCE_PERMIT"
      },
      {
        "docType": "SELFIE"
      }
    ],
    "kycEndUserErrorMessage": "Enter your date of birth exactly as it is on your identity document."
  },
  "success": true
}

Last updated