---
title: "Confirm cardholder identity"
method: PUT
path: "/cards/{cardId}/identity"
tags: ["Physical Card"]
---

# Confirm cardholder identity

`PUT /cards/{cardId}/identity`

## Path parameters

- `cardId` string, uuid, required

## Headers

- `Accept-Version` string, required — Specifies the API version to use for this request.

## Request body

- object
  - `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).
  - `kyc` union, required
    - object — Follow this schema if the **customerType** is **Consumer**
      - `firstName` string, required — The cardholder’s first name.
      - `lastName` string, nullable — The cardholder’s last name.
      - `dob` string, required — The cardholder’s date of birth. Must be in **YYYY-MM-DD** format, cannot be in the future, and the cardholder must be at least 18 years of age.
      - `residentialAddress` object, required — The cardholder’s registered residential address.
        - `line1` string, required — Address line 1 (e.g. flat, floor, building name).
        - `line2` string, required — Address line 2 (e.g. street, district).
        - `line3` string, nullable — Address line 3.
        - `line4` string, nullable — Address line 4.
        - `line5` string, nullable — Address line 5.
        - `country` string, required — Three-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).
        - `postalCode` string, nullable — Postal code of the address.
        - `city` string, required — City, district, or town of the address.
      - `idDocumentType` 'Passport' | 'Health' | 'NationalID' | 'TaxIDNumber' | 'SocialService' | 'DriversLicense', required — Type of government-issued ID used to verify the cardholder. Possible values: **passport**, **health**, **national ID**, **Tax id number**, **social security number** or **drivers license**.
      - `idDocumentNumber` string, required — The ID number corresponding to the government-issued document.
      - `signature` string — Cryptographic signature for verifying payload integrity and authenticity. Only applicable to clients who have opted into the [KYC-as-a-Service API product](https://reap-ra.readme.io/docs/getting-started). Returned in the response of the [`GET /entity/{entityId}/signed-payload` endpoint](https://reap-ra.readme.io/reference/get_entity-entityid-signed-payload).
      - `providerId` string — The KYC provider ID if the cardholder has completed KYC with the provider before.
      - `expiresAt` string, date-time — In ISO 8601 format. Indicates when the signed payload expires. Only applicable to clients who have opted into the [KYC-as-a-Service API product](https://reap-ra.readme.io/docs/getting-started). Returned in the response of the [`GET /entity/{entityId}/signed-payload` endpoint](https://reap-ra.readme.io/reference/get_entity-entityid-signed-payload).
    - object — Follow this schema if the **customerType** is **Business**
      - `fullName` string, required — The card program owner’s entity full legal name. The following characters are not supported: **,;:!?<>~\\%^@{}|[]”_`**.
      - `entityType` 'Person' | 'Company', required — The type of entity. Possible values: **personal**: The cardholder is an individual representing a company. **company**: The cardholder is the company itself, not tied to an individual.
      - `registeredAddress` object, required — The registered address of the legal entity.
        - `line1` string, required — Address line 1. (e.g. company name, PO box, suite, floor, building name).
        - `line2` string, required — Address line 2. (e.g. The street, district).
        - `line3` string, nullable — Address line 3.
        - `line4` string, nullable — Address line 4.
        - `line5` string, nullable — Address line 5.
        - `country` string, required — Three-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).
        - `postalCode` string, nullable — Postal code of the address.
        - `city` string, required — City, district, town or state.
      - `businessName` string, required — The legal business or company name of the card program owner.
      - `businessRegistrationNumber` string, required — The legal entity’s business registration number.
      - `businessOperationAddress` object, required — The address where the business operates.
        - `line1` string, required — Address line 1. (e.g. company name, PO box, suite, floor, building name).
        - `line2` string, required — Address line 2. (e.g. The street, district).
        - `line3` string, nullable — Address line 3.
        - `line4` string, nullable — Address line 4.
        - `line5` string, nullable — Address line 5.
        - `country` string, required — Three-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).
        - `postalCode` string, nullable — Postal code of the address.
        - `city` string, required — City, district, town or state.
      - `cardholder` union — This field is required when the entityType is Person
        - object
          - `firstName` string, required — The cardholder’s first name.
          - `lastName` string, nullable — The cardholder’s last name.
          - `dob` string, required — The cardholder’s date of birth. Must be in **YYYY-MM-DD** format, cannot be in the future, and the cardholder must be at least 18 years of age.
          - `residentialAddress` object, required — The cardholder’s registered residential address.
            - `line1` string, required — Address line 1 (e.g. flat, floor, building name).
            - `line2` string, required — Address line 2 (e.g. street, district).
            - `line3` string, nullable — Address line 3.
            - `line4` string, nullable — Address line 4.
            - `line5` string, nullable — Address line 5.
            - `country` string, required — Three-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).
            - `postalCode` string, nullable — Postal code of the address.
            - `city` string, required — City, district, or town of the address.
          - `idDocumentType` 'Passport' | 'Health' | 'NationalID' | 'TaxIDNumber' | 'SocialService' | 'DriversLicense', required — Type of government-issued ID used to verify the cardholder. Possible values: **passport**, **health**, **national ID**, **Tax id number**, **social security number** or **drivers license**.
          - `idDocumentNumber` string, required — The ID number corresponding to the government-issued document.
          - `signature` string — Cryptographic signature for verifying payload integrity and authenticity. Only applicable to clients who have opted into the [KYC-as-a-Service API product](https://reap-ra.readme.io/docs/getting-started). Returned in the response of the [`GET /entity/{entityId}/signed-payload` endpoint](https://reap-ra.readme.io/reference/get_entity-entityid-signed-payload).
          - `providerId` string — The KYC provider ID if the cardholder has completed KYC with the provider before.
          - `expiresAt` string, date-time — In ISO 8601 format. Indicates when the signed payload expires. Only applicable to clients who have opted into the [KYC-as-a-Service API product](https://reap-ra.readme.io/docs/getting-started). Returned in the response of the [`GET /entity/{entityId}/signed-payload` endpoint](https://reap-ra.readme.io/reference/get_entity-entityid-signed-payload).
        - object
  - `preferredCardName` string, 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 ).
  - `secondaryCardName` string — 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.
  - `meta` object — Any supplementary data about the cardholder, used to identify the user in Reap’s system. Examples include the cardholder’s type or preferences. A phone number and a client ID are required in this field.
    - `otpPhoneNumber` object, required — The cardholder’s phone number, used for receiving SMS notifications related to authentication (e.g., 3DS checkout, mobile wallet verification).
      - `dialCode` number, float, required — The [country dial-in code](https://en.wikipedia.org/wiki/List_of_country_calling_codes#Alphabetical_order). for the cardholder’s phone number. The ‘+’ sign is not needed.
      - `phoneNumber` string, required — The cardholder’s phone number, including the area code.
    - `id` string, required — A unique identifier for the cardholder in your system.
    - `email` string, email, nullable — The cardholder’s email, used as a communication channel for authentication during various occasions (e.g., 3DS checkout, mobile wallet verification). It is highly recommended to provide this field to ensure a seamless authentication experience.

## Response `200`

Cardholder identity confirmed successfully

- object
  - `message` string, required

## Other responses

- `400` — Bad Request
- `404` — Not found
- `406` — Not Acceptable

---

[API](https://skmtc.net/reap-global/apis/reap-api.md) · [All operations](https://skmtc.net/reap-global/apis/reap-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reap-global/reap-api/versions/525072733e02/schema)