GEgetpliant
Beneficiaries

Create Beneficiary

Changed on

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.

post/beneficiaries

Request

Request body

organizationIdstring uuid required

The organization to which the beneficiary belongs.

type'BUSINESS' | 'INDIVIDUAL' required

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

  • BUSINESS: A business entity beneficiary.
  • INDIVIDUAL: An individual person beneficiary.
legalNamestring required

The legal name of the beneficiary.

displayNamestring

The display name of the beneficiary.

emailstring email

The email address of the beneficiary.

streetstring required

The street address of the beneficiary.

postalCodestring required

The postal code of the beneficiary's address.

citystring required

The city of the beneficiary's address.

regionstring

The region or state of the beneficiary's address.

countrystring required

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

Response

Ok

idstring uuid

The unique identifier of the beneficiary.

organizationIdstring uuid

The organization to which the beneficiary belongs.

type'BUSINESS' | 'INDIVIDUAL'

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

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

The legal name of the beneficiary.

displayNamestring

The display name of the beneficiary.

emailstring email

The email address of the beneficiary.

streetstring

The street address of the beneficiary.

postalCodestring

The postal code of the beneficiary's address.

citystring

The city of the beneficiary's address.

regionstring

The region or state of the beneficiary's address.

countrystring

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

activeboolean

Whether the beneficiary is active and can be used for transfers.

Changes