Criar Item

Inicia uma nova conexão com uma instituição financeira. Este é o primeiro passo para acessar dados bancários de um usuário.

Endpoint

Método e URL:

POST /v1/items

Content-Type: application/json

Parâmetros do Body

• connectorId (string, obrigatório): ID do conector da instituição financeira (UUID v7)
• parameters (object, obrigatório): Credenciais e parâmetros específicos da instituição
• Utilize os campos encontrados no campo "rules" de um connector.

Campos da Resposta

• status: Status da operação ("success")
• data: Dados do item criado
• id: Identificador único do item criado (UUID)

Exemplo de Uso

Requisição:

POST /v1/items
Content-Type: application/json

{
  "connectorId": "01985c42-340d-74d4-a08f-6771f4bcb453",
  "parameters": {
    "cpf": "123.456.789-01",
    "cnpj": "000-000-000/0000-00"
  }
}

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {
    "id": "01985c42-1234-5678-9abc-def123456789"
  }
}

Resposta de erro (400):

{
  "status": "error",
  "message": "Invalid connector ID or parameters"
}

Fluxo de Conexão

Após criar um item:

1. Item criado: O item é criado com status pending
2. Processamento: O sistema tenta estabelecer conexão com a instituição
3. Autenticação: Pode requerer autenticação adicional (OAuth, MFA)
4. Status atualizado: O item pode mudar para synced, auth_error, ou permanecer pending

Próximos Passos

Após criar o item:

1. Use o endpoint Buscar Item para acompanhar o status da conexão
2. Se necessário, siga o fluxo de autenticação OAuth fornecido na resposta
3. Uma vez conectado, você pode acessar os dados bancários através dos endpoints específicos

Notas Importantes

• Os parâmetros variam conforme a instituição - consulte a documentação do conector específico
• Monitore o status do item após a criação para acompanhar o progresso da conexão