Postman Collection
Last updated
Last updated
Smile ID offers a Postman collection as a convenient way to test our Rest API endpoints without having to write code. Postman 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 here and the import method in Postman is Link.
Install Postman
Import the Smile ID Postman Collection
Configure Smile ID Postman Collection
Postman is available on Linux, Mac and Windows. The tool can be downloaded from the Postman website. Launch the tool after installation, you should see a user interface similar to the one below:
Click on Import
Select Link
as the import option
Copy and paste the Smile ID Postman Collection Url in the Enter a URL
field
Click Continue
to import the collection
We have named the collection Smile ID Product Endpoints.
To use the collection, you need to specify your partner_id
, signature api_key
and callback_url
in the collection variables.
You can get both your partner_id
and signature api_key
in your Smile ID portal. 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 Webhook Tester tool. You can use the url you generate as yourcallback_url
.
Click the options icon ...
next to the Smile ID Product Endpoints collection
Select Edit
Select Variables
to edit the collection variables
Set your partner ID in the initial value field of the variable partner_id
Set your signature api key in the initial value field of the variable api_key
Set your callback url in the initial value field of the variable callback_url
Click on Reset All
Click Save
to store the values you inputted for each of the variables
Ensure you leave all other variables unchanged
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 sample codes, in the language of your choice.
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.
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.
Set the base_url variable in the request url section to {{sandbox}}
Set the base_url variable in the request url section to {{prod}}
Choose your Product of choice and select the first endpoint that is not marked OPT
Navigate to Body
in the Postman interface
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 here.
Switch to the environment you want to run tests in - Sandbox is {{sandbox}}
while Production is {{prod}}
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.
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.
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