Itens

Documentação dos endpoints para gerenciamento de itens - conexões com instituições financeiras.

Endpoints Disponíveis

Criar Item - Inicia uma nova conexão com uma instituição financeira
Buscar Item - Retorna o status e detalhes de uma conexão específica
Ressincronizar Item - Força a ressincronização dos dados de uma conexão
Deletar Item - Remove uma conexão bancária existente

Como Iniciar uma Conexão

Para conectar-se a uma instituição financeira:

Descobrir conectores: Use o endpoint de listagem de conectores para encontrar a instituição desejada
Criar um item: Use o ID do conector para criar um novo item com as credenciais da instituição
Acompanhar o status: Monitore o status da conexão através do endpoint de busca de item
Autenticação OAuth: Se necessário, siga o fluxo de autenticação OAuth fornecido na resposta

Consentimentos

Uma conexão pode exigir a autorização de 1 ou mais titulares. O requerimento varia de acordo com a segurança da conta e relação com o banco.

O usuário que iniciar o consentimento não precisa confirmar novamente após o login
Os demais titulares precisarão confirmar em seus aplicativos
Não é necessário iniciar a criação de outro item para os demais titulares

Utilize o campo warnings para notificar seu usuário da necessidade de autorização adicional.

Status do Item

pending: Conexão em andamento
syncing: Sincronizando dados
synced: Sincronizado com sucesso
merging: Mesclando dados
out_of_sync: Dados desatualizados
auth_error: Erro de autenticação
waiting_user_input: Aguardando entrada do usuário (ex: OAuth)

Tipos de Aviso

CREDENTIALS: Problemas relacionados a credenciais
SECURITY: Alertas de segurança
MAINTENANCE: Manutenção da instituição
RATE_LIMIT: Limite de requisições atingido

Se o aviso for relacionado à conta, solicitando autorizações, é possível que essa conta precise de autorização de outro titular. Normalmente é necessária a permissão de todos os titulares.

Observações

Todos os IDs são UUIDs v7
URLs de autenticação OAuth têm prazo de validade limitado
Monitore o campo warnings para informações importantes sobre a conexão