Getting Started

This page provides the necessary steps to use the Nium One platform APIs with proper authentication.

1. Find an API that interests you and sign in

Select the Log in button in the upper-right corner.

2. Sign in

If you have a Nium account, Sign in with your credentials and skip to step #4. Otherwise, select Sign up to create your account and start using the platform APIs.

3. Sign up

Provide your information and select Sign up.

3a. Check your email and verify your account

Find the verification email from Nium Developer — sent to the email address you provided during Sign up — and select Verify Email. If you don't see the email, check your Spam folder.

3b. Sign in to your new account

After your email is verified successfully you're redirected to Sign in. Enter your email address and password and sign in to your account.

4. Try out an API

Once you're authenticated, your x-api-key is populated in the header and ClientHashID is populated in the path param.

Select Try It! to run your API call.

  • Some APIs, not all, require an additional Universal Unique Identifier (UUID) to help you track API calls.
  • If your API requires this field, enter a string that means something to you, such as the date or time of your API call, into the Headers x-request-id field.