Skip to main content

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

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

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


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

Loading...