Beneficiaries

Create Account Beneficiaries

Creates an Account Beneficiary by accountID.

post/accounts/{accountID}/beneficiaries

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/accounts/{accountID}/beneficiaries
Auth
HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Request body

Example request

{
  "primary": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "percentage": 0.25,
      "email": "tom@example.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5555550100",
      "phone": "5555550100",
      "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@example.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5555550100",
      "phone": "5555550100",
      "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@example.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5555550100",
      "phone": "5555550100",
      "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": "123e4567-e89b-12d3-a456-000000000056"
    }
  ],
  "contingent": [
    {
      "type": "ENTITY",
      "name": "Tom Ace",
      "dob": "1999-10-10",
      "email": "tom@example.com",
      "formationDate": "2010-10-25",
      "primaryContact": "5555550100",
      "phone": "5555550100",
      "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": "123e4567-e89b-12d3-a456-000000000056"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.