Tipificar documento

Este artigo explica como verificar se o documento enviado corresponde ao que foi solicitado através da REST API do Unico Check.

Esse método verifica se o documento informado na requisição é ele mesmo.

Como usar?

Faça uma requisição POST para o endpoint /documents/confirmation

Com o token de acesso válido, faça uma requisição para o endpoint (POST/documents/confirmation) enviando os seguintes parâmetros:

{
  "documentType": "TIPO_DOCUMENTO",
  "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso
Content-Type	String	Mandatório	"application/json"

• REQUEST BODY SCHEMA

Nome	Tipo	Mandatorio/Opcional	Descrição
documentType	String	Mandatório	Tipo do documento
imagebase64	String	Mandatório	Foto do documento. A imagem precisa ser em base64 (png, jpg, jpeg)

Exemplo de requisição:

Arquivo JSON

{
  "documentType": "3",
  "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

O tipo do documento pode ser encontrado no artigo de enumerados em Documentos Tipificados.

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o status da verificação como a seguir:

{
  "Status": true
}

O status é um boolean indicando se conseguiu tipificar o documento ou não.

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.