To use the Nium APIs, you need to provide a combination of API key, supplied in the header as x-api-key and client ID, supplied in the API URI path as clientHashId. The sandbox and production environments have separate keys and client IDs.

You can sign up and get access to a sandbox environment quickly and easily by following the instructions in our Getting started guide. To get the API key for the production environment reach out to the Nium support team or your Nium account manager. The API key needs to be supplied in the header and the clientHashId is a path parameter.

Sample key: x-api-key: 0mZpIhaLVM1qd8IJhCfgjeJjsY7b5zde10j

Nium supports secure communication by adding the client's IP address to the allowlist. Clients can use a static IP or VPN IPs.