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

# Evento organization.review.required

> Evento organization.review.required.

## Evento `organization.review.required`

Disparado quando uma organização conectada precisa confirmar ou atualizar dados
cadastrais para manter a conta apta a receber pagamentos.

O evento é entregue aos endpoints da própria organização e aos endpoints da
plataforma conectada que assinaram esse tipo. Use `data.object.url` para levar
o responsável pela conta ao fluxo hospedado de atualização cadastral.

## Exemplo de payload

```json theme={}
{
  "id": "evt_123",
  "object": "event",
  "created_at": "2026-06-24T12:00:00.000Z",
  "data": {
    "object": {
      "id": "sr_123",
      "object": "organization_review",
      "created_at": "2026-06-24T12:00:00.000Z",
      "deadline_at": "2026-07-24T12:00:00.000Z",
      "livemode": true,
      "metadata": {},
      "organization": "org_456",
      "requested_fields": ["revenue", "address"],
      "review_type": "periodic",
      "status": "pending",
      "submission_mode": "full",
      "submitted_at": null,
      "updated_at": "2026-06-24T12:00:00.000Z",
      "url": "https://hosted.chargefy.io/review/UpBCTlVOgL7BuWIrbW5rdAmZaeF14bQ1x9Fy_QgndQQ"
    }
  },
  "livemode": true,
  "organization": "org_456",
  "request": {
    "id": null
  },
  "type": "organization.review.required"
}
```

## Campos do payload

### Payload

| Campo          | Tipo      | Descrição                                                                 |
| -------------- | --------- | ------------------------------------------------------------------------- |
| `id`           | `string`  | ID único do evento (`evt_*`).                                             |
| `object`       | `string`  | Sempre `"event"`.                                                         |
| `created_at`   | `string`  | Data/hora ISO 8601 da geração do evento.                                  |
| `livemode`     | `boolean` | Mesmo valor de `data.object.livemode`.                                    |
| `organization` | `string`  | ID da organização conectada que precisa concluir a atualização cadastral. |
| `type`         | `string`  | `"organization.review.required"`                                          |

### `data.object`

| Campo              | Tipo             | Descrição                                                                                                                                                                     |
| ------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`               | `string`         | ID da atualização cadastral.                                                                                                                                                  |
| `object`           | `string`         | Sempre `"organization_review"`.                                                                                                                                               |
| `created_at`       | `string`         | Quando a atualização cadastral foi criada.                                                                                                                                    |
| `deadline_at`      | `string \| null` | Prazo recomendado para envio. Quando `null`, use a expiração do link hospedado como limite operacional.                                                                       |
| `livemode`         | `boolean`        | `true` em produção; `false` em ambiente de teste.                                                                                                                             |
| `metadata`         | `object`         | Reservado para compatibilidade; hoje retorna `{}`.                                                                                                                            |
| `organization`     | `string`         | ID da organização conectada vinculada à atualização.                                                                                                                          |
| `requested_fields` | `array`          | Campos solicitados no processo. Interprete junto com `submission_mode`: em `full`, envie todos os campos exigidos pelo fluxo; em `partial`, envie somente os campos listados. |
| `review_type`      | `string`         | Tipo normalizado pela Chargefy: `periodic`, `inconsistent` ou `unknown`.                                                                                                      |
| `status`           | `string`         | Estado normalizado pela Chargefy: `pending`, `overdue`, `expired`, `submitted`, `finished` ou `failed`.                                                                       |
| `submission_mode`  | `string`         | Modo de envio normalizado pela Chargefy: `full`, `partial` ou `unknown`.                                                                                                      |
| `submitted_at`     | `string \| null` | Quando a organização enviou os dados. Neste evento, normalmente `null`.                                                                                                       |
| `updated_at`       | `string`         | Última modificação da atualização cadastral.                                                                                                                                  |
| `url`              | `string \| null` | URL hospedada que deve ser compartilhada com o responsável pela organização.                                                                                                  |

<Info>
  `organization.review.required` indica que há uma ação pendente. A conta ainda
  pode estar operando normalmente, mas a atualização deve ser concluída dentro
  do prazo para evitar interrupções no recebimento de pagamentos.
</Info>

## Uso típico

```typescript theme={}
switch (event.type) {
  case "organization.review.required": {
    const review = event.data.object;
    await notifications.sendOrganizationReviewLink({
      organization: review.organization,
      url: review.url,
      deadline_at: review.deadline_at,
    });
    break;
  }
}
```