Create a new authorized user

Add an authorized user to a business customer. Authorized users act as legal entities for the business and can be granted portal access with configurable roles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the parent entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

The identifier value corresponding to the selected identifier type.

Body Params

Authorized user details including personal information, contact details, and role assignment.

string
required

Mobile number of authorized user.

string
required

First name of authorized user.

string
required

Last name of authorized user.

string

Reference id assigned by the program manager.

string

Middle name of authorized user.

string

Social security number of authorized user.

mailingAddress
array of objects

The individual’s mailing address. Individual can have one or multiple mailing addresses.

mailingAddress
boolean

Authorized user is a US citizen or not.

string

Email of authorized user.

role
array of strings

If Portal Access is TRUE then role id should be provided.

role
taxIdentification
object

Individual's Taxpayer Identification. Can be provided for users without SSN.

Headers
string
enum
required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses

201

The entity has been created successfully.

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json