GET - /checkUsername

General Information


ServiceAPIMethodData ModelsWorkflow
urac/checkUsernameGETUsers

Description

This API checks if a username or email is available or taken (used). 

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameQueryYESStringN/AUsername


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: true
}

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

602Model error: + %model_error%