Join

General Information


ServiceAPIMethod
urac/joinPOST


Data Models: UsersTokens

Workflow: Join Flow

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameBodyYESStringalphanumeric with _ , - characters only
passwordBodyYESStringN/A
firstNameBodyYESStringN/A
lastNameBodyYESStringN/A
emailBodyYESString

Email Address Format (JSON Schema Validation)



Output


Valid Response

Valid Response Sample
{
	"result": true,
	"data": {}
}


Invalid Response

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



Error Codes



Code
Description
402User account already exists.
400Database connection error


Example (CURL)


Request

Calling Join API
 > CURL -X POST http://127.0.0.1:4000/urac/join -d 'username=john&password=johnpassword&firstName=John&lastName=Doe&email=johndoe@domain.com'

Response

Join API response
{
	"result": true,
	"data": {
		"id": "57c6eb28962f94a7caab8a23",
		"token": "819b0aed-edd8-47d5-ada0-9e5f93cb8248"
	}
}