API Keys

Revoke an API key

delete/client/api-keys/{keyId}

Permanently revoke an API key. Any requests using this key will be rejected immediately.

Authorization

Bearer token in the Authorization header.

Path parameters

keyIdstringrequired

Request

curl -X DELETE 'https://api.lira.com/api/v1/client/api-keys/{keyId}' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const response = await fetch('https://api.lira.com/api/v1/client/api-keys/{keyId}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  },
});

const data = await response.json();

import requests

response = requests.delete(
    "https://api.lira.com/api/v1/client/api-keys/{keyId}",
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)

data = response.json()

Response

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