Beneficiaries V2

Create a beneficiary (V2)

Create a new beneficiary.

post/v2/beneficiaries

Request

Base URL: https://api.ebury.io
URL: https://api.ebury.io/v2/beneficiaries
Auth: API key in header x-api-key

Headers

X-Beneficiary-Policy-Versionstring

The version of the beneficiary validation policy to apply. The latest one is used when omitted.

Request body

namestring nullable

The alias/display name of the beneficiary. The beneficiary's name is bank_account.holder_name.

type'personal' | 'business' | 'null' nullable

The type of the beneficiary.

external_referencestring nullable

The unique external reference submitted by the client for the beneficiary.

phone_numberstring nullable

The phone number of the beneficiary.

payouts_emailstring email nullable

The email of the beneficiary to use during payouts.

identification_typestring nullable

The identification (e.g. TAX ID) type of the beneficiary.

identification_valuestring nullable

The identification (e.g. TAX ID) value of the beneficiary.

Response

Beneficiary created.

idstring required

The identifier of the beneficiary.

aml_statusstring nullable

The AML/screening status of the beneficiary.

activeboolean required

True if beneficiary is active, False otherwise.

editableboolean required

True if beneficiary is editable, False otherwise.

is_first_partyboolean required

True if beneficiary is a first party, False otherwise.

created_datestring required

The date and time when the beneficiary was created.