Anexar documento no processo de Biometria

Este artigo explica como anexar uma proposta no fluxo de mensagem através da REST API do Unico Check.

Como usar?

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

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

{
  "type": "TIPO_PROPOSTA",
  "signature": {
    "proposalName": "NOME_PROPOSTA",
    "proposalResume": "RESUMO_PROPOSTA",
    "signaturesPositions": [
      {
        "X": "POSICAO_HORIZONTAL_ASSINATURA",
        "Y": "POSICAO_VERTICAL_ASSINATURA",
        "Page": "PAGINA_ASSINATURA"
      }
    ]
  },
  "imagebase64": "IMAGEM_PROPOSTA"
}

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 da proposta (300, 301, 302 e 303).
signature.proposalName	String	Opcional	Indica o Nome da proposta.
signature.proposalResume	String	Mandatório	Indica resumo da proposta em HTML ou texto puro.
signature.signaturesPositions.X	Integer	Mandatório	Indica o eixo X da assinatura, ou seja, numa reta horizontal, onde a assinatura deve estar localizada na página em pixels.
signature.signaturesPositions.Y	Integer	Mandatório	Indica eixo Y da assinatura ou seja, numa reta vertical, onde a assinatura deve estar localizada na página em pixels.
signature.signaturesPositions.Page	Integer	Mandatório	Indica a página onde a assinatura irá sair.
imagebase64	String	Mandatório	Imagem da proposta. A imagem precisa ser em base64 (png, jpg, jpeg)

DICA

Os valores máximos de X e Y na posição da assinatura deveriam ser:

• Eixo x (Reta horizontal)= 252
• Eixo y (Reta vertical)= 566

Exemplo de requisição:

{
  "type": "300",
  "signature": {
    "proposalName": "nome da proposta",
    "proposalResume": "resumo de proposta",
    "signaturesPositions": [
      {
        "X": 252,
        "Y": 566,
        "Page": 1
      }
    ]
  },
  "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o ID do processo criado com o envio da foto como a seguir:

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481"
}

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.