Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

NameSourceMandatoryTypeSpecial FormatDescription
usernameBodyYESStringalphanumeric with _ , - characters only 
passwordBodyYESStringN/A 
firstNameBodyYESStringN/A 
lastNameBodyYESStringN/A 
emailBodyYESStringN/A 

...



Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": "..."
}

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[402],
        "details":[
            {
                "code":402,
                "message":"User account already exists."
            }
        ]
    }
}



Error Codes

 



Code
Description
402User account already exists.
403Database Error


Example (CURL)

...

Code Block
languagejs
titleJoin API response
{
	"result": true,
	"data": {
		"id":"",
		"token": "819b0aed-edd8-47d5-ada0-9e5f93cb8248"
	}
}