Perfil

Webhooks de perfil são usados para comunicar atualizações de status do perfil ao cliente-servidor.

Você receberá uma notificação via webhook sempre que o status do perfil mudar, já que o modelo de consulta responsável pela criação do perfil tem um webhook de perfil configurado.

Configurando o webhook

Para configurar a URL do webhook de perfil de um modelo de consulta, navegue até o Modelos de Consulta menu no CAF Trust Platform e selecione o modelo desejado e edite o Webhook de perfil campo.

• Cada Modelo de Consulta criado no CAF Trust Platform precisará de uma URL de callback atribuída para o webhook de perfil. Essa URL pode ser diferente entre os modelos ativos ou ser a mesma.
• A URL configurada deve estar pronta para receber uma requisição POST após a execução de um serviço do CAF.

Parâmetros de resposta do webhook

Nome	Tipo	Descrição
profileId*	cadeia de caracteres	Identificador do perfil
tipo*	cadeia de caracteres	Tipo de perfil atualizado (PF ou PJ)
status*	cadeia de caracteres	Novo status do perfil
updatedAt*	cadeia de caracteres	Data em que o perfil foi atualizado
cpf	cadeia de caracteres	Cadastro nacional de pessoa física, se for um perfil de pessoa física
cnpj	cadeia de caracteres	Cadastro Nacional da Pessoa Jurídica, se for um perfil de empresa

Exemplo de envio do webhook:

{
  "profileId": "6021a21b3811c35ecb8dea20",
  "type": "PF",
  "status": "REPROVED",
  "updatedAt": "2023-01-24T12:10:21.311Z",
  "cpf": "00011122233"
}