Register a new user

Registers a new user with the given information.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

Contains the data for the registration form.

usernamestring | nullableOptional

The username that the user is registering with.

This can be an email address or a username with format: [a-zA-Z0-9._-]{5}+

phoneNumberstring · tel | nullableOptional

The phone number that the user is registering with. The phone number is in the E.164 format.

passwordstring · min: 1Required

The password that the user is registering with.

emailAddressstring · min: 1Required

The email address that the user is registering with.

This is used to receive emails from the system.

firstNamestring | nullableOptional

The first name of the user.

lastNamestring | nullableOptional

The last name of the user.

nickNamestring | nullableOptional

The nickname of the user.

referralCodestring | nullableOptional

The invitation code that the user is using to register.

timeZoneIdstring | nullableOptional

The timezone id.

Responses

201

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

607

The password is not in the correct format.

application/json

723

The user email already exists in the system.

application/json

724

The username already exists in the system.

application/json

727

The phone number already exists in the system.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/register HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "username": "username",
  "phoneNumber": "[phone]",
  "password": "password",
  "emailAddress": "[email protected]",
  "firstName": "Steve",
  "lastName": "Bang",
  "nickName": "stevebang",
  "referralCode": "REF2025XYZ",
  "timeZoneId": "sApKpllz4sAplsmzha"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": "2rlzM7wMrxdOkPsa",
  "errors": []
}