Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/joinPOST


Data Models: UsersTokens

Workflow: Join Flow

Input

...

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": "..."
}

...

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)

...

Request

Code Block
languagebash
titleCalling 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'

...