Create Process

This article explains how to create a biometric transaction using the CreateProcess method via the IDUnico REST API.

This method creates a biometric process for IDUnico authentication. All validation in this flow is done after the user captures the biometric image. Upload the captured image and sent the person's information.

The image is processed after successful upload.

How to use it?

Make a POST request to the /processes/v1 endpoint

With a valid Access token, make a request to the endpoint (POST/processes/v1) sending the following parameters:

{
  "subject": {
    "Code": "CPF_holder",
    "Name": "NAME",
    "Email": "EMAIL",
    "Phone": "PHONE_NUMBER"
  },
  "useCase": "USECASE",
  "imagebase64": "IMAGE"
}

Parameters:

• HEADER PARAMETERS

Name	Type	Mandatory/Optional	Description
APIKEY	String	Mandatory	API key
Authorization	String	Mandatory	Access token
Content-Type	String	Mandatory	"application/json"

• REQUEST BODY SCHEMA

Name	Type	Mandatory/Optional	Description
subject.Code	String	Mandatory	Valid CPF.
subject.Name	String	Mandatory	Person's name
subject.Email	String	Optional	Email of the person.
subject.Phone	String	Optional	Phone number of the person
useCase	String	Optional	Indicates the use of the operation. Used so that operations can be segmented.
imagebase64	String	Mandatory	Photo of the person. The image must be base64 (png, jpg, jpeg). If the photo is captured using the Unico SDK with Liveness, the image sent must be a Json Web Token (.jwt). The .jwt must be sent within 10 minutes to prevent the image from expiring. And this .jwt can only be used once.

Important

The subject.Name parameter cannot contain two spaces between the names.

Correct parameter submission:

  "subject.Name": "Ronald Richards"

Wrong parameter submission:

  "subject.Name": "Ronald  Richards"

Request example:

Arquivo JSON

{
  "subject": {
    "code": "45875596922",
    "name": "Roberto Flavio",
    "email": "random@unico.io",
    "phone": "5511999999999"
  },
  "useCase": "cards",
  "imageBase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Successful request

If the request was executed successfully, the return response is a JSON as follows:

API Key configured with Synchronous ID:

• IDUnico

{
    "id": "016ba203-ca11-4690-aeb7-3573c9a03935",
    "status": 3,
    "unicoId": {
        "result": "yes"
    }
}

• IDUnico + IDCheck

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1,
    "score": 10
}

API Key configured with Asynchronous ID:

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481"
}

Request error

If an error occurs, the return response is a JSON containing the error code and description:

{
    "Error": {
        "code": "10700",
        "description": "Error description"
    }
}

For more information on the errors returned, see the list available in the article Response Errors.

Any concerns?

Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.