Skip to main content
POST
/
api
/
v1
/
treasury
/
users
/
{id}
/
kyc
Initiate KYC verification for an end-user
curl --request POST \
  --url http://localhost:3001/api/v1/treasury/users/{id}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicant": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthDate": "1990-01-15",
    "residentialAddress": {},
    "identifyingInformation": [
      {}
    ],
    "sourceOfFunds": "<string>"
  },
  "documents": [
    {}
  ]
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "partnerEndUserId": "<string>",
    "status": "PENDING",
    "updatedAt": "<string>",
    "level": {},
    "rejectionReasons": [
      "<string>"
    ],
    "kycLinkUrl": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
applicant
object
required
documents
object[]

Optional document metadata for identity verification

Response

KYC initiated

success
boolean
required
Example:

true

data
object
required