Official Verification-as-a-Service API

Developer Documentation & Registry APIs

Every verification request is authenticated via an organization-issued API key (av_...) or session token. Requests are idempotent and audit-logged under your organization.

Interactive Swagger UI

Base URL:http://localhost:4000

1. Authentication

Header: x-api-key

Pass your key in x-api-key: av_... or as a standard Bearer av_... token.

2. Org Scoping

Multi-Tenant Context

All records belong to the organization that created the API key. No user credentials are required on server calls.

3. Idempotent Replays

Cached Results

Duplicate inquiries return replay: true with cached registry data instead of querying upstream sources.

Available Endpoints

POST/api/verification/bank-accounts

Bank Account Holder Lookup

Performs real-time bank account holder lookup across Ethiopian commercial banks (e.g. CBE, Dashen, Awash, Abyssinia, Telebirr). Returns verified account name and institution status.

Registry Authority:StarPay / National Bank of Ethiopia

Request Sample

curl -X POST http://localhost:4000/api/verification/bank-accounts \
  -H "x-api-key: av_your_secret_api_key" \
  -H "Content-Type: application/json" \
  -d '{"institutionId":"cbe","bankAccount":"1000123456789"}'

Request Payload (JSON)

{
  "institutionId": "cbe",
  "bankAccount": "1000123456789"
}

Sample Official Response (200 OK)

application/json

{
  "verificationId": "cm8942b0x...",
  "replay": false,
  "status": "VERIFIED",
  "provider": "starpay",
  "source": "api.starpay.et",
  "accountName": "ABEBE BEKELE TADESSE",
  "accountNumber": "1000123456789",
  "institutionId": "cbe",
  "currency": "ETB",
  "durationMs": 142
}