API Keys

Create an API key

post/client/api-keys

Generate a new API key. The full raw key is returned once only — store it securely.

Authorization

Bearer token in the Authorization header.

Body required

namestringrequired

environmentstringrequired

Options: sandboxlive

Response

idstringrequired

namestringrequired

keystringrequired

Full raw API key — shown only once. Store it securely.

keyPrefixstringrequired

environmentstringrequired

Options: sandboxlive

createdAtstringrequired

warningstringrequired

curl -X POST 'https://api.lira.com/api/v1/client/api-keys' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "name": "My sandbox key", "environment": "sandbox" }'

const response = await fetch('https://api.lira.com/api/v1/client/api-keys', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "My sandbox key", "environment": "sandbox" }), }); const data = await response.json();

import requests response = requests.post( "https://api.lira.com/api/v1/client/api-keys", headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"}, json={ "name": "My sandbox key", "environment": "sandbox" }, ) data = response.json()

{ "id": "e1f2a3b4-c5d6-7890-efab-123456789012", "name": "My sandbox key", "key": "lira_sk_test_4eC39HqLyjWDarjtT1zdp7dcXXXXXXXXXXXXXXXX", "keyPrefix": "lira_sk_test_4eC39H", "environment": "sandbox", "createdAt": "2026-04-22T10:15:30.000Z", "warning": "Save this key securely. It will not be shown again." }

{ "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." } }