Obter informações de uma mensagem

Este artigo explica como obter informações de uma mensagem através da REST API do Unico Check.

Essa informação fica disponível por 8h após a inserção do documento

Como usar?

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

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

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:

{
  "Documents": [
    {
      "Type": 1,
      "Uri": "/Handlers/FileHandler.ashx?op=300&name=11111111-1111-1111-1111-111111111111&extension=1&timestamp=404573&thumb=3&user=oi&div="
    }
  ],
  "HasBiometry": true,
  "Id": "11111111-1111-1111-1111-111111111111",
  "Liveness": 0,
  "Status": 7,
  "Score": 10,
  "OCRCode": 0,
  "FaceMatch": 0,
  "CurrentStep": 99
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
Documents.type	integer	Indica o tipo do documento em anexo. 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/'
HasBiometry	boolean	Indica se o processo possui uma foto biometricamente válida ou não (se possui um rosto ou não).
Id	string	Indica o ID do processo criado com o envio da foto. Ele é utilizado nos outros métodos de 'Processes'
Liveness	integer	Indica o status do liveness, indica se é uma foto de foto ou não. 0 - Desligado // 1 - Foto OK // 2 - Foto de Foto
Score	integer	Indica o score de autenticação daquele CPF / Foto. Ver a sessão de Score para entender melhor sobre
Status	integer	Indica o status do Processo, usado para indicar se está concluído ou não.
OCRCode	integer	Indica o status do OCRCode, procura no documento informado um determinado CPF. 0 - Desligado // 1 - Ok // 2 - Não Ok
FaceMatch	integer	Indica o status do FaceMatch, verifica se a foto no documento é a mesma pessoa da foto informada. 0 - Desligado // 1 - Ok // 2 - Não Ok
CurrentStep	integer	Indica qual é a etapa atual do processo. Lista de enumerado na sessão 'Enumerados'

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.