Create Beneficiary

post

https://partner-api.getpliant.com/api/beneficiaries

Create a new beneficiary for the specified organization.

Beneficiaries are entities that can receive external transfers from your organization. You must provide the required address information and specify whether the beneficiary is a business or individual.

Body Params

organizationId

uuid

required

The organization to which the beneficiary belongs.

type

string

enum

required

The type of the beneficiary. It can be one of the following values:

BUSINESS: A business entity beneficiary.
INDIVIDUAL: An individual person beneficiary.

Allowed:

legalName

string

required

The legal name of the beneficiary.

displayName

string

The display name of the beneficiary.

string

The email address of the beneficiary.

street

string

required

The street address of the beneficiary.

postalCode

string

required

The postal code of the beneficiary's address.

city

string

required

The city of the beneficiary's address.

region

string

The region or state of the beneficiary's address.

country

string

required

The country of the beneficiary's address in ISO 3166-1 alpha-2 format (e.g., DE for Germany, US for United States).

Responses

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

200Ok

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.

409Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.

422Unprocessable Content. The request could not be completed due to contents of the request. The syntax of the request content was correct.

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.