Sign in (for programs)

POST

https://api.veloconnect.me/api/customer-users/partner-login

Account

Last modified:2026-10-07 14:16:07

Signs a program in and returns a login token. Every call in this reference that asks for a login token takes it in the header Authorization: Bearer <token>.

Send the account's e-mail or phone number, its password, and its API key as api_id. There is no captcha on this call.

If the account has a list of allowed IP addresses, the call must come from one of them.

An account with two-step sign-in switched on cannot sign in here: the answer has requiresTwoFactor: true and no token. Use an account without two-step sign-in for an integration.

Limit: 20 calls per 5 minutes per IP address.

The answer holds token (send it as the bearer token), refreshToken and tokenLifeTime. The token is short-lived: renew it with the refresh call before it ends.

Request

Authorization

Add parameter in header

api_id

Example:

api_id: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠412

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location 'https://api.veloconnect.me/api/customer-users/partner-login' \
--header 'api_id: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "integration@example.com",
  "password": "<your password>",
  "api_id": "<your API key>"
}'

Response Example

200 - Signed in

{
  "data": [
    {
      "requiresTwoFactor": false,
      "twoFactorMethod": null,
      "maskedDestination": null,
      "token": {
        "token": "<login token>",
        "refreshToken": "<refresh token>",
        "tokenLifeTime": "00:15:00"
      }
    }
  ]
}

Modified at 2026-10-07 14:16:07

Get your account profile

Refresh the login token