Consultar informações do documento anexado

Este artigo explica como cnsultar informações do documento anexado a um processo de biometria através da REST API do Unico Check.

Importante

Os documentos só ficam disponíveis para download através do link por 8 horas após o envio para o portal.

Como usar?

Faça uma requisição GET para o endpoint /processes/{processoId}/documents

Com o token de acesso válido, faça uma requisição para o endpoint (GET/processes/{processoId}/documents).

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso

• PATH PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
processoId	String	Mandatório	Numero do processo

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes parâmetros:

{
    "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="
        }
    ]
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
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/'

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.