> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks de entidades: eventos de usuário e empresa

> Webhooks do Didit em tempo real para mudanças em usuários e empresas: transições de status, perfil, campos do payload, assinatura e novas tentativas.



Prompt de webhooks de entidades
        Copiar o prompt para a área de transferência



      
      

\<pre>

\````# Goal — subscribe to entity-level webhooks and apply changes to my database

Entity webhooks fire whenever a User or Business entity changes its status or its profile data. Use them to keep your local mirror of Didit entities in sync.

\## Entity-level event catalog

\| `webhook_type` | Trigger |
\|---|---|
\| `user.status.updated` | User entity status changed (`ACTIVE` / `FLAGGED` / `BLOCKED`). Payload includes `previous_status`. |
\| `user.data.updated` | User entity profile / counters / metadata changed. Includes `changed_fields` and a `changes` map of `{previous, current}`. |
\| `business.status.updated` | Business entity status changed. Payload includes `previous_status`. |
\| `business.data.updated` | Business entity profile or aggregates changed. Includes `changed_fields` and `changes`. |

\`activity.created` is accepted in `subscribed_events` and by the Try Webhook tester, but Didit does not deliver it for live traffic. Do not build on it.

Session-level events (`status.updated`, `data.updated`) and transaction events (`transaction.created`, `transaction.status.updated`) live alongside but are separate — see /integration/webhooks for the full catalog.

\## Register a destination

\```bash
curl -X POST https://verification.didit.me/v3/webhook/destinations/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "Entity sync",
"url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"subscribed_events": [
  "user.status.updated",
  "user.data.updated",
  "business.status.updated",
  "business.data.updated"
]
}'
\```

Persist the returned destination `secret_shared_key` — that's the HMAC signing key.

\## Payload shape

Entity payloads are flat: there is no `data` wrapper and no `event` key. Read `webhook_type`.

\```json
\{
"event_id": "7f3c2c1e-6a1d-4c36-9d8e-0d3b5f4e2a10",
"webhook_type": "user.status.updated",
"timestamp": 1776333600,
"created_at": 1776333594,
"application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"environment": "live",
"vendor_user_id": "9c7d2a30-...",
"vendor_data": "user-42",
"status": "BLOCKED",
"previous_status": "ACTIVE"
}
\```

\`business.*` events use `vendor_business_id` instead of `vendor_user_id`.
\`user.data.updated` / `business.data.updated` payloads keep `status` and add `changed_fields` (array) and `changes` (`{field: {previous, current}}`). Use these to apply minimal diffs to your DB.

\## Verify the signature

Verify X-Signature-V2 (recommended): HMAC-SHA256 of the canonical JSON body with the destination `secret_shared_key`, then a constant-time compare, and reject an X-Timestamp older than 300 seconds. See /integration/webhooks for the signature headers and code samples. Respond `2xx` within **5 seconds**. On a 5xx, 404, timeout or connection failure Didit retries up to 2 times (about 1 minute, then about 4 minutes later); see /integration/webhooks#retry-policy.

\## Idempotency

Every delivery carries a unique `event_id`. De-dupe on it. Fallback compound key: `(application_id, webhook_type, vendor_data, timestamp)`.

\## Failure modes

\- Wrong `webhook_version` (e.g. v2) → singular fields and older event names; v3 is required for entity events plural-array contract.
\- Slow handler → retried; budget < 5s; do heavy work async.
\- Unknown event type → log and 200; new event types may be added.

\## Apply-decision pseudocode

