DocumentInsert

This article explains how to attach a document to the biometrics process via the Unico Check REST API.

This method attaches a document to the biometric process.

How to use it?

Make a POST request to the /processes/{processoId}/document endpoint

With a valid Access token, make a request to the endpoint (POST/processes/{processoId}/document) sending the following parameters:

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

Parameters:

• PATH PARAMETERS

Name	Type	Mandatory/Optional	Description
processoId	String	Mandatory	Process number

• HEADER PARAMETERS

Name	Type	Mandatory/Optional	Description
APIKEY	String	Mandatory	API key
Authorization	String	Mandatory	Access token
Content-Type	String	Mandatory	"application/json"

• REQUEST BODY SCHEMA

Name	Type	Mandatory/Optional	Description
type	String	Mandatory	Indica o tipo do documento anexado. Lista de enumerado na sessão 'Enumerados'.
imagebase64	String	Mandatory	Foto da pesssoa. A imagem precisa ser em base64 (png, jpg, jpeg)

Request example:

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

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

{
  "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": ""
  }
}

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'
Typed	string	Indica o status da tipificação dos documentos. 0 - Falha ao tipificar // 1 - Sucesso ao tipificar // 2 - Recurso desligado.
DocumentType	string	Indica o tipo de retorno do documento. 2 para RG, 3 para CPF e 4 para CNH.
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

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.