Invite Owner for Onboarding

post

https://partner-api.getpliant.com/api/cardholders/invite-owner

Invite a new owner during the onboarding of an organization. An invite email to the indicated email address will be triggered, and the user needs to register with Pliant using our registration flow. This endpoint can only be used during the onboarding of a new organization! As soon as an organization is active, this endpoint will not work anymore for this organization.

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

required

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

language

string

enum

required

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

Responses

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

201Owner successfully invited!

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.