LogoLogo
  • Welcome!
  • GETTING STARTED
    • Signing Up
    • Choose a Product
    • Choose an Integration Option
    • Run Your First Test Job
    • Complete Your KYC
    • Fund Your Wallet
    • Go Live!
    • Pricing
  • SUPPORTED ID TYPES & DOCUMENTS
    • For Individuals (KYC)
      • Using ID Number
        • Supported Countries
          • Côte d'Ivoire
            • National ID (without Photo)
            • Resident ID (without Photo)
          • Ghana
            • Ghana Card
            • Passport
            • Voter's ID
          • Kenya
            • Alien Card
            • KRA Pin
            • National ID
            • National ID (without Photo)
            • Passport
            • Tax Information
          • Nigeria
            • Bank Account
            • BVN
            • NIN V2
            • NIN Slip Verification
            • V_NIN (Virtual NIN)
            • Phone Number
            • Voter's ID
          • South Africa
            • National ID
            • National ID (without Photo)
            • Phone Number
          • Uganda
            • National ID (without Photo)
            • Basic KYC in Uganda
          • Zambia
            • Bank Account
            • TPIN
          • Zimbabwe
            • National ID (without Photo)
        • Test Data
          • Customising Sandbox Test Data
        • ID Number Regex
        • Visual Samples of Supported ID Types
      • Using Document Image
        • Continents
          • Africa
          • Asia and the Middle East
          • Europe
          • North America
          • Oceania
          • South America
    • For Businesses (KYB)
      • Supported Countries
        • Nigeria
          • Business Registration
          • Tax Information
        • Kenya
          • Business Registration
        • South Africa
          • Business Registration
      • ID Number Regex
  • PRODUCTS
    • For Individuals (KYC)
      • AML Check
        • AML News Media
      • Basic KYC
      • Biometric KYC
      • Digital Address Verification
      • Document Verification
        • Document Verification
        • Enhanced Document Verification
      • Electronic Signature
      • Enhanced KYC
      • Phone Number Verification
      • SmartSelfie™ Authentication
      • SmartSelfie™ Compare
      • Smile Secure
    • For Businesses (KYB)
      • Business Verification
  • Integration Options
    • Mobile
      • Getting Started
      • Products
        • Biometric KYC
        • BVN Consent
        • Document Verification
        • Enhanced Document Verification
        • Enhanced KYC
        • SmartSelfie™ Enrollment and Authentication
        • Enhanced SmartSelfie™ Enrollment And Authentication
      • Customization
        • UI Components
      • Offline Mode
      • Release Notes
        • Android Release Notes
        • iOS Release Notes
        • Flutter Release Notes
        • React Native Release Notes
    • No-Code
      • Smile Links
        • Link FAQs
        • Rest API
    • Server to Server
      • Ruby
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
          • KYB - Business Verification
          • AML Check
        • Generate Token for Web Integration
        • Utilities
      • Python
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
          • Business Verification
        • Generate Token for Web Integration
        • Utilities
      • Java
        • Release Notes
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
        • Generate Token for Web Integration
        • Utilities
      • Node.js
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • Enhanced Document Verification
          • SmartSelfie™ Authentication
          • Business Verification
        • Generate Token for Web Integration
        • Utilities
      • PHP
        • Installation
        • Signature
        • Products
          • Basic KYC
          • Enhanced KYC
          • Biometric KYC
          • Document Verification
          • SmartSelfie™ Authentication
        • Generate Token for Web Integration
        • Utilities
    • Rest API
      • Signing your API Request
        • Using Signature
      • Products
      • Postman Collection
      • Utilities
    • Web / Mobile Web
      • Web Integration
        • Installation
        • Usage
        • End User Consent
        • Support
      • Javascript SDK
        • Installation
        • Usage
        • Migration
        • Deprecated Version
          • Installation
          • Usage
          • Notes
          • Support
  • FURTHER READING
    • FAQs
      • What are your support hours?
      • How do I set up a callback?
      • How to re-enroll, deactivate or delete a user?
      • Add or remove team members
      • What are top-level keys?
      • What are partner_params?
      • How do job types map to the new product names?
      • Is there an API I can use to monitor my wallet balance?
      • Is there an API I can query to check the availability status of an ID type?
      • How do I integrate Smile ID in other countries or query other ID types?
      • What are the image types I can upload to Smile ID?
      • Why aren't Kenyan IDs returning images for some IDs queried?
      • Why are some of my bank verification requests returning 'ID authority unavailable'?
      • How can I look up a specific user's data?
      • Selfie best-practices
      • Document capture best-practices
      • What happens under the hood?
      • Guide to the user consent screen
      • What is code 2302?
      • Using the Demo App and Scanning QR codes
    • Job status
    • KYC receipts
    • Result codes
      • Error codes
    • Securing your account with two-factor authentication (2FA)
    • Security Overview
    • Troubleshooting
      • Troubleshooting error 2204 & 2205 - "You're not authorized to do that"
      • Why is my Web API job taking so long?
      • Image capture issues on web client
