NBVS Ghana — API Documentation

🔑 Authentication

Each request must include your API key as a query parameter:
?key=YOUR_API_KEY

🔍 Verification Endpoint

GET request:

https://nbvsghana.vercel.app/api/verify?key=YOUR_KEY&nia=GHA-0000000
  

Parameters:

• key — your API key
• nia — National ID / Ghana Card number
• debug=1 — optional, returns extra debug info

📦 Example Response

{
  "name": "Ama Serwaa",
  "nia": "GHA-2039485",
  "dob": "1999-02-15",
  "criminal": "None",
  "status": "Valid"
}
  

🚨 Errors

{ "error": "Invalid API key" }

{ "error": "Verification not found" }

{ "error": "Rate limit exceeded" }
  

📈 Rate Limits

Each API key has two limits:

• limitPerMinute — default 10
• limitPerDay — default 200

👤 Managing API Keys

API keys can be created inside the NBVS Admin Panel → API Keys.

Need help? Email: nbvsghana@nbvsghana.com