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.
• The Firm to which the Person is to be added must have the "Investor self-signup " feature enabled.
• The user is created as SSO, non-SSO, or UIM JWT as determined by how the firm is configured for creating new "Clients ".
Request Headers
Registering a new Person does not require prior authentication, so JSESSIONID or CSRF-TOKEN are not required.
A UIM Admin JWT can optionally be submitted to this endpoint using the Authorization header with the header value "Bearer ". 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.
The POST body parameters listed in Model below are to be submitted in in JSON format as shown in the Example Value.
Response Body
Location header: URI to new resource. For example:
{ "uri": "https://www.byallaccounts.net/api/v1/persons/12345s": }
Where 12345 is the BAA Person Id for the new Person.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Bad Request.
Possible causes:
• The field name field is missing
• Missing required value
• The field name cannot exceed max value
• Invalid Role value
• Email addresses must be in the form [email protected] and cannot contain spaces
• Firm firm not found
• Advisor not found
One of these is set on the Firm to be required but is not found:
• taxId
• firmTag1
• firmTag2
• firmTag3
Not Authorized.
Possible causes:
• Investor self-signup not allowed
• UIM JWT not valid
Conflict.
Possible causes:
• UIM Guid must be unique (from UIM JWT)
• firmTag1 must be unique
Internal Server Error