Anexar documento no processo de Biometria

Este artigo explica como anexar um documento no processo de biometria através da REST API do Unico Check.

Esse método anexa um documento no processo de biometria.

Como usar?

Faça uma requisição POST para o endpoint /processes/{processoId}/document

Com o token de acesso válido, faça uma requisição para o endpoint (POST/processes/{processoId}/document) enviando seguintes parâmetros:

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

Parametros:

• PATH PARAMETERS

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

• 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
type	String	Mandatório	Indica o tipo do documento anexado. Lista de enumerado na sessão 'Enumerados'.
imagebase64	String	Mandatório	Foto da pesssoa. A imagem precisa ser em base64 (png, jpg, jpeg)

Exemplo de requisição:

{
  "type": "2",
  "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

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",
  "Typed": "2",
  "Document": {
    "BirthDate": "01/01/2000",
    "PlaceOfBirth": "São Paulo",
    "Category": "AB",
    "ExpeditionCity": "São Paulo",
    "ExpeditionState": "SP",
    "ExpeditionDate": "01/01/2000",
    "ExpirationDate": "01/01/2000",
    "FatherName": "João",
    "MotherName": "Maria",
    "FirstLicenseDate": "01/01/2000",
    "Name": "José",
    "RG": "123456789",
    "Code": "12345678910",
    "RegistrationNumber": "01234567",
    "Renach": "789456123",
    "SecurityCode": "123456",
    "MirrorNumber": "78910",
    "CRM": "5-549788-5/PR",
    "Observation": ""
  }
}

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'
Typed	string	Indica o status da tipificação dos documentos. 0 - Falha ao tipificar // 1 - Sucesso ao tipificar // 2 - Recurso desligado.
Document.BirthDate	string	Indica a data de nascimento
Document.PlaceOfBirth	string	Indica o local de nascimento
Document.Category	string	Indica a categoria da habilitação (CNH)
Document.ExpeditionCity	string	Indica a cidade de emissão do documento
Document.ExpeditionState	string	Indica UF de emissão do documento
Document.ExpeditionDate	string	Indica a data de emissão do documento
Document.ExpirationDate	string	Indica a validade do documento
Document.FatherName	string	Indica o nome do pai
Document.MotherName	string	Indica o nome da mãe
Document.FirstLicenseDate	string	Indica a data da 1ª habilitação (CNH)
Document.Name	string	Indica o nome da pessoa
Document.RG	string	Indica o número do RG
Document.Code	string	Indica o número do CPF
Document.RegistrationNumber	string	Indica o Nº de Registro da habilitação (CNH)
Document.Renach	string	Indica o Registro Nacional de Carteira de Habilitação (CNH)
Document.SecurityCode	string	Indica o código de segurança
Document.MirrorNumber	string	Indica o Número do Espelho da habilitação (CNH)
Document.CRM	string	Indica o número do CRM
Document.Observation	string	Indica observaçoes que estão no documento

Caso ocorra algum erro aconteça, a resposta de retorno é um JSON contendo o erro e o código 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.