# Detalhar caso de uso
Source: https://docs.autorize.com.br/api-reference/casosdeuso/detalhar-caso-de-uso

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json get /api/casos-de-uso/{id}
Retorna os detalhes de um caso de uso pelo `id`. Só retorna casos de uso da empresa dona da chave de API (header `Api-Key`).

**Origem dos dados:** os casos de uso são obtidos das APIs da SERPRO (Credencia/PGCC) durante a sincronização e ficam salvos no Autorize GCC. Este endpoint consulta os dados já salvos no Autorize GCC, sem chamar a SERPRO em tempo real. Alterações feitas na SERPRO só aparecem aqui após uma nova sincronização.



# Listar casos de uso da empresa
Source: https://docs.autorize.com.br/api-reference/casosdeuso/listar-casos-de-uso-da-empresa

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json get /api/casos-de-uso
Lista os casos de uso da empresa.

**Origem dos dados:** os casos de uso são obtidos das APIs da SERPRO (Credencia/PGCC) durante a sincronização e ficam salvos no Autorize GCC. Este endpoint consulta os dados já salvos no Autorize GCC, sem chamar a SERPRO em tempo real. Se um caso de uso foi criado ou alterado na SERPRO e ainda não aparece aqui, é preciso fazer uma nova sincronização.

**Filtro opcional:** `empresaVinculoPgccId` retorna apenas os casos de uso de um vínculo PGCC específico.



# Criar hash de consulta
Source: https://docs.autorize.com.br/api-reference/hashconsulta/criar-hash-de-consulta

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json post /api/hash-consulta
Cria nova hash de consulta. Quando `isConsentimento` for `true` e `idPgccConsentimento` for informado, o hash é gerado vinculado ao consentimento identificado pelo ID do consentimento no PGCC. Caso contrário, o hash é gerado sem vínculo com consentimento.



# Introdução
Source: https://docs.autorize.com.br/api-reference/index

Documentação da API disponível para Usuários vinculados ao Autorize (GCC).

## Base URL

A base URL para acessar a API do Autorize (GCC) é:

### Produção

```
https://public-usuario-api.autorize.com.br
```

### Homologação

```
https://staging-public-usuario-api.autorize.com.br
```

## Autenticação

A autenticação é realizada utilizando uma chave de API (API Key) que deve ser incluída no cabeçalho de cada requisição. O formato do cabeçalho é o seguinte:

```HTTP theme={null}
Api-Key: SUA_CHAVE_DE_API
```

<Note type="warning">
  **Chaves de API são separadas por ambiente.** Uma chave de API criada em **Produção** não funcionará em **Homologação**, e vice-versa. Certifique-se de usar a chave correta para o ambiente ao qual você está se conectando.
</Note>

<Card title="Guia de Chave de API" icon="key" href="/guias/chaves-de-api">
  Acesse o guia de Chave de API para obter instruções detalhadas sobre como gerar e utilizar sua chave de API para autenticação.
</Card>

## Formato da resposta

As respostas da API são retornadas no formato JSON. Cada resposta conterá um objeto com os seguintes campos:

```json theme={null}
{
  "success": true,
  "data": {
    // Dados da resposta
  },
  "isPgccErro": false,
  "mensagem": null
}
```


# Criar solicitação de consentimento ativo
Source: https://docs.autorize.com.br/api-reference/solicitacaoconsentimento/criar-solicitação-de-consentimento-ativo

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json post /api/solicitacao-consentimento/criar/ativo
Cria uma solicitação de consentimento com status ativo, onde o titular já respondeu ao consentimento.



# Criar solicitação de consentimento pendente
Source: https://docs.autorize.com.br/api-reference/solicitacaoconsentimento/criar-solicitação-de-consentimento-pendente

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json post /api/solicitacao-consentimento/criar/pendente
Cria uma solicitação de consentimento com status pendente, aguardando resposta do titular.



# Status dos serviços
Source: https://docs.autorize.com.br/api-reference/status-servico

Informações sobre o status atual das APIs do Autorize e possíveis interrupções de serviço.

<Card title="Status APIs" icon="link" href="https://status.autorize.com.br">
  Para verificar o status atual das APIs do Autorize e obter informações sobre possíveis interrupções de serviço.
</Card>

