Cardholders

Invite Cardholder

Changed on

Invite a new cardholder to Pliant. An invite email to the provided email address will be triggered, and the cardholder needs to register with Pliant using our registration flow. This means the cardholder is able to use Pliant web and mobile apps once fully registered. You will receive a callback once the cardholder is fully registered and can be used.

post/cardholders/invite

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

Phone number must start with + followed by 8 to 15 numbers, e.g. +49123456789.

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.

isOwnerboolean required

If you want to invite the first owner (during onboarding and before authorization was granted) please use the endpoint POST /cardholders/invite-owner.

dateOfBirthstring date nullable

The date-of-birth of the cardholder.

nationalitystring nullable

The nationality of the cardholder (ISO 3166-1 alpha-2).

Example request

{
  "locale": "en-US"
}

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