Webhooks

Create a webhook

post/client/webhooks

Authorization

Bearer token in the Authorization header.

Body required

urlstringrequired

HTTPS endpoint URL. Must be publicly reachable. Private IPs and localhost are not allowed.

eventsstring[]required

secretstring

Optional signing secret (min 16 chars). Auto-generated if omitted. Not returned after creation.

Response

idstringrequired

organizationIdstringrequired

urlstringrequired

eventsstring[]required

statusstringrequired

Options: activeinactivefailed

createdAtstringrequired

updatedAtstringrequired

curl -X POST 'https://api.lira.com/api/v1/client/webhooks' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "url": "https://yourapp.com/webhooks/lira", "events": [ "verification.completed", "verification.failed" ], "secret": "whsec_8fK2pL9qX3vN1mB7zC4yE6rT0aJ" }'

const response = await fetch('https://api.lira.com/api/v1/client/webhooks', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ "url": "https://yourapp.com/webhooks/lira", "events": [ "verification.completed", "verification.failed" ], "secret": "whsec_8fK2pL9qX3vN1mB7zC4yE6rT0aJ" }), }); const data = await response.json();

import requests response = requests.post( "https://api.lira.com/api/v1/client/webhooks", headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"}, json={ "url": "https://yourapp.com/webhooks/lira", "events": [ "verification.completed", "verification.failed" ], "secret": "whsec_8fK2pL9qX3vN1mB7zC4yE6rT0aJ" }, ) data = response.json()

{ "id": "b8c9d0e1-f2a3-4567-bcde-890123456789", "organizationId": "d4e5f6a7-b8c9-0123-defa-456789012345", "url": "https://yourapp.com/webhooks/lira", "events": [ "verification.completed", "verification.failed" ], "status": "active", "createdAt": "2026-04-22T10:15:30.000Z", "updatedAt": "2026-04-22T10:15:30.000Z" }

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