Skip to main content
POST
Create a new user

Authorizations

x-api-key
string
header
required

Body

application/json
country
enum<string>
required

Country

Available options:
MX,
PE,
CO,
US
Example:

"MX"

email
string<email>
required

User's email address.

Example:

"john.doe@example.com"

phoneNumber
string
required

User's phone number.

Example:

"+526589562354"

userType
enum<string>
required

Type of user.

Available options:
business,
individual
Example:

"individual"

address
object
required
businessName
string

Business name (required for business users).

Example:

"My Business Inc."

firstName
string

First name (required for individual users only).

Example:

"John"

middleName
string

Middle name (for individual users only).

Example:

"Michael"

lastName
string

Last name (required for individual users).

Example:

"Doe"

secondLastName
string

Second last name (for individual users only).

Example:

"Smith"

additionalInformation
object

Additional information about the user (optional).

brokerId
string<mongoId>

ID of the broker (optional).

Example:

"655f4084b96e4fb76f5a0e6e"

Response

OK

userId
string

ID of the created user.

Example:

"66562bc04fe8bf83c577c178"