Pular para o conteúdo principal

Anexar resumo no processo de Biometria

Este artigo explica como anexar um resumo 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}/resume​

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

{
  "resumes": [
    {
      "description": "DESCRICAO_RESUMO",
      "html": "HTML_RESUMO"
    },
  ]
}

Parametros:

  • PATH PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
processoIdStringMandatórioNumero do processo
  • HEADER PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
APIKEYStringMandatórioAPI key
AuthorizationStringMandatórioToken de acesso
Content-TypeStringMandatório"application/json"
  • REQUEST BODY SCHEMA
NomeTipoMandatorio/OpcionalDescrição
resumes.descriptionStringMandatórioIndica a descrição do resumo
resumes.htmlStringMandatórioIndica o HTML do resumo

Exemplo de requisição:

{
  "resumes": [
    {
      "description": "Resumo 1",
      "html": "<html> <body> <p> Resumo </p> </body> </html>"
    },
    {
      "description": "Resumo 2",
      "html": "<html> <body> <p> Resumo </p> </body> </html>"
    }
  ]
}

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.