Sign Up

This API endpoint allows creating a new user account by sending a POST request with the required user details. The response includes the newly created user object with a unique ID assigned by the system.

Query Parameters

client_auth_token string required

Client API token

application/json

Request Body

Sign up body

user object

name string deprecated

Full name of user, this is deprecated, please use first_name and last_name instead.

first_name string required

User's first name.

last_name string required

User's last name.

email string

User's email.

username string

Username

description string

user bio

default_lang string

ISO code of the language that the user prefers to read posts in

password string

Account password.

password_confirmation string

Account password confirmation.

avatar file

avatar file

Responses

• 200
• 403
• 422
• 500

---

Example response

Response Headers

• access-token string

  user access token

• client string

  client token

• expiry string

  timestamp of token expiry date

• uid string

  user uid

application/json

Schema

Example (from schema)

---

Schema

data object required

QuranReflect User model.

id integer

The Id of the user

email string

The email of the user

name string deprecated

Full name of user. It is deprecated, please use first_name and last_name instead.

username string

The username

verified boolean

true if user is a verified member

follow_notification boolean

comments_notification boolean

description string nullable

user bio

default_lang string

ISO code of the language that the user prefers to read posts in.

uid string

User uniqe identifier

provider string

User account provider.

onesignal_player_id string nullable

User's OneSignal subscription Id.

post_as boolean

Whether user is allowed to post as another user.

android_registration_id string nullable

The registration Id of the user's Android device.

sign_up_type string nullable

Possible values: [OLD USER, web, QR_IOS, QR_ANDROID, QuranMemorizer, QF_AUTH]

The signup type

emails_disabled boolean

Whether the user disabled receving emails or not.

first_name string

The user's first name.

last_name string nullable

The user's last name.

is_admin? boolean

Whether the user is an admin.

user_avatar_url string nullable

The user's avatar url.

rooms_list object[]

List of rooms the user is a member of.

Array [

id string

The Id of the room

]

user_type string nullable

Possible values: [0, 1]

The type of the user. 0 = student of knowledge.1 = scholar.

status string required

Default value: succes

message string required

Possible values: [Your profile has been updated successfully., Your account has been created successfully, Please check your email to verify it.]

success response message

{
  "data": {
    "id": 0,
    "email": "string",
    "username": "string",
    "verified": true,
    "follow_notification": true,
    "comments_notification": true,
    "description": "string",
    "default_lang": "string",
    "uid": "string",
    "provider": "string",
    "onesignal_player_id": "string",
    "post_as": true,
    "android_registration_id": "string",
    "sign_up_type": "OLD USER",
    "emails_disabled": true,
    "first_name": "string",
    "last_name": "string",
    "is_admin?": true,
    "user_avatar_url": "string",
    "rooms_list": [
      {
        "id": "string"
      }
    ],
    "user_type": "0"
  },
  "status": "succes",
  "message": "Your profile has been updated successfully."
}

Forbidden, api key is missing or invalid

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

{
  "success": false,
  "message": "You don't have permission!"
}

Unprocessable entity, api will respond with this status if any required params is missing or has invalid value.

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean

Default value: false

errors string[]

list of errors

status string

Default value: error

422, unprocessable entity

{
  "success": false,
  "errors": [
    "string"
  ],
  "status": "error"
}

{
  "success": false,
  "errors": [
    "string"
  ],
  "status": "error"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...