Login with password

Authenticate a user with the email and password that they provided when registering.

Given that the user credentials are correct, this returns a token that can then be used to authorise other secured operations.

The token returned is valid for 5 minutes from last activity.

---

End point

https://api.up2.money/auth/login

Headers

Security

REQUEST BODY SCHEMA: application/json

🔐 API SECRET: x-secret

Add YWJjMTIzIQ== in x-secret in headers.

Header parameter name: x-secret

---

Payload

{
    "email": "", // YOUR EMAIL
    "password": {
        "value": "" // YOUR TOKENIZED PASSWORD
    }
}

Sample Request

---

curl --location 'https://api.up2.money/auth/login' \
--header 'x-secret: YWJjMTIzIQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "YOUR_EMAIL", 
    "password": {
        "value": "YOUR_TOKENIZED_PASSWORD" 
    }
}'

---

Sample Response

---

Success - 200

{
    "credentials": {
        "id": "",
        "type": "ROOT"
    },
    "identity": {
        "id": "",
        "type": "CONSUMER" // OR "CORPORATE"
    },
    "token": "",
    "tokenType": "ACCESS"
}

Error - 400

Response Status

---

200 Success

400 Bad Request Error - Your request is invalid.

{
  "message": "string",
  "syntaxErrors": {
    "invalidFields": [
      {
        "params": [
          "string"
        ],
        "fieldName": "string",
        "error": "REQUIRED"
      }
    ]
  }
}

401 Unauthorized - Your credentials or access token are invalid.

403 Forbidden - The authentication credentials are not found or are incorrect.

404 Not found - The requested token couldn't be found.

410 Gone - The requested token is expired.

423 Locked - Account is temporarily locked due to failed consecutive login attempts. Try again in 30 minutes.

429 Too many requests.

500 Internal Server Error - There is a problem with the server. Please try again later.

503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.