User Verify

Request

Fields

Note

The field “language” is optional.

username
The username of the user (string).
password
The plain password or token of the user (string).
is-token

Defines whether the supplied password is actually a token (boolean).

If is-token is true, the password is interpreted as a token of the user. Otherwise, the password is interpreted as the plain password of the user.

language

The locale of the user (string).

Expected is a lowercase, two-character string in accordance with ISO 639-1:2002.

Response

Fields

token

A token to authenticate the user in future requests (string).

Keep this token. When you make future requests where the user needs to be authenticated, you supply this token with the request.

HTTP Status codes

200 OK
The request was processed successfully.

Result codes

0
Success
140
Authentication failed: No positive authentication response
141
Authentication failed: Invalid email or password
144
Authentication failed: Email does not exist
145
Authentication failed: User token not valid

Examples

Request:

{
    "user-verify": {
        "username": "your-user",
        "password": "mypassword",
        "is-token": false,
        "language": "en"
    }
}

Response:

{
    "user": {
        "token": "e2af72d7a9084431ab0b1a5c42df7745"
    },
    "result": {
        "code": 0,
        "message": "Success."
    }
}