Check KYC status

The following API provides KYC status of a customer. You may use this API to control the entire KYC sequence for a specific customer.

Please, do not continue the flow up until you receive the FULL_USER status.

KYC Statuses

Statuses:

• null - user is not created. Use (or wait for completion of) this API call

• CREATED → user created, but the applicant is not created. Use (or wait for completion of) this API call

• PENDING_KYC_DATA → applicant created, awaiting data for KYC

• KYC_PENDING → KYC is in progress (equal to SDK steps)

• SOFT_KYC_FAILED → non-critical KYC failure

• HARD_KYC_FAILED → critical KYC failure

• FULL_USER → KYC completed successfully

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.

Status values:

• null - No customer or customer profile exists yet. Customer needs to be created and have an profile.

• "CREATED" - Customer exists, but KYC applicant has not been created yet.

• Other values - KYC process is in progress or completed (e.g., "FULL_USER", "SOFT_KYC_FAILED", etc.).

Authorizations

api_key

x-api-keystringRequired

Path parameters

idstringRequired

• The external identifier for the customer for whom to retrieve KYC details.

Responses

200

Ok

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/customer/{id}/bank-transfer/kyc

HTTPcURLJavaScriptPython

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": null
  },
  "success": true
}