Authentication

To authencticate Nium APIs, you need to provide a combination of API key and client ID.

Field	Location	Description	Example
API Key	Header	Sent as the x-api-key header — provide your environment-specific API key.	x-api-key: 0mZpIhaLVM1qd8IJhCfgjeJjsY7b5zde10j
Client ID (clientHashId)	URI	Sent as the clientHashId path parameter in the API URI.	GET /v1/client/{clientHashId}/...

Where to get API Keys

You can sign up for a sandbox environment via the Getting started guide. To obtain a production API key, contact the Nium support team or your Nium account manager.

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

mutual TLS (mTLS)

Nium also supports mutual TLS (mTLS) for certificate-based authentication. Please contact Nium Support or your Nium account manager for setup instructions and further details.

note

The sandbox and production environments have separate keys and client ID's.