Get KYC url

POST

/api/v1/kyc/url

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/kyc/url' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "phoneNumber": "+91-7606908888",
  "clientCustomerId": "CUSsdsdffssafT123456",
  "type": "INDIVIDUAL",
  "email": "john.doe@example.com",
  "kycRedirectUrl": "https://example.com/kyc-callback"
}'

Response Example

200 - 200 OK

{
    "status": 1,
    "code": 200,
    "data": {
        "kycUrl": "https://test.onramp.money/onramp-circle/main/profile/?appId=711752&kybData=FlQGDFoyEigWOzxDSUlAbgoQAyY1Gwl1My09V1FBVEIRJgVEUgYy",
        "clientCustomerId": "ROx923-2end-3df",
        "customerId": "w6Rc2asJSU_1094"
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200200 OK

application/json

Body

🟠400400 Duplicate phoneNumber

🟠400400 Missing Parameters

🟠400400 Invalid phoneNumber string

🟠401401 Unauthorized

Modified at 2025-07-18 22:21:19

Fiat

Check KYC status