> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/integration-options/rest-api/postman-collections.md). # Postman Collection ## Overview Smile ID offers a Postman collection as a convenient way to test our Rest API endpoints without having to write code. [Postman](https://www.postman.com/product/api-client/) 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](https://api.postman.com/collections/2581147-0dc4ac24-1074-4bc4-b305-35dbe2b45c96?access_key=PMAT-01GXTSBAZ3ECNW0RQ06KD0MGQK) 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 [Postman website](https://www.getpostman.com/downloads/). Launch the tool after installation, you should see a user interface similar to the one below: ![](/files/-MkXJxa9jM-1WKHsDtnt) ### 2. Importing the Smile ID Postman Collection ![](/files/-MkXJoJlis7ZYvXIwhwQ) 1. Click on `Import` 2. Select `Link` as the import option 3. Copy and paste the [Smile ID Postman Collection Url](https://www.getpostman.com/collections/551c56966e45b596073a) in the `Enter a URL` field 4. Click `Continue` to import the collection 5. 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. You can get both your `partner_id` and signature `api_key` in your [Smile ID portal](https://portal.usesmileid.com/api-key). Ensure you copy the `api_key` of the environment you intend to test the collection in. {% hint style="info" %} 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](https://webhook.site/) tool. You can use the url you generate as your`callback_url`. {% endhint %} #### Setting the Collection Variables ![](/files/-Mkc4x4NASYCScJCs_Yo) 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 {% hint style="info" %} 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](/integration-options/rest-api/signing-your-api-request/generate-signature.md), in the language of your choice. {% endhint %} ## 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 ![](/files/-MkYH40kGen1V8vKBEiX) Set the base\_url variable in the request url section to `{{sandbox}}` #### Test Production Requests ![](/files/-MkYHgK7G1R8tOkhtxQ2) Set the base\_url variable in the request url section to `{{prod}}` ### Running a Request ![](/files/-MkYItwAW3RLHsM1zEJl) 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. 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](/supported-id-types/for-individuals-kyc/backed-by-id-authority.md). 4. Switch to the environment you want to run tests in - Sandbox is `{{sandbox}}` while Production is `{{prod}}` 5. 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 | | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://legacy-docs.usesmileid.com/integration-options/rest-api/postman-collections.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.