> For the complete documentation index, see [llms.txt](https://docs.vaultid.com.br/workspace/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vaultid.com.br/workspace/wings/integracao-e-requisitos-para-utilizacao.md).

# Integração e requisitos para utilização

**A integração exige:**&#x20;

* Acesso de rede ao ambiente Billing correspondente.&#x20;
* Credenciais compatíveis com o tipo de operação.&#x20;
* Token de acesso válido para realizar operações protegidas.&#x20;
* Permissões adequadas para as funcionalidades que serão utilizadas.&#x20;

Para autenticação de usuários, é necessário utilizar **CPF e OTP obtido no aplicativo BirdID.**&#x20;

Para aplicações externas, são necessárias as credenciais **client\_id e client\_secret**.&#x20;

Nas operações corporativas, a aplicação deve considerar o contexto da corporação selecionada e tratar os resultados paginados das consultas.&#x20;

Nas operações de varejo, a aplicação externa precisa estar autorizada para acessar as funcionalidades disponibilizadas.&#x20;

**Segurança**&#x20;

O acesso às operações é controlado por mecanismos de autenticação e autorização, considerando as credenciais, os tokens de acesso, o contexto corporativo e as permissões atribuídas ao usuário ou à aplicação.&#x20;

**As respostas de erro podem contemplar situações como:**&#x20;

* Falhas de autenticação.&#x20;
* Credenciais de cliente inválidas.&#x20;
* Usuário inexistente.&#x20;
* Tipo de usuário inválido.&#x20;

As diretrizes específicas sobre TLS mínimo, criptografia em repouso, armazenamento e rotação de segredos, trilhas de auditoria, retenção de dados e certificações de segurança devem ser complementadas conforme a documentação técnica oficial.&#x20;

**Restrições e limitações**&#x20;

* O tempo de vida solicitado para o token de autenticação de usuário não pode ultrapassar sete dias.&#x20;
* A consulta de usuários de varejo por corporação permite, no máximo, 500 registros por página.&#x20;
* A alteração do tipo de usuário de varejo aceita somente os tipos normal e trial.&#x20;
* Usuários inexistentes e tipos inválidos são tratados como erros pelas operações correspondentes.
