amalaCloud API Docs
  • Introduction
  • Authentication
  • Endpoints
    • Amala Verification
      • AmalaID Verification
    • BVN Verification
      • Advance BVN Verification
      • Basic BVN Verification
    • vNIN Verification
      • Advance vNIN Verification
      • Basic vNIN Verification
    • NIN Verification
      • Advance NIN Verification
      • Basic NIN Verification
    • Driver's License Verification
      • Advance Driver's License Verification
      • Basic Driver's License Verification
    • International Passport Verification
      • Advance International Passport Verification
      • Basic International Passport Verification
    • ID Verification History
    • Access Management
      • New Access Request
      • Request History
    • Address Management
      • Get Addresses
      • Verify Address
      • Return Address
Powered by GitBook
On this page

Authentication

Instructions on how to Authenticate API Requests

PreviousIntroductionNextAmala Verification

Last updated 1 month ago

The Amala API uses API keys to authenticate requests. You can view and manage your keys on the Amala Dashboard.

Your API key essentially gives you programmatic access to a lot of the features offered by Amala.cloud. Most of these features come at a premium and each request will incur a charge. Therefore, it is of utmost importance that you do not share your API key on publicly accessible platforms like GitHub or in client-side applications. If however you feel your API key has been compromised, you can rotate it by visiting the API section on your dashboard.

Signing Requests

Each request must be signed by a valid API key. The API key will be passed as a header parameter with key x-api-key appended to the API endpoint.

All API requests must be made over . Calls made over plain HTTP will fail. API requests without authentication will also fail.

HTTPS