API Guide
The REST API allows you to achieve your goal by integrating with Unico IDLive. The API uses requests and responses in JSON format and has an authentication system based on JWT Bearer.
Main Features
Through the API you can manage transactions through proof of life.
- CreateProcess - Create a transaction with proof of life;
- It is possible to combine the results of Unico IDLive and IDUnico. With the combination, you have the option of using Unico IDLive at the top of your funnel to verify proof of life and then, when necessary, using the GetProcess method of IDUnico to obtain the CPF authenticity information. To do this, you need to have enabled IDUnico through the API Key.
For more information about GetProcess method of IDUnico, see Get Process - IDUnico.
Before starting the integration, make sure you have valid credentials to use the product.
Get a valid OAuth token;
To make requests to the REST API you need a valid Access OAuth token. If you are not familiar with the OAuth authentication model, see how to generate a valid token in this article. After generation, the Access token must be sent in the header of your request, next to the Authorization parameter.
Environments
When you start the integration, you will receive the credentials for the UAT environment. Only after the testing and certification process will you receive production credentials.
You must point your requests to the correct URLs at each stage of your integration. IP and Port information for UAT and production is listed below:
- UAT:
https://api.id.uat.unico.app/; - Production:
https://api.id.unico.app/; - Default port: 443.
You can use the API in a test environment to test the functionalities without affecting your production environment.
In the approval environment (UAT) no face is registered, so any image can be sent.
Any concerns?
Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.