Powered by GitBook
On this page
  • Overview
  • Getting Started
  • 1. Installing Postman
  • 2. Importing the Smile ID Postman Collection
  • 3. Configuring Smile ID Postman Collection
  • Using the Smile ID Postman Collection
  • Understanding the Structure of the Collection
  • Testing Sandbox or Production Requests
  • Running a Request
  • Running the Requests in the Correct Order
  • Collection Endpoints

Was this helpful?

  1. Integration Options
  2. Rest API

Postman Collection

PreviousProductsNextUtilities

Last updated 11 months ago

Was this helpful?

Overview

Smile ID offers a Postman collection as a convenient way to test our Rest API endpoints without having to write code. is a standalone tool that lets you test API functionality by sending requests and receiving response, Postman handles the HTTP client infrastructure code. This article is a comprehensive step-by-step guide to setting up your Postman and Smile ID Postman Collection, to enable you explore and test Smile ID Rest APIs.

  • The Smile ID Postman Collection URL is and the import method in Postman is Link.

Getting Started

  1. Install Postman

  2. Import the Smile ID Postman Collection

  3. Configure Smile ID Postman Collection

1. Installing Postman

Postman is available on Linux, Mac and Windows. The tool can be downloaded from the . Launch the tool after installation, you should see a user interface similar to the one below:

2. Importing the Smile ID Postman Collection

  1. Click on Import

  2. Select Link as the import option

  3. Click Continue to import the collection

  4. We have named the collection Smile ID Product Endpoints.

3. Configuring Smile ID Postman Collection

To use the collection, you need to specify your partner_id , signature api_key and callback_url in the collection variables.

Setting the Collection Variables

  1. Click the options icon ... next to the Smile ID Product Endpoints collection

  2. Select Edit

  3. Select Variables to edit the collection variables

  4. Set your partner ID in the initial value field of the variable partner_id

  5. Set your signature api key in the initial value field of the variable api_key

  6. Set your callback url in the initial value field of the variable callback_url

  7. Click on Reset All

  8. Click Save to store the values you inputted for each of the variables

  9. Ensure you leave all other variables unchanged

Using the Smile ID Postman Collection

Understanding the Structure of the Collection

The collection contains sub-folders, each representing a Smile ID product. Within the sub-folders are the sets of requests to run a successful job for that product.

Testing Sandbox or Production Requests

You can run both Sandbox and Production requests using the Smile ID postman collection. The base urls for the Sandbox and Production environments have been pre-set as variables in the collection.

Test Sandbox Requests

Set the base_url variable in the request url section to {{sandbox}}

Test Production Requests

Set the base_url variable in the request url section to {{prod}}

Running a Request

  1. Choose your Product of choice and select the first endpoint that is not marked OPT

  2. Navigate to Body in the Postman interface

  3. Switch to the environment you want to run tests in - Sandbox is {{sandbox}} while Production is {{prod}}

  4. Click on Send to send your request

