Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Beneficiaries

Create Account Beneficiaries

Creates an Account Beneficiary by accountID.

post/accounts/{accountID}/beneficiaries

Path parameters

accountIDstring required

The user's unique account identifier.

Example:cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759

Request body

Example request

{
  "primary": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "percentage": 0.25,
      "email": "tom@ac.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5512478089",
      "phone": "4153647890",
      "address": "123 Main Street, New York, NY 10001",
      "relationship": "Trust",
      "idType": "EIN",
      "idNo": "123456789",
      "formationCountry": "USA"
    }
  ],
  "contingent": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "percentage": 0.25,
      "email": "tom@ac.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5512478089",
      "phone": "4153647890",
      "address": "123 Main Street, New York, NY 10001",
      "relationship": "Trust",
      "idType": "EIN",
      "idNo": "123456789",
      "formationCountry": "USA"
    }
  ]
}

Response

Creating an Account Beneficiary was Successful.

Example response

{
  "primary": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "dob": "1999-10-10",
      "email": "tom@ac.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5512478089",
      "phone": "4153647890",
      "created": "2022-12-29T18:32:15.533Z",
      "address": "123 Main Street, New York, NY 10001",
      "relationship": "Trust",
      "idType": "EIN",
      "idNo": "123456789",
      "citizenship": "USA",
      "formationCountry": "USA",
      "documentID": "1b798a36-5837-45e4-9000-5cd8d3e2dde7"
    }
  ],
  "contingent": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "dob": "1999-10-10",
      "email": "tom@ac.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5512478089",
      "phone": "4153647890",
      "created": "2022-12-29T18:32:15.533Z",
      "address": "123 Main Street, New York, NY 10001",
      "relationship": "Trust",
      "idType": "EIN",
      "idNo": "123456789",
      "citizenship": "USA",
      "formationCountry": "USA",
      "documentID": "1b798a36-5837-45e4-9000-5cd8d3e2dde7"
    }
  ]
}