POST - /join

General Information

Service	API	Method	Data Models	Workflow
urac	/join	POST	Users	N/A

Description

This API allows guest to join (create an account).

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
username	Body	YES	String	Alphanumeric Minimum Length: 5 maxLength: 50	Username
password	Body	YES	String	N/A	Password
email	Body	YES	String	Email format	Email
firstName	Body	YES	String	N/A	First Name
lastName	Body	YES	String	N/A	Last Name
profile	Body	NO	Object	N/A	additional information
membership	Body	No	String	from the membership object configuration (example: basic)	checkout point #2 @ 04 Configuration Steps and requirements
ln	Body	No	String		language "en", "fr"
phone	Body	No	String		Phone number

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data:
   {
	id: '%new_user_ID%', 
	token: %token%,
     link:
      { join:
         'http://dashboard.soajs.org/#/join?token=%token%'
      }
   }
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
524	Cannot join with a sub tenant key
602	Model error: + %model_error%