Sign in

v1

latestOpenAPI 3.0.12026-07-244842.1 KB
Persons

Register a new user

Add an Investor Person to the system and associate it to a Firm and optionally to an Advisor. Registering a new Person does not require prior authentication. </br> <span>•</span> The Firm to which the Person is to be added must have the "Investor self-signup " feature enabled. </br> <span>•</span> The user is created as SSO, non-SSO, or UIM JWT as determined by how the firm is configured for creating new "Clients ". </br></br>Request Headers</br>Registering a new Person does not require prior authentication, so JSESSIONID or CSRF-TOKEN are not required. </br></br>A UIM Admin JWT can optionally be submitted to this endpoint using the Authorization header with the header value "Bearer <token-value>". The UIM Admin JWT holds a Service Administrator level authentication context and the UIM Guid for the user to be created must be provided in the post body. The endpoint will validate the JWT, extract the UIM Guid, and store the UIM Guid on the Person. The UIM Guid must be unique across the ByAllAccounts system (across all Persons). If not, then the Person is not created and HTTP 409 Conflict is returned with the person URI.</br></br>The POST body parameters listed in Model below are to be submitted in in JSON format as shown in the Example Value. </br></br>Response Body</br>Location header: URI to new resource. For example: </br> { "uri": "https://www.byallaccounts.net/api/v1/persons/12345s": }</br>Where 12345 is the BAA Person Id for the new Person.

post/persons

Request body

firstNamestring required

First name of the Person

middleNamestring

Middle name of the Person

lastNamestring required

Last name of the Person

rolestring required

Role of the Person. Currently must be the value ""

emailAddressstring required

Email address of the Person. Must be in the form of xx@yy.zzz

phoneNumberstring

Phone number of the Person. There are no format requirements

taxIdstring

Social Security Number or Tax ID of the Person. Is only required if the Firm configuration requires a value for this field

firmTag1string

Firm tag 1. If specified, the value must be unique within the Firm to which the new Person is to be added. If not, HTTP 409 Conflict is returned. Is only required if the Firm configuration requires a value for this field

firmTag2string

Firm tag 2. Is only required if the Firm configuration requires a value for this field

firmTag3string

Firm tag 3. Is only required if the Firm configuration requires a value for this field

firmCodestring

Vendor name value for the Firm to which this Investor should be added. The Firm must already exist. At least one of firmCode or advisorId must be specified in order identify to which firm to add the Person. If firmCode is specified and advisorId is not, then the Person is created without any association to an advisor. If both are specified, then they must not conflict, meaning the Advisor identified by advisorId must exist within the Firm identified by the firmCode. Otherwise, an HTTP 400 Bad Request is returned

advisorIdinteger

ByAllAccounts Person Id for the Advisor to whom this Investor should be assigned after the Investor is created. The Advisor must already exist and be part of the Firm identified in firmCode (if firmCode is specified). At least one of firmCode or advisorId must be specified in order identify to which firm to add the Person. If firmCode is specified and advisorId is not, then the Person is created without any association to an advisor. If both are specified, then they must not conflict, meaning the Advisor identified by advisorId must exist within the Firm identified by the firmCode. Otherwise, an HTTP 400 Bad Request is returned.

uimGuidstring

Used in conjunction with Service Admin JWT. The uimGuid for the user to be created. Must be unique across all Persons in the ByAllAccounts system. If not, HTTP 409 Conflict is returned with the person URI. Ignored if a valid Service Admin JWT is not provided. Required when a Service Admin JWT is submitted to the endpoint.

Example request

{
  "firstName": "Rosalind",
  "middleName": "Elsie",
  "lastName": "Franklin",
  "role": "investor",
  "emailAddress": "RosalindFranklin@email.com",
  "phoneNumber": "508551212",
  "taxId": "101896403",
  "firmTag1": "BAA-primary-user-identifier",
  "firmTag2": "BAA-primary-user-identifier-Marketing",
  "firmTag3": "BAA-primary-user-identifier-Sales",
  "firmCode": "AccountViewGeneral",
  "advisorId": 778899,
  "uimGuid": "C5E883D3-8B92-438C-A43B-E70455FA1F06"
}

Response

OK

dataobject
All 4 operations