Criar processo de Mensagem

Este artigo explica como criar um processo de mensagem através da REST API do Unico Check.

Esse método cria um processo de mensagem (sem assinatura), contendo os dados da pessoa.

Como usar?

Faça uma requisição POST para o endpoint /messages

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

{
  "subject": {
    "Code": "CPF_Titular",
    "Name": "NOME_Titular",
    "Gender": "GENERO_Titular",
    "BirthDate": "DATANASCIMENTO_Titular",
    "Email": "EMAIL_Titular",
    "Phone": "PHONE_Titular"
  },
  "indexes": [ 
  {
    "key": "CPF_Titular",
    "value": "NOME_Titular",
    "page": "GENERO_Titular",
  },
  ],
  "template": "SELFIE_TRUE_FALSE",
  "send": "WEBHOOK_URL",
  "enableQRCode": "WEBHOOK_tokenAcesso"
}

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
subject.Code	String	Mandatório	CPF válido
subject.Name	String	Mandatório	Nome da pessoa
subject.Gender	String	Opcional	Gênero da pessoa, podendo ser M ou F.
subject.BirthDate	String	Opcional	Data de nascimento. String de 10 caracteres. Exemplo: 01/01/0001.
subject.Email	String	Opcional	Email da pessoa
subject.Phone	String	Opcional	Telefone da pessoa
onlySelfie	Boolean	Mandatório	Informa se é um processo que contém apenas a foto biométrica e se pode concluir o processo. Quando 'false' o processo tem 60 minutos para ser concluído (ficando com status 1 até a chamada do ExecuteProcess) ou será cancelado automaticamente.
webHookUrl	String	Opcional	Url do endpoint para retorno do status (necessário ter configuração de webhook preexistente).
webHookSecret	String	Opcional	Token de acesso do endpoint de retorno.
imagebase64	String	Mandatório	Foto da pesssoa. A imagem precisa ser em base64 (png, jpg, jpeg)

Exemplo de requisição:

Arquivo JSON

{
  "subject": {
    "Code": "12345678910",
    "Name": "Bob",
    "Gender": "M",
    "BirthDate": "01/01/0001",
    "Email": "email@example.com",
    "Phone": "5543999999999"
  },
  "onlySelfie": true,
  "webHookUrl": "status.webhook.com",
  "webHookSecret": "fo9graB5ids9",
  "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Requisição com Sucesso

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

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

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.