Getting started



For a list of terms and an overview of key concepts, see Key Concepts.

Quickstart (Your First API Call)

To experience the platform and make an API call, follow the below steps:

1. Go to Nium's Developer Portal.

Navigate to

2. Get API Keys

Click the Get API Keys button in the upper-right corner.


3. Sign Up

Click the Sign up link at the bottom.


Enter your email address and click the Continue button.

4. Enter Your Information

Fill in all the fields to create an account.


Click the Terms and Conditions checkbox.

After the Sign up button becomes enabled, click it to continue. Then you will see if sign up was successful.


5. Check Your Email

A verification email was sent to the email address you entered earlier. If you don't see an email from Nium Developer, then check your Spam folder.

Open Nium's email and click the Verify button inside. That opens a browser tab stating you've been verified.


Click Close to open the Sign In page where you can enter your credentials and then click the Sign in button.

6. Generate API Key

The API Manager page displays your unique Client Hash ID which will be used on the API page later.


To get your IP address, google what is my ip.


Copy your IP to the Clipboard and paste it into the IP Addresses field.



If you want to add more IP addresses, click the Add IP Address link.

The Validity Period defaults to Forever, but you can change how long you want your API credentials to be valid by selecting other options from this dropdown.

Click the Generate API Key button to see your unique key in a pop-up dialog.




This dialog appears only once, so copy your unique API Key and paste it somewhere secure and easy to access.

7. Select an API

On Nium's API Reference, click the JUMP TO search box in the upper-left corner and start typing to see a list of APIs to select from. For example, type Client Details.


8. Paste API Key

Your unique API Key should still be on your Clipboard. If not, find where you saved it and copy it to the Clipboard.

In the Authentication Header field, paste your API Key.

9. Paste the Client Hash ID

From your previous browser tab, copy the Client Hash ID to the Clipboard.


Then paste your Hash ID in the Path Params clientHashId field.

10. x-request-id (certain APIs)

Some APIs (not all) require an additional unique UUID value to help you track API calls.

If your API requires this field, enter a string that has meaning to you, such as the date or time of your API call, into the Headers x-request-id field.

11. Try It

Click the Try It button to run your API call. Then you will see a Request and Response similar to the following: