Sign in

v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
Payer
V2/Payer

Get compliance status for a user

Retrieves the comprehensive compliance status for a specific user, including KYC and agreement status.

get/v2/payer/{clientUserId}

Path parameters

clientUserIdstring required
Example:user-123

The client user ID to check compliance status for

Headers

x-api-keystring required

API key for authentication

Response

Compliance status retrieved successfully

kycStatusstring
agreementStatusstring
isCompliantboolean
userIdstring

Example response

{
  "kycStatus": "completed",
  "agreementStatus": "completed",
  "isCompliant": true,
  "userId": "a25a4274-8f50-4579-b476-8f35b297d4ad"
}