Your response is either displayed on Postman or in the cases of products that require a callback_url to your callback url.

Running the Requests in the Correct Order

It is important that you run the requests in the order in which they are arranged in the collection sub-folders, since some of the data returned by one request may be used by the next.

Any request marked OPT e.g. OPT`` Request Name is optional and that request can be skipped.

Collection Endpoints

Sub Folder
Endpoint
Description
Useful Links

Basic KYC

Run Basic KYC (Async)

Test the asynchronous Basic KYC product. Response will be sent to your callback

Basic KYC

OPT Run Basic KYC

Test the synchronous Basic KYC product. Response can be viewed in Postman

Basic KYC

OPT Job Status

Use this endpoint to view the result of your job. You can always call Job Status to retrieve results of previous jobs

Enhanced KYC

Run Enhanced KYC (Async)

Test the asynchronous Enhanced KYC product. Response will be sent to your callback

Enhanced KYC

Run Enhanced KYC

Test the synchronous Enhanced KYC product. Response can be viewed in Postman

Enhanced KYC

OPT Job Status

Use this endpoint to view the result of your job. You can always call Job Status to retrieve results of previous jobs

Biometric KYC

Request Upload URL

Request an S3 URL where you will be uploading the ZIP file containing the info.json file and selfie image

Biometric KYC

Upload ZIP file

Upload the packaged info.json & selfie image to the specified URL

Biometric KYC

OPT Job Status

The result of the Enhanced KYC + SmartSelfie™ is sent to the callback url you specified in the collection variable, however you can view the result in postman by calling this endpoint

SmartSelfie™ Authentication

Request Registration Upload URL

Request an S3 URL where you can upload the info.json file and selfie image you intend to register.

SmartSelfie™ Authentication

Upload Registration Zip File

Upload the packaged info.json & selfie image to the specified URL

SmartSelfie™ Authentication

OPT Registration Job Status

The result of the registration step in SmartSelfie™ Authentication is sent to the callback url you specified in the collection variable, however you can view the result in postman by calling this endpoint

SmartSelfie™ Authentication

Request Authentication Upload URL

Request an S3 URL where you can upload the info.json file and selfie image you intend to compare against the registered selfie.

SmartSelfie™ Authentication

Upload Authentication Zip File

Upload the packaged info.json & selfie image to the specified URL

SmartSelfie™ Authentication

OPT Authentication Job Status

The result of the authentication step in SmartSelfie™ Authentication is sent to the callback url you specified in the collection variable, however you can view the result in postman by calling this endpoint

Utilities

OPT Services

Get the list of ID types and countries supported by Smile ID

Copy and paste the in the Enter a URL field

You can get both your partner_id and signature api_key in your . Ensure you copy the api_key of the environment you intend to test the collection in.

To quickly see and examine how Smile ID responses returned to your callback looks, you can generate a free webhook url using the tool. You can use the url you generate as yourcallback_url.

You do not need to set the signature and timestamp variables as there are scripts we have added in the collection that calculates them automatically. You can generate your signature and timestamp using any of our provided , in the language of your choice.

Set the appropriate values for each of the keys that are contained in the body section of the endpoint. Do not set values for any key with a {{xxxx}} in the value section as these are set automatically by the collection. For ID information, not all the keys in the body of the endpoint are required, you can get the list of required keys per ID Type .

Smile ID Postman Collection Url
Smile ID portal
Webhook Tester
sample codes
here
Basic KYC Product
Supported ID Types
Basic KYC Product
Supported ID Types
Rest API Utilities endpoints
Enhanced KYC Product
Supported ID Types
Enhanced KYC Product
Supported ID Types
Rest API Utilities endpoints
Biometric KYC Product
Biometric KYC
Rest API Utilities endpoints
SmartSelfie™ Authentication
SmartSelfie™ Authentication
Rest API Utilities endpoints
SmartSelfie™ Authentication
SmartSelfie™ Authentication
Rest API Utilities endpoints
Supported ID types
Postman
here
Postman website