Skip to main content
All API requests must be authenticated using your API key, sent via the X-Numero-Api-Key header.

Getting your API keys

Your approved business receives an API Key and a signing secret labelled Public Key. Keep both credentials on your server. Use the API Key for authentication and the Public Key for request signing.

Live and test keys

You get two secret keys, and the key you send decides the mode — there is no separate sandbox host or sandbox base URL: Develop against your test_key_, then swap in your live_key_ — the base URL and every endpoint stay the same. See Test mode.
Keep your keys safe. API keys carry many privileges. Do not share them in public repositories, client-side code, or any publicly accessible location. Rotate credentials immediately if they are exposed.

Making authenticated requests

Include your API key in every request using the X-Numero-Api-Key header:

Request signing

Most POST endpoints require a request signature in addition to your API key. The signature is sent via the X-Numero-Signature header. This provides an extra layer of security by ensuring the request body hasn’t been tampered with in transit. See Request Signing for full details on how to generate signatures.

Summary

IP Whitelisting (Optional)

For additional security, your business can restrict API access to specific IP addresses. When enabled, requests from non-whitelisted IPs will be rejected. Both IPv4, IPv6, and CIDR notation (e.g., 192.168.1.0/24) are supported.