Invite Owner for Onboarding

šŸ”’

Required scope: members:write

The API credential calling this endpoint must be granted the members category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

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
uuid
required

The ID of the organization.

string
enum

Used mainly for email communication.

Allowed:
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, Ć¤Ć¶Ć¼Ć„Ć–Ćœ.- 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.

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, Ć¤Ć¶Ć¼Ć„Ć–Ćœ.- 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.

string
required
length ≤ 50

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

string
length ≤ 16
^\+[0-9]{8,15}$

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

string
enum
required

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

string | null
enum

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

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json