Authentication

The Numeral API uses API keys to authenticate requests. API keys can be created in Numeral dashboard by specifying a name and a permission (read-only or write).

The API key must be passed in the X-API-Key HTTP header of your API calls. Do not share your API key in publicly accessible areas, such as GitHub, client-side code, and so forth.

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

IP whitelisting is mandatory to access the production environment. IP whitelisting is optional to access the sandbox environment.