KYC API

Currently it is possible to only pass KYC with the UI provided by XGateway. Use the API below to get a URL.

This API is required only if the customer has not yet passed KYC.

Generates a KYC checkout link for a customer.

post

Initiates a KYC checkout link for a specified customer.

It generates a KYC checkout link for the customer, optionally localized by the provided locale.

Authorizations

api_key

Path parameters

idstringRequired

• Unique identifier of the customer.

Body

application/json

• The request body containing KYC link options.

applicationIdstringOptional

localestringOptional

Responses

201

Created

application/json

400

Database violation

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/customer/{id}/bank-transfer/kyc/initiate HTTP/1.1
Host: localhost:8000
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "locale": "en"
}

{
  "data": "https://checkout.xgateway.tech/kyc/ff36a7a5-08fd-418a-a150-f6f2d36676a8",
  "success": true
}