Authentication

Refresh token

post/auth/refresh

Exchange a refresh token for a new access token.

Body required

refreshTokenstringrequired

Refresh token previously issued by /auth/login or /auth/refresh

Response

accessTokenstringrequired

Short-lived JWT — include as `Authorization: Bearer <token>`

refreshTokenstringrequired

Long-lived token — exchange via /auth/refresh for a new access token

expiresInintegerrequired

Access token lifetime in seconds

tokenTypestringrequired

Request

curl -X POST 'https://api.lira.com/api/v1/auth/refresh' \
  -H 'Content-Type: application/json' \
  -d '{
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTc2MTEyMzQ1Nn0.refresh-token-signature"
}'

const response = await fetch('https://api.lira.com/api/v1/auth/refresh', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTc2MTEyMzQ1Nn0.refresh-token-signature"
  }),
});

const data = await response.json();

import requests

response = requests.post(
    "https://api.lira.com/api/v1/auth/refresh",
    headers={},
    json={
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTc2MTEyMzQ1Nn0.refresh-token-signature"
},
)

data = response.json()

Response

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTc2MTEyMzQ1Nn0.access-token-signature",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTc2MTEyMzQ1Nn0.refresh-token-signature",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

{
  "message": "NG Account Number verification is not enabled for your organisation.",
  "code": "SERVICE_NOT_ENABLED",
  "action": {
    "type": "CONTACT_ADMIN",
    "hint": "Ask your administrator to enable NG Account Number verification in the Lira dashboard."
  }
}