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.

passwordstring · min: 1Required

The password that the user is registering with.

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.

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 · nullableOptional

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

emailAddressstring · nullableOptional

The email address that the user is registering with.
This is required and validated using a custom EmailAddress attribute.
Expected to be a valid RFC-compliant email address.

Responses

201

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

400

The password is not in the correct format.

application/json

409

The phone number already exists in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/register

HTTPcURLJavaScriptPython

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

{
  "username": "username",
  "phoneNumber": "[phone]",
  "emailAddress": "[e-mail]",
  "password": "password",
  "firstName": "Steve",
  "lastName": "Bang",
  "nickName": "stevebang",
  "referralCode": "REF2025XYZ"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "brandId": "xZrwkBM58VN",
    "parentUser": {
      "id": "sApKpllz4sAplsmzha",
      "code": "PZBAAE",
      "avatar": "https://www.jframework.io/admin.jpg",
      "packageId": "yDpX0wAbpGRqjv3l",
      "packageCode": "STANDARD",
      "emailAddress": "[e-mail]",
      "phoneNumber": null,
      "nickName": "Admin",
      "roles": [
        "Admin"
      ]
    },
    "code": "AABA24461C0E194BEF3E",
    "username": "john.doe",
    "firstName": "John",
    "lastName": "Doe",
    "nickName": null,
    "avatar": "https://www.johndoe.com/avatar.jpg",
    "emailAddress": "[e-mail]",
    "phoneNumber": "+01234567890",
    "website": "https://www.johndoe.com",
    "bio": null,
    "type": "EndUser",
    "isEmailAddressVerified": false,
    "isUserVerified": false,
    "riskMark": 50,
    "roles": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "xZrwkBM58VN",
        "guid": "a8b36be9-6e3f-498b-8710-6ae8b97d06b6",
        "code": "SUPER_ADMIN",
        "name": "Super Admin",
        "description": "Super Admin",
        "tags": "#Admin",
        "type": "BuiltIn",
        "permissions": [
          "USER.CREATE"
        ]
      }
    ],
    "referralCode": "AABAAE",
    "testMode": false,
    "tags": null,
    "status": "Active",
    "isSystem": false,
    "package": {
      "id": "sApKpllz4sAplsmzha",
      "code": "CODE",
      "name": "NAME",
      "imageURL": "IMAGE",
      "patternAvatarURL": "https://www.example.com/pattern.jpg",
      "styles": "{\"color\": \"red\"}",
      "description": "DESCRIPTION",
      "tags": "TAGS",
      "isFree": true,
      "tier": 0,
      "zOrder": 1,
      "features": [
        {
          "type": "Function",
          "title": "Feature Title",
          "value": 10,
          "isUnlimited": false,
          "resetPolicy": 0,
          "customIntervalDays": null,
          "id": "sApKpllz4sAplsmzha",
          "parentBrandId": "Brand_ID",
          "eventId": "Event_ID",
          "code": "Code",
          "name": "Feature Name",
          "unit": "Unit",
          "defaultValue": null,
          "helpURL": null,
          "image": "https://www.example.com/image.jpg",
          "styles": "{\"color\": \"red\"}",
          "description": "Feature Description",
          "tags": "#Tag1, #Tag2",
          "zOrder": 1,
          "status": "Active"
        }
      ],
      "prices": [
        {
          "id": "sApKpllz4sAplsmzha",
          "code": "Code",
          "name": "Name",
          "amount": 10,
          "currency": "USD",
          "description": "Description",
          "checkoutLink": "CheckoutLink",
          "tags": "Tags",
          "packageName": "PackageName",
          "packageId": "PackageId",
          "subscriptionName": "SubscriptionName",
          "subscriptionTypeId": "SubscriptionTypeId",
          "zOrder": 1
        }
      ],
      "isDefault": true,
      "status": "Inactive"
    },
    "packageId": "yDpX0wAbpGRqjv3l",
    "languageCode": "en-US",
    "countryCode": "US",
    "timeZoneId": "QlzwLjGaKvAvbD5x",
    "expiryDate": "2026-02-25T01:03:23.910835Z",
    "themeStyle": "light",
    "enableSignInDetection": true,
    "isUserIntegration": false,
    "createdDate": "2026-01-26T01:03:23.910836Z"
  },
  "errors": []
}