GetDocuments

This article explains how to retrieve information from the document attached to a biometric process via the Unico Check REST API.

How to use it?

Make a GET request to the /processes/{processoId}/documents endpoint

With a valid Access token, make a request to the endpoint (GET/processes/{processoId}/documents).

Parameters:

• HEADER PARAMETERS

Name	Type	Mandatory/Optional	Description
APIKEY	String	Mandatory	API key
Authorization	String	Mandatory	Access token

• PATH PARAMETERS

Name	Type	Mandatory/Optional	Description
processoId	String	Mandatory	Process number

Successful request

If the request was executed successfully, the return response is a JSON containing the following parameters:

{
    "Id": "11111111-1111-1111-1111-111111111111",
    "Documents": [
        {
            "Type": 1,
            "Uri": "/Handlers/FileHandler.ashx?op=300&name=11111111-1111-1111-1111-111111111111&extension=1&timestamp=404573&thumb=3&user=oi&div="
        }
    ]
}

The return parameters are:

Name	Type	Description
Id	string	Indica o ID do processo criado com o envio da foto. Ele é utilizado nos outros métodos de 'Processes'
Documents.Type	integer	Indica o tipo do documento anexado. Lista de enumerado na sessão 'Enumerados'.
Documents.Uri	string	Indica a URL para download do documento. Ela não vem completa, é necessário adicionar o caminho do portal 'www.acesso.io/instancia/'

Request error

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

{
    "Error": {
        "code": "40004",
        "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.