v1

latestOpenAPI 3.0.02026-08-04620256.0 KB

Physical Card

Confirm cardholder identity

put/cards/{cardId}/identity

Path parameters

cardIdstring uuid required

The unique identifier of the card to be verified against the cardholder’s or business information.

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

customerType'Business' | 'Consumer' required

Specifies whether the cardholder is an individual or a business. Possible values:

Business: For corporate customers, aligned with Business BIN products.

Consumer : For personal customers, aligned with Retail BIN products. Ensure this value matches the card product selected (Business BIN or Retail BIN).

preferredCardNamestring required

The name to be printed on the physical card, displayed in uppercase. Allowed characters: letters (A-Z, a-z), digits (0-9), non-English letters (äöüÄÖÜ), space, and / - ^ . apostrophe ).

secondaryCardNamestring

The name to be printed on the physical card, displayed in uppercase. Unsupported characters: ;:!?<>~\%^@{}|[]”_.

Note: If you wish to print a physical card with the secondaryCardName, please communicate with your relationship manager. This is an additional feature that must be activated during the card design approval process.

Example request

{
  "kyc": {
    "dob": "1990-08-08",
    "residentialAddress": {
      "country": "HKG"
    }
  }
}

Response

Cardholder identity confirmed successfully

messagestring required