Connectors
Listar Conectores
Lista todos os conectores disponíveis para conexão com instituições financeiras. Permite filtrar por nome da instituição.
Endpoint
Método e URL:
GET /v1/connectorsParâmetros de Query (opcionais):
q(string): Filtro de busca por nome da instituição (busca parcial, case-insensitive)
Campos da Resposta
data: Array contendo os conectores disponíveisid: Identificador único do conector (UUID)name: Nome da instituição financeiratype: Tipo do conector (ex: PERSONAL_BANK, BUSINESS_BANK, INVESTMENT)imageUrl: URL da logo da instituiçãoprimaryColor: Cor primária da marca da instituiçãoinstitutionUrl: URL oficial da instituiçãocountry: Código do país (ex: "BR")rules: Regras específicas do conectorproducts: Produtos disponíveis através deste conector
Exemplos de Uso
Listar todos os conectores
Requisição:
GET /v1/connectorsBuscar conectores por nome
Requisição:
GET /v1/connectors?q=itauResposta
Resposta de sucesso (200):
{
"status": "success",
"data": [
{
"id": "uuidv7",
"name": "Itaú",
"type": "PERSONAL_BANK",
"imageUrl": "https://www.itau.com.br/assets/dam/publisher/07_itau_empresas/13_open_banking/logos_regulatorio_bacen/opb_log_reg_bac_itau_img_01.svg",
"primaryColor": "EC7000",
"institutionUrl": "https://www.itau.com.br/assets/dam/publisher/07_itau_empresas/13_open_banking/logos_regulatorio_bacen/opb_log_reg_bac_itau_img_01.svg",
"country": "BR",
"rules": [
{
"type": "number",
"field": "cpf",
"label": "CPF",
"required": true,
"validation": {
"regex": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
"errorMessage": "CPF deve ter 11 números."
}
}
],
"products": [
"ACCOUNTS",
"TRANSACTIONS",
"IDENTITY",
"CREDIT_CARDS",
"PAYMENT_DATA",
"LOANS",
"INVESTMENTS"
]
}
]
}Notas
- Use este endpoint para descobrir quais instituições estão disponíveis
- O parâmetro
qrealiza busca parcial e não diferencia maiúsculas/minúsculas - O campo
rulescontém informações específicas sobre requisitos da instituição - O array
productsindica quais tipos de dados podem ser obtidos através desta conexão