SubAccount

Get KYC verification page link for a sub-account

get/v0.2.4/sub-account/kyc/link

Request

Base URL
https://api.chimoney.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/sub-account/kyc/link/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

subAccountIDstring required

Sub Account ID

redirectUrlstring uri

Redirect URL after verification completion

Response

KYC link generated successfully

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "KYC link generated successfully",
  "data": {
    "kycUrl": "https://dash.chimoney.io/verify/kyc/907b90ef-d723-4b07-9f74-480afb5f09ef",
    "subAccountID": "907b90ef-d723-4b07-9f74-480afb5f09ef",
    "redirectUrl": "https://example.com/kyc-complete"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.