v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Sub-Account

Get Sub-Account KYC URL

The endpoint generates a temporary KYC verification link for a sub-account.

<Note> The sub-account must meet all of the following conditions before a KYC URL can be generated: - The sub-account must be activated (have an associated user). - The sub-account must be active (not locked or blocked). - The sub-account must not have shared KYC enabled. </Note> <Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>
post/api/v4/sub-account/kyc-url

Request body

idstring required

Sub-account external ID. Must belong to the authenticated main account.

Example request

{
  "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51"
}

Response

KYC URL generated successfully

urlstring required

Temporary KYC verification URL

expiresIninteger required

Time in seconds until the link expires

Example response

{
  "url": "https://kyc-provider.example.com/verify/abc123",
  "expiresIn": 3600
}