Register a new user
The brand URL of the request. This is used to identify the brand.
YOUR_BRAND_URLContains the data for the registration form.
The username that the user is registering with.
This can be an email address or a username with format: [a-zA-Z0-9._-]{5}+
The phone number that the user is registering with. The phone number is in the E.164 format.
The password that the user is registering with.
The email address that the user is registering with.
This is used to receive emails from the system.
The first name of the user.
The last name of the user.
The nickname of the user.
The invitation code that the user is using to register.
The timezone id.
The request was successful.
The user has exceeded the rate limit.
The password is not in the correct format.
The user email already exists in the system.
The username already exists in the system.
The phone number already exists in the system.
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": "+12345678900",
"password": "password",
"emailAddress": "[email protected]",
"firstName": "Steve",
"lastName": "Bang",
"nickName": "stevebang",
"referralCode": "REF2025XYZ",
"timeZoneId": "sApKpllz4sAplsmzha"
}{
"success": true,
"statusCode": 201,
"message": "The request was successful.",
"data": "2rlzM7wMrxdOkPsa",
"errors": []
}Last updated
Was this helpful?