Skip to main content
POST
/
cardaccounts
/
simulate-client-identity-status
Simulate client identity approval or rejection
curl --request POST \
  --url https://access.utgl.io/v1/cardaccounts/simulate-client-identity-status \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cardAccountId": "6e519e8e-15ac-483e-b6ac-d0f42aee36b2",
  "rejectedReason": "Document expired",
  "rejectionAdditionalInfo": "Please update your proof of address and resubmit within 14 days."
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cardAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kycStatus": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
cardAccountId
string<uuid>
required

The card account ID whose client identity will be approved or rejected

Example:

"6e519e8e-15ac-483e-b6ac-d0f42aee36b2"

​
action
enum<string>
required

The action to simulate on the client identity

Available options:
approve,
reject
​
rejectedReason
string

Required when action is reject. The reason for rejection.

Maximum string length: 500
Example:

"Document expired"

​
rejectionAdditionalInfo
string

Optional additional details about the KYC rejection, such as documents or follow-up instructions.

Maximum string length: 1000
Example:

"Please update your proof of address and resubmit within 14 days."

Response

Successfully simulated client identity status change

​
id
string<uuid>

The client identity ID

​
cardAccountId
string<uuid>

The card account ID

​
kycStatus
string

The updated KYC status after the simulated action