Subscribing to Sandbox Tier


Pre-Requisites

  • Before you subscribe to APIs, please make sure that you've the account username and password ready with you.

  • Navigate to https://apim.idmerit.com/devportal to explore our list of APIs.


Step 01: Navigating to Global Verification APIs

  1. Navigate to "Sign-In" button on the top right corner, and use your registered account username and password, and click on "Sign-In". Please note that our Developer Portal does not support login via email.

  2. One logged-in, browse through our list of 175+ countries and their sources, or you can search for specific APIs through the search-console.

  3. Click on the API you're interested in subscribing to.

Step 02: Subscribing to the API

  1. Once you have selected the API, navigate to subscription section with subscribe button above text saying "No Application subscriptions".

  2. In case you've subscribed to the API, the text would display "1 application subscribed".

  3. On clicking the "Subscribe" button, it will take you to the Subscriptions tab. The application name "IDMverify" is a constant, however, the throttling policy is to be selected according to your needs. I order to set or subscribe to Sandbox Tier, please select Throttling Policy as "Sandbox". The Sandbox Tier is Free for Testing & Integration Purposes.

  1. After clicking on subscribe, the a pop-up message will be displayed on the top-right corner of the screen, saying "Subscribed Successfully". Also, the application status of the API would change to “UNBLOCKED”.

Step 03: Generating API Keys

  1. After successfully subscribing, users can generate access token via API or through Portal. However, we recommend using the Portal when you're subscribing our APIs for the first-time.

  2. Look for the "Sandbox Keys" button in the Subscriptions tab, and click on it.

  3. This opens a form with a "Consumer key" (username) and "Consumer Secret" (password), which will be used as username and password to generate an access token.

  4. Click on Generate Access Token button, which will open another form with Access token validity. The default validity is set to 3600 seconds (1 hour).

  5. Once the validity is adjusted click on the "Generate" button.

  6. This will provide a token with the validity of the time you mentioned in the scope.

Step 04: Trying out the API

  1. Once the token is generated, copy the token and close the token window.

  2. Navigate to the "Try-Out" tab.

  1. Paste the Copied token to the "Access Token" text box. Make sure to keep the "Key Type" with respect to the generated token.

  1. Scroll down to see the default API and click on "Post". You'll see form fields with sample data pre-filled for testing.

  1. Click on "Try it out" to enable the Test parameters. Once enabled, click on Execute button to execute a test.

  1. The response will be displayed below

Last updated