Register Cardholder

post

https://partner-api.getpliant.com/api/cardholders/register

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.

Body Params

organizationId

uuid

required

The ID of the organization.

salutation

string

enum

Used mainly for email communication.

Allowed:

firstName

string

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, äöüÄÖÜ.- Maximum length of the combination of first name and last name must not be more then 25 digits (to ensure its correctly displayed on the cards).

lastName

string

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, äöüÄÖÜ.- Maximum length of the combination of first name and last name must not be more then 25 digits (to ensure its correctly displayed on the cards).

string

required

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

phoneNumber

string | null

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

string

enum

required

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

tocConfirmedAt

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.

phoneNumberVerifiedAt

date-time

required

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

dateOfBirth

date | null

The date-of-birth of the cardholder.

nationality

string | null

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

personalAddress

object | null

The personal address of the cardholder.

deliveryAddress

object | null

The delivery address of the cardholder.

Responses

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

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.