---
updatedAt: 2026-04-21T09:29:18.000Z
agentTools:
  projectIndex: https://partner.getpliant.com/llms.txt
---

# 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.**


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "name": "API Support",
      "email": "support@getpliant.com",
      "url": "https://www.getpliant.com"
    },
    "title": "Pliant Partner API",
    "description": "Pliant Partner API",
    "version": "2.1.0",
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/license/MIT"
    }
  },
  "servers": [
    {
      "url": "https://partner-api.getpliant.com/api",
      "description": "Pliant Production Server"
    },
    {
      "url": "https://sandbox.partner-api.getpliant.com/api",
      "description": "Pliant Sandbox Server"
    },
    {
      "url": "https://pci-api.getpliant.com",
      "description": "PCI Vault Production Server"
    },
    {
      "url": "https://pci-sandbox.partner-api.getpliant.com",
      "description": "PCI Vault Sandbox Server"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "java",
      "kotlin"
    ],
    "headers": [
      {
        "key": "Pliant-API-Version",
        "value": "2.1.0"
      }
    ]
  },
  "tags": [
    {
      "name": "Cardholders",
      "description": "This tag is for operations related to cardholders"
    }
  ],
  "paths": {
    "/cardholders/invite-owner": {
      "post": {
        "summary": "Invite Owner for Onboarding",
        "description": "> 🔒 **Required scope:** `members:write`\n>\n> The API credential calling this endpoint must be granted the `members` category with `read & write` access.\n> Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.\n> A credential without this scope receives `403 Forbidden` with the error code `INSUFFICIENT_PERMISSION`.\n\nInvite 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.**\n",
        "x-required-scopes": [
          "members:write"
        ],
        "tags": [
          "Cardholders"
        ],
        "operationId": "invite-owner",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardholderOwnerInvite"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Owner successfully invited!",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "$ref": "#/components/schemas/CardholderOwner"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "This API uses oAuth2 with client credentials flow to [obtain the Bearer Token](/docs/authenticated-api-usage).",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "CardholderOwnerInvite": {
        "type": "object",
        "required": [
          "organizationId",
          "firstName",
          "lastName",
          "email",
          "language"
        ],
        "properties": {
          "organizationId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the organization."
          },
          "salutation": {
            "type": "string",
            "description": "Used mainly for email communication.",
            "enum": [
              "MR",
              "MRS"
            ]
          },
          "firstName": {
            "type": "string",
            "description": "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`."
          },
          "lastName": {
            "type": "string",
            "description": "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`."
          },
          "email": {
            "type": "string",
            "maxLength": 50,
            "description": "The email address of the cardholder. This will be used for email communication."
          },
          "phoneNumber": {
            "type": "string",
            "maxLength": 16,
            "pattern": "^\\+[0-9]{8,15}$",
            "description": "Optional. Phone number must start with `+` followed by 8 to 15 numbers, e.g. `+49123456789`."
          },
          "language": {
            "type": "string",
            "enum": [
              "en",
              "de",
              "es",
              "fi",
              "fr",
              "it",
              "pt",
              "nl",
              "et",
              "el",
              "lv",
              "lt",
              "sk",
              "sl",
              "pl",
              "hu"
            ],
            "description": "Used for setting the language in Pliant apps as well as for email communication."
          },
          "locale": {
            "type": "string",
            "nullable": true,
            "enum": [
              "en-US"
            ],
            "example": "en-US",
            "description": "Optional locale. When provided, its language subtag must match `language`."
          }
        }
      },
      "CardholderOwner": {
        "type": "object",
        "required": [
          "cardholderId",
          "isOwner"
        ],
        "properties": {
          "cardholderId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the cardholder."
          },
          "isOwner": {
            "type": "boolean",
            "description": "If `true`, the [cardholder](/docs/cardholder-entity) is the owner of the organization. The owner is allowed to administer all settings of the organization on the Pliant platform. If `false`, the [cardholder](/docs/cardholder-entity) is a plain [cardholder](/docs/cardholder-entity) with limited rights on the Pliant platform."
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error code"
          },
          "exceptionId": {
            "type": "string",
            "format": "uuid",
            "description": "The id of the exception that was thrown"
          },
          "message": {
            "type": "string",
            "description": "The cause of the error or further explanations on the error"
          }
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request. The API consumer sent a malformed request which could not be processed.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized. The API consumer is not authorized to access the requested resource.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden. The API consumer is not allowed to access the requested resource.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "404": {
        "description": "Not Found. The requested resource could not be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our [API guidelines](/docs/pliant-api-guidelines#api-rate-limits).",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "Detailed description of the error and breached rate limit."
                }
              }
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error. The request was not completed due to an internal error.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```