Onboard consumer user

Creates a complete consumer onboarding profile in a single request.

The API sequentially creates the consumer legal entity, maps the allowed applications, creates the customer account, and creates the consumer user.

The request succeeds only when all four onboarding steps complete successfully.

SecurityoAuth2
Request
Request Body schema: application/json
required

Consumer onboarding request fields

loginId
required
string^[-@._a-zA-Z0-9]*$

Unique login identifier for the consumer user.

firstName
required
string^[a-zA-Z](?:[a-zA-Z\s]{0,29}[a-zA-Z])?$

First name of the consumer user.

lastName
required
string^[a-zA-Z](?:[a-zA-Z\s]{0,29}[a-zA-Z])?$

Last name of the consumer user.

email
required
string <email>

Email address for the consumer user.

phoneNumber
required
string^\+[1-9]\d{0,2}[- ()]*\d[- ()\d]*$

Consumer phone number including country code. Spaces, hyphens, and parentheses are allowed.

required
object (ConsumerOnboardingAddress)
required
object (ConsumerOnboardingAccount)
Responses
201

Consumer onboarding completed successfully

400

Bad request or onboarding validation failure

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error during consumer onboarding

503

Service unavailable

post/api/user-management/v1/consumers/users
Request samples
application/json
{
  • "loginId": "user123",
  • "firstName": "John",
  • "lastName": "Cane",
  • "email": "user123@gmail.com",
  • "phoneNumber": "+1 202-555-0176",
  • "Address": {
    },
  • "account": {
    }
}
Response samples
application/json
{
  • "userId": "f353ca91-4fc5-49f2-9b9e-304f83d11914"
}