\```ts
switch (event.webhook_type) {
case "user.status.updated":
await db.users.update({ vendor_data: event.vendor_data }, { status: event.status });
break;
case "user.data.updated":
for (const field of event.changed_fields) {
  await db.users.update({ vendor_data: event.vendor_data }, { [field]: event.changes[field].current });
}
break;
case "business.status.updated":
case "business.data.updated": /* same shape, businesses table, keyed by vendor_business_id */ break;
}
\```

\## Sources of truth

\- /integration/webhooks — destinations, signatures, retries, full event catalog
\- /management-api/webhook/create-destination — endpoint schema
\- /entities/users/operations — operations that emit user events
\- /entities/businesses/operations — operations that emit business events
\- /integration/integration-prompt — canonical end-to-end prompt````

\</pre>



      
      

Colar em

Toda alteração no status ou nos dados de perfil de uma entidade User ou Business gera um webhook, para que o seu sistema reaja em tempo real.
Use os webhooks de entidades para sincronizar dados de perfil, propagar bloqueios para outros sistemas ou acionar fluxos de conformidade subsequentes.## Catálogo de eventos| Evento | Gatilho |
| - | - |
| `user.status.updated` | O status de uma entidade User muda (`ACTIVE` ↔ `FLAGGED` ↔ `BLOCKED`) |
| `user.data.updated` | Os campos de perfil de uma entidade User mudam (nome, data de nascimento, retrato, contadores agregados, metadados) |
| `business.status.updated` | O status de uma entidade Business muda |
| `business.data.updated` | Os campos de perfil de uma entidade Business mudam (razão social, número de registro, país, contadores) |> [!NOTE]
>
> `activity.created` é aceito em `subscribed_events` e pode ser testado no **Try Webhook**, mas a Didit não o entrega atualmente em produção.
> Não use esse evento para espelhar linhas do tempo.A Didit também emite eventos de sessão, de transação e de sessão de empresa que fazem referência a campos de entidades. Veja:- [Webhooks de KYB](https://docs.didit.me/pt-br/business-verification/webhooks.md) — eventos de sessão de empresa
- [Webhooks de Monitoramento de transações](https://docs.didit.me/pt-br/transaction-monitoring/webhooks.md) — eventos de transação
- [Referência de webhooks](https://docs.didit.me/pt-br/integration/webhooks.md) — verificação de assinatura, novas tentativas, destinos## Formatos de payloadOs webhooks de entidades são planos: não há um wrapper `data` nem uma chave `event`.
Leia `webhook_type` para encaminhar o evento.```json theme={null}
{
  "event_id": "7f3c2c1e-6a1d-4c36-9d8e-0d3b5f4e2a10",
  "webhook_type": "user.status.updated",
  "timestamp": 1776333600,
  "created_at": 1776333594,
  "application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "environment": "live",
  "vendor_user_id": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "vendor_data": "user-42",
  "status": "BLOCKED",
  "previous_status": "ACTIVE"
}
```| Campo | Descrição |
| - | - |
| `vendor_user_id` / `vendor_business_id` | Identificador da Didit para a entidade. Os eventos `business.*` usam `vendor_business_id`. |
| `vendor_data` | O seu identificador para a entidade. |
| `status` | `ACTIVE`, `FLAGGED` ou `BLOCKED`. |
| `previous_status` | Somente em `*.status.updated`. |
| `changed_fields` e `changes` | Somente em `*.data.updated`. |
| `created_at` | Segundos Unix de quando a entidade foi atualizada pela última vez. |
| `timestamp` | Segundos Unix de quando a Didit despachou o webhook. |### `user.status.updated` / `business.status.updated`É disparado a cada mudança de status.
O payload traz `status` e `previous_status`.
Ele não informa por que o status mudou: abra a entidade no console se você precisar saber a causa.### `user.data.updated` / `business.data.updated`É disparado quando campos de perfil mudam.
`changed_fields` lista os campos que mudaram, e `changes` contém o valor `previous` e o valor `current` de cada um.```json theme={null}
{
  "event_id": "5d1e8f9a-0c32-4b6a-a7b6-2b9d6f0a3c41",
  "webhook_type": "user.data.updated",
  "timestamp": 1776333700,
  "created_at": 1776333694,
  "application_id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "environment": "live",
  "vendor_user_id": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "vendor_data": "user-42",
  "status": "ACTIVE",
  "changed_fields": ["full_name", "session_count"],
  "changes": {
    "full_name": { "previous": null, "current": "John Doe" },
    "session_count": { "previous": 2, "current": 3 }
  }
}
```Os campos que podem aparecer em `changed_fields` são:- User: `vendor_data`, `display_name`, `full_name`, `date_of_birth`, `metadata`, `portrait_image`, `issuing_states`, `approved_emails`, `approved_phones`, `features`, `session_count`, `approved_count`, `declined_count`, `in_review_count`, `first_session_at`, `last_session_at`.
- Business: `vendor_data`, `display_name`, `metadata`, `legal_name`, `registration_number`, `country_code`, `session_count`, `approved_count`, `declined_count`, `in_review_count`, `features`, `first_session_at`, `last_session_at`.Use `changed_fields` e `changes` para sincronizar somente os campos que mudaram.## Entrega, novas tentativas e assinaturaTodos os webhooks de entidades seguem o contrato de entrega padrão:- **Assinado** com HMAC-SHA256 no cabeçalho `X-Signature-V2` (recomendado), usando o `secret_shared_key` do destino. `X-Signature` e o obsoleto `X-Signature-Simple` também são enviados, junto com `X-Timestamp`.
- **Repetido** até 2 vezes, após cerca de 1 minuto e cerca de 4 minutos, quando o seu endpoint responde com 5xx ou 404, excede o tempo limite ou falha ao conectar. A [referência de webhooks](https://docs.didit.me/pt-br/integration/webhooks.md#política-de-novas-tentativas) traz a política completa.
- **Idempotente** — todo webhook tem um `event_id` único no payload; faça a deduplicação do seu lado.Consulte a [Referência de webhooks](https://docs.didit.me/pt-br/integration/webhooks.md) para a configuração de destinos e exemplos de código de verificação de assinatura.## Inscrever-se em eventosInscreva-se em eventos de entidades em um destino de webhook pela Management API ou pelo Business Console:```bash theme={null}
curl -X POST https://verification.didit.me/v3/webhook/destinations/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Entity sync",
    "url": "https://yourapp.com/webhooks/didit",
    "subscribed_events": [
      "user.status.updated",
      "user.data.updated",
      "business.status.updated",
      "business.data.updated"
    ]
  }'
```## Próximos passos> [card] [Referência de webhooks](https://docs.didit.me/pt-br/integration/webhooks.md)
>
> Destinos, assinaturas, novas tentativas e verificação.> [card] [Criar destino](https://docs.didit.me/pt-br/management-api/webhook/create-destination.md)
>
> Registre um novo endpoint de webhook.> [card] [Operações de usuário](https://docs.didit.me/pt-br/entities/users/operations.md)
>
> Alterações que disparam webhooks de usuário.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.