Skip to content

Get User KYC Status ​

GET /openapi/v2/users/kyc/status
ItemValue
HTTP methodGET
Request path/openapi/v2/users/kyc/status
Request typequery

Request parameters:

FieldTypeRequiredDescription
emailstringYesUser email address.
cardTypeIdstringYesCard type ID.

Response data: same as Submit User KYC.

This query reports review status. To edit and resubmit KYC, first use Get KYC Supplement Information to obtain allowed, originalRecordNo, expectedVersion, and locked fields. Review status alone is not sufficient to build a supplement request.

Channel certification states ​

In addition to the submission response fields, only this query returns channelKycStatuses.

FieldTypeDescription
channelKycStatusesarrayLocal certification states across channels; no live channel synchronization.
channelKycStatuses[].providerNamestringCPS, PHY, or UNKNOWN for an unmapped channel. Do not depend on array order.
channelKycStatuses[].channelStatusstringNOT_SUBMITTED, PENDING_APPROVAL, APPROVED, REJECTED, MODIFY, CERT_REQUIRED.

status is the aggregate user status. channelStatus / subStatus refer to the product selected by cardTypeId. Check each channel independently; overall approval does not approve every channel. An unaccepted or unknown attempt does not overwrite an earlier confirmed state. Legacy PENDING is normalized to PENDING_APPROVAL in this array. The array is absent from V2 submission and V1 responses.

json
{
  "status": "APPROVED",
  "channelStatus": "PENDING_APPROVAL",
  "submissionStatus": null,
  "channelKycStatuses": [
    {
      "providerName": "CPS",
      "channelStatus": "APPROVED"
    },
    {
      "providerName": "PHY",
      "channelStatus": "PENDING_APPROVAL"
    }
  ]
}

Input validation errors: V2 common responses.