Add beneficiary

post

https://api.infinant.com/interlace/accounts-api/v1/accounts/{accountId}/beneficiaries

Create an account beneficiary

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

Account identifier - Account number

Body Params

The data of the account beneficiary to be created

name

object

Beneficiary name

taxId

string

Beneficiary TIN

taxIdType

string

enum

Tax Id Type

Allowed:

dateOfBirth

date

The beneciary's date of birth. ISO 8601 full-date in format ''YYYY-MM-DD''

addresses

array of objects

An array of the beneficiary's physical mail addresses

addresses

emails

array of objects

An array of the beneficiary's electronic mail addresses

emails

phones

array of objects

An array of the beneficiary's telephone numbers

phones

beneficiaryType

string

enum

Beneficiary type

Allowed:

relationship

string

enum

Beneficiary relationship

Allowed:

sharePercentage

double

Share percentage

Headers

x-idempotency-key

string

required

length ≤ 256

Used to de-duplicate requests - UUID

x-rquid

uuid

required

Unique request identifier - UUID

x-userid

string

To identify end-user on client authenticated request

x-tecd-alias

string

TECD alias that overrides default user's tecd

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created

400Bad request