[![Autorize Indigo Hive](https://badge.uptimerobot.com/psp/0471f9c5ef2e31acff812ee604da838c.svg?style=text\&theme=dark)](https://status.autorize.com.br?utm_source=status_badge\&utm_medium=referral)


# Swagger
Source: https://docs.autorize.com.br/api-reference/swagger

Documentação da API gerada automaticamente a partir do OpenAPI

## Documentação da API

A seção **Endpoints** é gerada automaticamente a partir da especificação OpenAPI do Swagger.

Todos os endpoints disponíveis no Swagger UI estão refletidos nesta documentação, que oferece uma visualização aprimorada e otimizada da mesma especificação técnica. A funcionalidade e os dados apresentados são idênticos, apenas com uma interface diferenciada para melhor experiência de consulta.

<Info>
  A documentação sincroniza automaticamente com as alterações feitas no OpenAPI remoto, garantindo que qualquer atualização nos endpoints seja refletida imediatamente.
</Info>

### Links úteis

<CardGroup>
  <Card title="Swagger UI" icon="browser" href="https://public-usuario-api.autorize.com.br/swagger/index.html">
    Interface interativa do Swagger para testar os endpoints
  </Card>

  <Card title="OpenAPI (JSON)" icon="code" href="https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json">
    Especificação OpenAPI em formato JSON
  </Card>
</CardGroup>

### Sobre a especificação OpenAPI

A documentação desta API é baseada na especificação OpenAPI 3.0, que fornece:

* **Endpoints**: Todos os endpoints disponíveis na API
* **Parâmetros**: Detalhes sobre parâmetros de requisição
* **Schemas**: Modelos de dados e estruturas
* **Autenticação**: Métodos de autenticação suportados
* **Exemplos**: Exemplos de requisição e resposta


# Criar URL de webhook
Source: https://docs.autorize.com.br/api-reference/webhookurls/criar-url-de-webhook

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json post /api/webhook-urls
Cadastra uma nova URL de webhook para a empresa dona da chave de API informada.



# Listar URLs de webhook
Source: https://docs.autorize.com.br/api-reference/webhookurls/listar-urls-de-webhook

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json get /api/webhook-urls
Lista as URLs de webhook ativas da empresa dona da chave de API informada.



# Remover URL de webhook
Source: https://docs.autorize.com.br/api-reference/webhookurls/remover-url-de-webhook

https://public-usuario-api.autorize.com.br/swagger/v1/swagger.json delete /api/webhook-urls/{webhookUrlId}
Remove (soft delete) uma URL de webhook da empresa dona da chave de API informada.



# Acessos
Source: https://docs.autorize.com.br/guias/acessos

Informações sobre gestão de acessos no Autorize

O Autorize possui três tipos de acesso que podem ser atribuídos a um usuário: **Leitor**, **Editor** e **Admin**. Cada tipo define o nível de acesso que o usuário possui em cada módulo do sistema.

## Legenda

| Símbolo | Significado | Descrição |
| :-: | - | - |
| 🔒 | Sem acesso | O usuário não possui permissão para acessar o módulo. |
| 👁️ | Somente leitura | O usuário pode visualizar o módulo, mas não pode alterá-lo. |
| ✏️ | Leitura e escrita | O usuário pode visualizar e realizar alterações no módulo. |

### Operações

| Item | Leitor | Editor | Admin |
| - | :-: | :-: | :-: |
| Hash | 👁️ | ✏️ | ✏️ |
| Consentimento | 👁️ | ✏️ | ✏️ |

### Integração

| Item | Leitor | Editor | Admin |
| - | :-: | :-: | :-: |
| Chaves de API | 👁️ | ✏️ | ✏️ |
| Webhooks | 👁️ | ✏️ | ✏️ |
| Acessos | 👁️ | 👁️ | ✏️ |

### Administrativo

| Item | Leitor | Editor | Admin |
| - | :-: | :-: | :-: |
| Vínculos | 👁️ | 👁️ | ✏️ |
| Contratos | 🔒 | 🔒 | 👁️ |
| Faturamento | 🔒 | 🔒 | ✏️ |

<Note>
  Somente o tipo **Admin** possui acesso completo a todos os módulos, incluindo áreas restritas como Contratos e Faturamento. O tipo **Editor** possui apenas leitura em Acessos e Vínculos, e o tipo **Leitor** possui apenas leitura nos demais módulos.
</Note>

***

## Como criar um acesso

Adicione um novo usuário à sua conta do Autorize, definindo seu tipo de acesso e garantindo que ele tenha as permissões adequadas para realizar suas tarefas.

<Steps>
  <Step title="Acesse a página de Acessos">
    Acesse a página de [Acessos](https://usuario.autorize.com.br/acessos) na plataforma de Usuário (Empresa) do Autorize.
  </Step>

  <Step title="Clique em Criar Acesso">
    Clique no botão "Criar Acesso" para iniciar o processo de criação.

    <Frame>
      <img alt="Botão para criar um acesso na plataforma Autorize" />
    </Frame>
  </Step>

  <Step title="Configure as informações do acesso">
    Adicione um nome, e-mail, e o tipo de acesso e clique em "Criar".

    <Frame>
      <img alt="Exemplo de formulário para criar um acesso" />
    </Frame>
  </Step>

  <Step title="Solicitar para o usuário definir senha">
    Após criar o acesso, o usuário receberá um e-mail com instruções para definir sua senha.

    <br />

    Caso o usuário não receba o e-mail, instrua-o a redefinir a senha através do botão "Esqueceu a senha?" disponível na página de [Login](https://usuario.autorize.com.br/login) na plataforma do Autorize.

    <Frame>
      <img alt="Exemplo de sucesso ao criar acesso" />
    </Frame>
  </Step>
</Steps>

***

## Como editar um acesso

Edite as informações de um acesso existente, atualizando seu nome, e-mail, e tipo de acesso conforme necessário.

<Steps>
  <Step title="Acesse a página de Acessos">
    Acesse a página de [Acessos](https://usuario.autorize.com.br/acessos) na plataforma de Usuário (Empresa) do Autorize.
  </Step>

  <Step title="Clique no botão de editar">
    Clique no botão "Editar" na linha do acesso desejado, localizado na coluna de ações, para iniciar o processo de edição.

    <Frame>
      <img alt="Botão para editar um acesso na plataforma Autorize" />
    </Frame>
  </Step>

  <Step title="Atualize as informações do acesso">
    Atualize o nome, e-mail, e o tipo de acesso conforme necessário e clique em "Salvar".

    <Frame>
      <img alt="Exemplo de formulário para atualizar um acesso" />
    </Frame>
  </Step>
</Steps>


# Chave de API
Source: https://docs.autorize.com.br/guias/chaves-de-api

Informações sobre como criar e utilizar a Chave de API no Autorize

<Note>
  A Chave de API é a credencial obrigatória para autenticação nas requisições da API de Usuário do Autorize. Todas as solicitações devem incluir a chave no cabeçalho `Api-Key` para serem processadas com sucesso.
</Note>

## Boas práticas de segurança

<Card>
  * Certifique-se de manter sua chave segura e não compartilhá-la publicamente.
  * Nunca exponha sua chave em repositórios de código, arquivos de configuração versionados ou logs.
  * Regenere ou revogue chaves que possam ter sido comprometidas imediatamente.
  * Utilize variáveis de ambiente ou gerenciadores de secrets para armazenar suas chaves.
  * Monitore o uso de suas chaves de API e revise os acessos regularmente.
</Card>

## Como criar uma chave de API

<Steps>
  <Step title="Acesse a página de Chaves de API">
    Acesse a página de [Chaves de API](https://usuario.autorize.com.br/chaves-de-api) na plataforma de Usuário (Empresa) do Autorize.
  </Step>

  <Step title="Clique em Criar Chave de API">
    Clique no botão "Criar Chave de API" para iniciar o processo de criação.

    <Frame>
      <img alt="Botão para criar uma nova chave de API na plataforma Autorize" />
    </Frame>
  </Step>

  <Step title="Nomeie a Chave de API">
    Adicione um nome para a chave, que servirá como identificador para facilitar a gestão das chaves criadas. Em seguida, clique em "Criar".

    <Frame>
      <img alt="Campo para nomear a chave de API na plataforma Autorize" />
    </Frame>
  </Step>

  <Step title="Copie o valor da Chave de API">
    Após criar a chave, ela será exibida na lista de chaves de API. Copie o valor da chave para utilizá-la nas requisições à API. **Por questões de segurança, o valor da chave só será exibido uma vez**. Certifique-se de copiá-lo e armazená-lo em um local seguro.

    <Frame>
      <img alt="Exemplo de uma chave de API gerada na plataforma Autorize" />
    </Frame>
  </Step>
</Steps>

## Utilização

Inclua sua Chave de API no header `Api-Key` de cada requisição para autenticar junto à API do Autorize. O header é obrigatório para o processamento bem-sucedido de todas as solicitações.

```http theme={null}
GET https://public-usuario-api.autorize.com.br/api/solicitacao-consentimento/criar/pendente HTTP/1.1
Host: api.autorize.com.br
Api-Key: sua-chave-aqui
```


# Fluxo da informação
Source: https://docs.autorize.com.br/guias/fluxo-da-informacao

Entenda como os dados fluem entre os diferentes componentes do sistema.

## Casos de uso com consentimento do titular

Fluxo para casos de uso que dependem do consentimento do titular, conforme estabelecido pela Portaria SENATRAN nº 139, que exige o consentimento prévio do titular para o acesso aos dados pessoais. Este fluxo garante que o titular tenha controle sobre seus dados e esteja ciente de como eles serão utilizados.

<Steps>
  <Step title="Usuário solicita consentimento ao titular">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          actor Usuario
          participant GCC as Autorize (GCC)
          participant PGCC as PGCC

          Usuario->>GCC: Solicita consentimento de acesso aos dados<br>a partir do CPF do titular<br>HTTP POST /api/solicitacao-consentimento/criar/pendente
          GCC->>PGCC: Registra solicitação de consentimento
          PGCC->>GCC: Solicitação registrada com sucesso
          GCC->>Usuario: Solicitação registrada com sucesso
      ```
    </Card>
  </Step>

  <Step title="Titular recebe solicitação e responde">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          actor Titular
          participant GCC as Autorize (GCC)
          participant PGCC as PGCC

          Titular ->> GCC: Acessa plataforma via gov.br <br> e visualiza solicitação de consentimento
          Titular ->> GCC: Responde à solicitação de consentimento
          alt Consentimento concedido
              GCC ->> PGCC: Registra consentimento concedido
              PGCC ->> GCC: Consentimento registrado com sucesso
              GCC ->> Titular: Confirmação de consentimento concedido
          end
      ```
    </Card>
  </Step>

  <Step title="Usuário recebe webhook com hash de consulta">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          participant PGCC as PGCC
          participant GCC as Autorize (GCC)
          actor Usuario

          PGCC->>GCC: Notifica resultado da solicitação de consentimento
          GCC->>GCC: Gera hash de consulta assinada
          GCC->>PGCC: Encaminha hash assinada para validação
          PGCC->>GCC: Retorna validação da hash
          GCC->>Usuario: Envia webhook <br>com hash de consulta gerada
      ```

      Verifique a seção de Webhooks para mais detalhes sobre como configurar e receber notificações de eventos, incluindo o hash de consulta gerado após a concessão do consentimento pelo titular.

      <Card title="Webhooks" icon="link" href="/guias/webhooks">
        Clique aqui para acessar a documentação dos Webhooks.
      </Card>
    </Card>
  </Step>

  <Step title="Usuário utiliza hash para realizar consultas">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          actor Usuario
          participant PGCC as PGCC
          participant SENATRAN as SENATRAN

          Usuario->>PGCC: Realiza consulta utilizando hash de consulta
          PGCC->>SENATRAN: Consulta dados
          SENATRAN->>PGCC: Retorna dados consultados
          PGCC ->> PGCC: Registra o tratamento dos <br>dados para o titular no PDC
          PGCC->>Usuario: Envia dados consultados
      ```

      Utiliza o hash de consulta para realizar consultas de dados de veículos, infrações e condutores diretamente das bases da Senatran.

      Após a consulta, a PGCC registra o tratamento dos dados para o titular no PDC, garantindo transparência e conformidade com a LGPD, mesmo nos casos onde o consentimento prévio não é exigido.

      Documentação da API PGCC disponível para usuários:
      [https://hom-pgcc.np.bsa.estaleiro.serpro.gov.br/manual/servicos\_usuarios/swagger\_pgcc\_consultas\_api/](https://hom-pgcc.np.bsa.estaleiro.serpro.gov.br/manual/servicos_usuarios/swagger_pgcc_consultas_api/)
    </Card>
  </Step>
</Steps>

## Casos de uso sem consentimento do titular

Fluxo para casos de uso que não dependem do consentimento do titular, conforme estabelecido pela Portaria SENATRAN nº 139, que prevê hipóteses de tratamento de dados pessoais sem a necessidade de consentimento prévio do titular. Este fluxo é aplicável em situações onde a lei permite o acesso aos dados sem o consentimento do titular, garantindo que os usuários possam realizar consultas diretamente, utilizando um hash de consulta gerado pela GCC.

<Steps>
  <Step title="Usuário solicita hash de consulta para GCC">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          actor Usuario
          participant GCC as Autorize (GCC)
          participant PGCC as PGCC

          Usuario->>GCC: Solicita hash de consulta<br>HTTP POST /api/hash-consulta
          GCC->>GCC: Gera hash de consulta assinada
          GCC->>PGCC: Encaminha hash assinada para validação
          PGCC->>GCC: Retorna validação da hash
          GCC->>Usuario: Envia hash de consulta
      ```
    </Card>
  </Step>

  <Step title="Usuário utiliza hash para realizar consultas">
    <Card>
      ```mermaid theme={null}
      sequenceDiagram
          actor Usuario
          participant PGCC as PGCC
          participant SENATRAN as SENATRAN

          Usuario->>PGCC: Realiza consulta utilizando hash de consulta
          PGCC->>SENATRAN: Consulta dados
          SENATRAN->>PGCC: Retorna dados consultados
          PGCC ->> PGCC: Registra o tratamento dos <br>dados para o titular no PDC
          PGCC->>Usuario: Envia dados consultados
      ```

      Utiliza o hash de consulta para realizar consultas de dados de veículos, infrações e condutores diretamente das bases da Senatran.

      Após a consulta, a PGCC registra o tratamento dos dados para o titular no PDC, garantindo transparência e conformidade com a LGPD, mesmo nos casos onde o consentimento prévio não é exigido.

      Documentação da API PGCC disponível para usuários:
      [https://hom-pgcc.np.bsa.estaleiro.serpro.gov.br/manual/servicos\_usuarios/swagger\_pgcc\_consultas\_api/](https://hom-pgcc.np.bsa.estaleiro.serpro.gov.br/manual/servicos_usuarios/swagger_pgcc_consultas_api/)
    </Card>
  </Step>
</Steps>


# Glossário
Source: https://docs.autorize.com.br/guias/glossário

Termos e definições utilizados na documentação do Autorize

## Termos e Definições

| Termo | Descrição |
| - | - |
| Titular | Pessoa física (CPF) que terá os dados consultados |
| Usuário | Empresa, pessoa jurídica (CNPJ) que deseja consultar os dados do titular. O usuário é quem firma o contrato de prestação de serviços com a GCC |
| Anuente | Pessoa jurídica que possui uma relação comercial ou institucional com o Usuário. Ele utiliza os dados obtidos pelo usuário para empregá-los em seus próprios produtos e soluções |
| GCC | Gestora de Consentimento e Ciência. Autorize Indigo Hive. |
| Consentimento | Decisão ativa de autorizar ou não o uso dos dados para um fim específico. "Sim, concordo em compartilhar meus dados" |
| Ciência | Informação sobre o que está acontecendo com os dados do Titular, garantindo transparência. "Estou ciente dos dados que serão consultados" |
| Vínculo | Processo de víncular um Usuário na GCC, utilizando a plataforma Credencia. Após o vínculo, ele estará habilitado a consumir as APIs de solicitação de consentimento |
| Hash / Token | Token gerado pela GCC após titular consentir com a solicitação do usuário, ou quando caso de uso não necessita de consentimento do titular. Esse token será utilizado pelo Usuário para fazer as consultas nas APIs da PGCC |
| PGCC | Plataforma de Gestão de Consentimento e Ciência. Oferece serviços de consulta de dados dos cidadãos conforme os requisitos da Lei Geral de Proteção de Dados (LGPD), desenvolvido pelo SERPRO |
| PDC | Privacidade Digital do Cidadão |
| SERPRO | Empresa pública de tecnologia da informação do Brasil, vinculada ao Ministério da Fazenda |
| SENATRAN | Secretaria Nacional de Trânsito |
| Plataforma Credencia | Sistema desenvolvido pelo SERPRO para a Secretaria Nacional de Trânsito (SENATRAN), é a porta de entrada para a solicitação de serviços dentro do ecossistema de trânsito no Brasil |
| Portaria SENATRAN nº 139 | Portaria que estabelece os requisitos para a solicitação de serviços relacionados ao trânsito, incluindo a necessidade de consentimento do titular para o acesso aos dados pessoais |


# Vincular GCC
Source: https://docs.autorize.com.br/guias/vincular-gcc

Vincular Usuário a uma Gerenciadora de Consentimento e Ciência (GCC) para acesso aos dados da SENATRAN

## Guia de Credenciamento e Vinculação

Todos os tutoriais e o passo a passo para credenciamento e vinculação a uma GCC estão disponíveis na página:

<Card title="Tutoriais de Credenciamento" icon="link" href="https://autorize.com.br/credencia">
  Guias e tutoriais completos para credenciamento na plataforma Credencia e vinculação da sua empresa à Autorize.
</Card>


# Webhooks
Source: https://docs.autorize.com.br/guias/webhooks

Informações sobre como criar e utilizar Webhooks no Autorize

Receba notificações automáticas do Autorize sempre que algo importante acontecer.

## Como funciona

1. Você cria um endpoint no seu sistema <br /> Ex.: [https://meusite.com/webhooks/autorize](https://meusite.com/webhooks/autorize)
2. Você cadastra esse endpoint no dashboard do Autorize e configura quais eventos deseja receber.
3. Sempre que um evento ocorre, o Autorize:
   * Envia um POST para a sua URL
   * O POST contém o evento (ex Hash.Criado)
   * Seu sistema processa esse evento

***

## Segurança

Os webhooks precisam ser seguros — qualquer pessoa pode tentar enviar requisições falsas para sua aplicação.

Por isso, recomendamos as seguintes medidas de proteção:

1. **Secret na URL**
   Cada webhook possui uma chave secreta incluída na URL. Antes de processar o evento, seu sistema deve validar essa chave e confirmar que ela corresponde ao webhook cadastrado.

2. **Header com secret**
   O Autorize inclui uma assinatura no cabeçalho de cada evento enviado. Essa assinatura é gerada no momento de criação do webhook. Seu sistema deve validar essa assinatura antes de processar o evento.

> Importante: nunca confie apenas no IP da origem ou na URL pública. Sempre valide a assinatura do webhook antes de processar a mensagem.

***

## Como criar um webhook no Autorize

<Steps>
  <Step title="Acesse a página de Webhooks">
    Acesse a página de [Webhooks](https://usuario.autorize.com.br/webhooks) na plataforma de Usuário (Empresa) do Autorize.
  </Step>

  <Step title="Clique em Adicionar URL">
    Clique no botão "Adicionar URL" para iniciar o processo de criação.

    <Frame>
      <img alt="Botão para criar uma Webhooks na plataforma Autorize" />
    </Frame>
  </Step>

  <Step title="Configure as informações do Webhook">
    Adicione uma URL, e os eventos que deseja receber e clique em "Criar".

    <Frame>
      <img alt="Exemplo de configuração de URL e eventos para um Webhook" />
    </Frame>
  </Step>

  <Step title="Guarde o secret do Webhook">
    Após criar o webhook, será exibido um secret. Copie o valor do secret para utilizá-lo na validação das requisições recebidas. **Por questões de segurança, o valor do secret só será exibido uma vez**. Certifique-se de copiá-lo e armazená-lo em um local seguro.

    <Frame>
      <img alt="Exemplo de secret exibido após a criação de um Webhook" />
    </Frame>
  </Step>
</Steps>

***

## Eventos disponíveis

| Eventos | Enviado quando |
| - | - |
| HashCriado | Após a criação de um hash para o consentimento aceito pelo titular |

## Estrutura do evento

```json theme={null}
{
  "id": "6d2e4b2a-d44f-44b7-9f0e-c52c3e90ecde",
  "timestamp": "2026-08-12T15:46:12.2691978Z",
  "tipoEvento": "NOME_DO_EVENTO",
  "data": {
    ...
  }
}
```

***

## Retentativas

* Se o seu endpoint não responder com status `2xx` dentro do timeout, o Autorize tenta reenviar o evento automaticamente com backoff progressivo.
* A retentativa pode ocorrer quando:
  * a conexão excede o timeout;
  * o endpoint retorna status `5xx`;
  * o endpoint retorna status `4xx` diferente de `200`.
* Antes de reenviar, a plataforma aguarda um intervalo crescente para reduzir a carga em seu sistema e aumentar as chances de sucesso.

***

## Boas práticas de segurança

<Card>
  * Use **HTTPS** em todos os endpoints de webhook.
  * Valide o **secret** e a **assinatura do header** antes de processar qualquer evento.
  * Registre cada evento recebido e processe cada mensagem apenas uma vez.
  * Responda com **200 OK** somente depois que o processamento for concluído com sucesso.
  * Implemente retentativas com **idempotência** para evitar duplicações.
  * Evite validar o payload inteiro do webhook com schemas rígidos, para não quebrar o endpoint quando o contrato evoluir.
</Card>


# Bem-vindo à Autorize Indigo Hive
Source: https://docs.autorize.com.br/index

Documentação oficial da plataforma GCC — Gerenciamento de Consentimento e Ciência de Dados

<div>
  <img alt="Autorize Indigo Hive Logo" />

  <img alt="Autorize Indigo Hive Logo" />

  # Documentação - Autorize Indigo Hive

  <p>
    Guias, referências e tudo o que você precisa para começar
  </p>

  <div>
    <a href="/guias/fluxo-da-informacao">
      Começar agora →
    </a>

    <a href="/api-reference/index">
      Referência da API
    </a>
  </div>
</div>

***

<div>
  ## Gestora de Consentimento e Ciência

  <p>
    As Gerenciadoras de Consentimento e Ciência (GCC) são entidades fundamentais no novo modelo de tratamento de dados da Secretaria Nacional de Trânsito (SENATRAN). Abaixo, detalho o que são, seus objetivos e funcionamento, com base nos documentos do processo de credenciamento.
  </p>

  <p>
    As GCCs são pessoas jurídicas de direito público ou privado credenciadas pelo Ministério dos Transportes para atuar como operadoras responsáveis pela gestão do consentimento e pela ciência do uso de dados. Elas funcionam como intermediárias técnicas que garantem que o titular dos dados (o cidadão) tenha controle e conhecimento sobre como suas informações nos sistemas da SENATRAN estão sendo acessadas por terceiros.
  </p>

  ## Objetivo das GCCs

  <p>
    O objetivo principal é a prestação de serviços relacionados ao gerenciamento de consentimento e ciência dos titulares no âmbito do tratamento de dados dos sistemas e subsistemas informatizados da SENATRAN. Elas devem assegurar que:
  </p>

  <Card>
    * Garante que o cidadão autorize o acesso aos seus dados de forma explícita e rastreável.
    * O titular receba ciência clara sobre todas as hipóteses de tratamento de seus dados.
    * Haja conformidade estrita com a Lei Geral de Proteção de Dados (LGPD).
  </Card>

  ## Comece por aqui

  <CardGroup>
    <Card title="Fluxo da Informação" icon="diagram-project" href="/guias/fluxo-da-informacao">
      Entenda como os dados trafegam entre titulares, usuários e a SENATRAN.
    </Card>

    <Card title="Vincular GCC" icon="link" href="/guias/vincular-gcc">
      Aprenda como vincular sua organização com a GCC Autorize.
    </Card>

    <Card title="Chaves de API" icon="key" href="/guias/chaves-de-api">
      Configure Chaves de API para consumir a API da Autorize.
    </Card>

    <Card title="Glossário" icon="book-open" href="/guias/glossário">
      Termos e conceitos essenciais do ecossistema GCC e da SENATRAN.
    </Card>
  </CardGroup>

  ## Referência da API

  <CardGroup>
    <Card title="Visão Geral" icon="circle-info" href="/api-reference">
      Informações gerais sobre autenticação, estrutura das requisições e respostas.
    </Card>

    <Card title="Swagger / OpenAPI" icon="code" href="/api-reference/swagger">
      Explore e teste todos os endpoints disponíveis na interface interativa.
    </Card>
  </CardGroup>

  ## Edital de Credenciamento

  <p>
    Para mais informações sobre o processo de credenciamento, consulte o edital oficial disponível no link abaixo:
  </p>

  <Card title="Edital de Credenciamento" icon="file-alt" href="https://www.gov.br/transportes/pt-br/acesso-a-informacao/licitacoes-e-contratos/credenciamentos">
    Acesse o edital oficial para detalhes sobre requisitos e procedimentos.
  </Card>
</div>