Cardholders

Register Cardholder

Changed on

Register a new cardholder directly as an active cardholder. This creates the cardholder without the option to use Pliant-based apps like the web or mobile app. This is normally used if the cardholders only interact with the API consumers app and not Pliant itself. Wait for the callback about the fully finished registration process to use this cardholder. For travel use cases, the cardholder can also be a purely technical cardholder. Meaning it is used for issuing a variety of cards, each with a custom customer first and last names. For details, please contact Pliant directly.

post/cardholders/register

Request

Request body

organizationIdstring uuid required

The ID of the organization.

salutation'MR' | 'MRS'

Used mainly for email communication.

firstNamestring required

The first name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total). The full legal first name must be provided, since it is used for sanctions screening. Initial-only values are rejected: a single letter (e.g. K), a single letter followed by a period (e.g. K.) and sequences of initials with or without periods (e.g. J R, J. R.). Short names with two or more letters (e.g. Li, Ng, Wu, Xu) are valid. A violation results in a 400 Bad Request with the error code INCOMPLETE_LEGAL_NAME.

lastNamestring required

The last name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total). The full legal last name must be provided, since it is used for sanctions screening. Initial-only values are rejected: a single letter (e.g. K), a single letter followed by a period (e.g. K.) and sequences of initials with or without periods (e.g. J R, J. R.). Short names with two or more letters (e.g. Li, Ng, Wu, Xu) are valid. A violation results in a 400 Bad Request with the error code INCOMPLETE_LEGAL_NAME.

emailstring required

The email address of the cardholder. This will be used for email communication.

phoneNumberstring nullable

If provided, the phone number must start with + followed by 8 to 15 numbers, e.g. +49123456789. As long as the cardholder does not have a phone number, no cards can be issued for this cardholder! The phone number is mandatory for card usage, since needed for 3DS security mechanism during a purchase.

language'en' | 'de' | 'es' | 'fi' | 'fr' | 'it' | 'pt' | 'nl' | 'et' | 'el' | 'lv' | 'lt' | 'sk' | 'sl' | 'pl' | 'hu' required

Used for setting the language in Pliant apps as well as for email communication.

locale'en-US' nullable

Optional locale. When provided, its language subtag must match language.

tocConfirmedAtstring date-time required

The date-time the terms and conditions which apply to this cardholder were confirmed by the cardholder itself. Please refer to Pliant if you are unsure which terms and conditions are meant here. E.g. 2022-04-13T14:49:50.237794Z.

phoneNumberVerifiedAtstring date-time required

The date-time the phone number was verified by the cardholder. E.g. 2022-04-13T14:49:50.237794Z.

dateOfBirthstring date nullable

The date-of-birth of the cardholder. Depending on the compliance configuration of your payment program, this field may be required. Omitting it in those cases will result in a 400 Bad Request.

nationalitystring nullable

The nationality of the cardholder (ISO 3166-1 alpha-2). Depending on the compliance configuration of your payment program, this field may be required. Omitting it in those cases will result in a 400 Bad Request.

Example request

{
  "locale": "en-US",
  "tocConfirmedAt": "2024-07-19T15:00:00.000000Z",
  "phoneNumberVerifiedAt": "2024-07-19T15:00:00.000000Z"
}

Response

Cardholder is in creation process, wait for the callback to use it.

0 required(unresolved $ref)

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new hu enum value to the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status