Join

General Information

Service	API	Method
urac	/join	POST

Data Models: Users, Tokens

Workflow: %Link to Architecture Page%

Input

Name	Source	Mandatory	Type	Special Format
username	Body	YES	String	alphanumeric with _ , - characters only
password	Body	YES	String	N/A
firstName	Body	YES	String	N/A
lastName	Body	YES	String	N/A
email	Body	YES	String	N/A

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
402	User account already exists.
403	Database 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": "819b0aed-edd8-47d5-ada0-9e5f93cb8248"
}