Connectors
Buscar Conector
Retorna os detalhes completos de um conector específico, incluindo todas as informações necessárias para criar uma conexão.
Endpoint
Método e URL:
GET /v1/connectors/:idParâmetros da URL:
id(string, obrigatório): Identificador único do conector
Campos da Resposta
Retorna todos os dados do conector, incluindo:
id: Identificador único do conectorname: Nome da instituição financeiratype: Tipo do conectorimageUrl: URL da logo da instituiçãoprimaryColor: Cor primária da marcainstitutionUrl: URL oficial da instituiçãocountry: Código do paísrules: Regras e configurações específicasproducts: Produtos e serviços disponíveiscreatedAt: Data de criaçãoupdatedAt: Data da última atualização
Exemplo de Uso
Requisição:
GET /v1/connectors/01985c42-340d-74d4-a08f-6771f4bcb453Resposta
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"
]
}
}Resposta de erro (404):
{
"status": "error",
"message": "Connector not found"
}Notas
- Use este endpoint para obter detalhes completos antes de criar uma conexão
- As
rulescontêm informações importantes sobre os requisitos de autenticação - Verifique o array
productspara saber quais dados podem ser acessados