POST /api/v1/addons/transact/account-opening
Personal access token & O auth2
application/json

Body

  • adviser_id string Required

    The Transact adviser ID to open the account under.

  • investors array[object] Required

    A list of investors to open accounts for.

    Hide investors attributes Show investors attributes object
    • title string

      Investor title

      Value Description
      mr Mr
      mrs Mrs
      ms Ms
      miss Miss
      admiral Admiral
      air_commodore Air Commodore
      air_vice_marshall Air Vice Marshall
      archdeacon Archdeacon
      baron Baron
      baroness Baroness
      bishop Bishop
      brigadier Brigadier
      canon Canon
      captain Captain
      colonel Colonel
      commander Commander
      commodore Commodore
      corporal Corporal
      count Count
      countess Countess
      dame Dame
      deacon Deacon
      deaconess Deaconess
      dr Dr
      duchess Duchess
      father Father
      flight_lieutenant Flight Lieutenant
      group_captain Group Captain
      judge Judge
      lady Lady
      lance_corporal Lance Corporal
      lieutenant Lieutenant
      lieutenant_colonel Lieutenant Colonel
      lieutenant_commander Lieutenant Commander
      lord Lord
      madam Madam
      major Major
      major_general Major General
      master Master
      monsignor Monsignor
      mx Mx
      other Other
      pastor Pastor
      prince Prince
      princess Princess
      private Private
      professor Professor
      rabbi Rabbi
      rear_admiral Rear Admiral
      reverend Reverend
      reverend_doctor Reverend Doctor
      right_honourable Right Honourable
      right_honourable_lord Right Honourable Lord
      right_reverend Right Reverend
      second_lieutenant Second Lieutenant
      sergeant Sergeant
      sheriff Sheriff
      sir Sir
      sister Sister
      squadron_leader Squadron Leader
      staff_sergeant Staff Sergeant
      surgeon_captain Surgeon Captain
      the_earl_of The Earl of
      the_honourable The Honourable
      the_reverend_canon The Reverend Canon
      trooper Trooper
      unspecified Unspecified
      venerable Venerable
      very_reverend Very Reverend
      viscount Viscount
      viscountess Viscountess
      wing_commander Wing Commander

      Values are mr, mrs, ms, miss, admiral, air_commodore, air_vice_marshall, archdeacon, baron, baroness, bishop, brigadier, canon, captain, colonel, commander, commodore, corporal, count, countess, dame, deacon, deaconess, dr, duchess, father, flight_lieutenant, group_captain, judge, lady, lance_corporal, lieutenant, lieutenant_colonel, lieutenant_commander, lord, madam, major, major_general, master, monsignor, mx, other, pastor, prince, princess, private, professor, rabbi, rear_admiral, reverend, reverend_doctor, right_honourable, right_honourable_lord, right_reverend, second_lieutenant, sergeant, sheriff, sir, sister, squadron_leader, staff_sergeant, surgeon_captain, the_earl_of, the_honourable, the_reverend_canon, trooper, unspecified, venerable, very_reverend, viscount, viscountess, or wing_commander.

    • surname string

      Investor surname

    • given_names string

      Investor given names

    • date_of_birth string(date)

      Investor date of birth - YYYY-MM-DD

    • gender string

      Investor gender

      Value Description
      male male
      female female
      non-binary non-binary
      transgender transgender
      intersex intersex
      other other
      unknown unknown

      Values are male, female, non-binary, transgender, intersex, other, or unknown.

    • email_address string

      Investor email address

    • nino string

      Investor National Insurance number

    • nationalities array

      Investor nationalities, ISO 3166-1 alpha-2 codes

    • tax_residencies array[object]

      The array of tax residencies

      Hide tax_residencies attributes Show tax_residencies attributes object
      • country string

        Tax residency country code

      • tax_id string

        Tax residency tax ID

    • investor_category string

      Investor category

      Values are RETAIL or PROFESSIONAL.

    • mobile_number object

      Investor mobile number

      Hide mobile_number attributes Show mobile_number attributes object
      • country string

        Mobile number country, ISO 3166-1 alpha-2

      • number string

        Mobile number

    • residential_address object

      Investor residential address

      Hide residential_address attributes Show residential_address attributes object
      • line1 string

        Residential address line 1

      • line2 string

        Residential address line 2

      • post_code string

        Residential address postcode

      • country string

        Residential address country, ISO 3166-1 alpha-2

    • postal_address object

      Investor postal address

      Hide postal_address attributes Show postal_address attributes object
      • line1 string

        Investor postal address line 1

      • line2 string

        Investor postal address line 2

      • post_code string

        Investor postal address postcode

      • country string

        Investor postal address country, ISO 3166-1 alpha-2

  • bank_account object Required

    Bank account details

    Hide bank_account attributes Show bank_account attributes object
    • sort_code string Required

      Bank account sort code - 6 digits, no hyphens or spaces.

    • account_number string Required

      Bank account number - max 8 characters.

    • account_name_or_roll_number string Required

      Bank account name or roll number - max 32 characters.

    • is_building_society boolean

      Is this a building society account?

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/addons/transact/account-opening 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/addons/transact/account-opening' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"adviser_id":"123456789","investors":[{"title":"mr","surname":"Miggins","given_names":"Ian","date_of_birth":"1981-04-20","gender":"male","email_address":"text@example.com","nino":"123456789","nationalities":["GB"],"tax_residencies":[],"investor_category":"RETAIL","mobile_number":{"country":"GB","number":"07700900000"},"residential_address":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"},"postal_address":{"line1":"1 Washington Street","line2":"Worcester","post_code":"WR1 1NL","country":"GB"}}],"bank_account":{"sort_code":"123456","account_number":"12345678","account_name_or_roll_number":"Ian Miggins","is_building_society":true}}'
Request examples 
{
  "adviser_id": "123456789",
  "investors": [
    {
      "title": "mr",
      "surname": "Miggins",
      "given_names": "Ian",
      "date_of_birth": "1981-04-20",
      "gender": "male",
      "email_address": "text@example.com",
      "nino": "123456789",
      "nationalities": [
        "GB"
      ],
      "tax_residencies": [],
      "investor_category": "RETAIL",
      "mobile_number": {
        "country": "GB",
        "number": "07700900000"
      },
      "residential_address": {
        "line1": "1 Washington Street",
        "line2": "Worcester",
        "post_code": "WR1 1NL",
        "country": "GB"
      },
      "postal_address": {
        "line1": "1 Washington Street",
        "line2": "Worcester",
        "post_code": "WR1 1NL",
        "country": "GB"
      }
    }
  ],
  "bank_account": {
    "sort_code": "123456",
    "account_number": "12345678",
    "account_name_or_roll_number": "Ian Miggins",
    "is_building_society": true
  }
}
Response examples (401) 
{
  "message": "Unauthenticated."
}