Webhook Background Check

Notificação de Background Check

Após a conclusão de todos os serviços solicitados na requisição de background check, o webhook envia automaticamente os resultados para a URL cadastrada pela entidade.

Para utilização dessa funcionalidade, é necessário a solicitação de cadastramento de webhook pela entidade, enviando os dados abaixo para o e-mail: [email protected]

DadoDescrição
Nome ClienteNome Fantasia do cliente que contratou o serviço
URLURL que será chamada quando todos os serviços forem completados.

A implementação do Webhook não é obrigatória. Caso o cliente queira apenas fazer um GET no método para obter as respostas também é possível.

Requisitos Webhook

  • Content Type: application/json
  • Header: x-api-key
    • Content: HMAC SHA-256
    • Schema:
      • Value: UserName
      • Secret: Password

Para validar a requisição do webhook é necessário validar autenticidade do header x-api-key.

Validação API Key

  1. Ler o conteúdo do header x-api-key
  2. Criar assinatura HMAC SHA-256
    1. Valor a ser assinado: UserName
    2. Secret: Password
  3. Comparar a assinatura gerada com a api key recebido no header