Getting Started

1. Create an account and organizationCopy Anchor Link

Register at your AdeyVerify dashboard (/register). Registering also creates your first organization — API keys, subscriptions, and verification history all belong to an organization, not an individual user.

2. Generate an API keyCopy Anchor Link

From the dashboard, go to API Keys → New API key. Choose an environment (TEST or LIVE — both behave identically; the distinction is for your own tracking) and, optionally, restrict it to specific services.

The full secret (av_test_... or av_live_...) is shown once, at creation. AdeyVerify stores only a hash of it — if you lose it, rotate the key from the dashboard to get a new one.

3. Make your first requestCopy Anchor Link

Every request under /api/v1 needs an Authorization: Bearer <api-key> header.

curl -X POST http://localhost:4000/api/v1/verify/banks \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer av_test_YOUR_API_KEY" \
  -d '{"bank": "Commercial Bank of Ethiopia"}'

{
  "verificationId": "cmun...",
  "replay": false,
  "status": "VERIFIED",
  "source": "INTERNAL_DIRECTORY",
  "bank": {
    "name": "Commercial Bank of Ethiopia",
    "institutionId": "231402",
    "isSupported": true
  },
  "errors": []
}

Every request is recorded and shows up in Verification History in the dashboard, and every verification response includes a verificationId you can fetch again later via the matching GET endpoint.

Next stepsCopy Anchor Link