GET
Consulta um conector pelo id

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
integer
required

Id inteiro do conector.

Response

Conector encontrado.

Integração com uma instituição financeira específica. Declara credenciais necessárias, produtos suportados e saúde.

​
id
integer
required

Id estável para este conector. Trate como opaco e descubra em GET /connectors; somente 0–99 é reservado aos mocks locais.

Example:

612

​
name
string
required

Nome de exibição da instituição.

Example:

"Nubank"

​
institutionUrl
string<uri>
required

Site da instituição.

Example:

"https://nubank.com.br"

​
imageUrl
string<uri>
required

Logo (SVG/PNG) servido via CDN.

Example:

"https://malvo.io/connectors/nubank.svg"

​
primaryColor
string
required

Cor hexadecimal SEM prefixo #.

Example:

"820AD1"

​
country
string
required

ISO-3166-1 alpha-2.

Example:

"BR"

​
type
enum<string>
required

Tipo do conector.

Available options:
PERSONAL_BANK,
BUSINESS_BANK,
INVESTMENT,
OTHER
Example:

"PERSONAL_BANK"

​
credentials
object[]
required

Descritores de entrada antes do redirect. No Brasil normalmente CPF/CNPJ; no fluxo internacional geralmente é [], mas pode conter o select authMethod quando uma jornada precisa ou pode ser selecionada via API. Nunca contém senha bancária.

​
products
enum<string>[]
required

Produtos anunciados por este conector. O Open Banking internacional anuncia ACCOUNTS e TRANSACTIONS.

Produto de dados coletável. Valores exatos e case-sensitive.

Available options:
ACCOUNTS,
TRANSACTIONS,
CREDIT_CARDS,
INVESTMENTS,
INVESTMENTS_TRANSACTIONS,
LOANS,
IDENTITY,
OPPORTUNITIES,
PORTFOLIO,
INCOME_REPORTS
Example:
​
isOpenFinance
boolean
required

true = conector regulado de Open Finance Brasil ou Open Banking/AIS.

Example:

true

​
isSandbox
boolean
required

true = conector de teste local ou do ambiente sandbox do provedor.

Example:

false

​
oauth
boolean
required

true = conexão exige redirect OAuth para a instituição.

Example:

true

​
oauthUrl
string | null
required

URL efêmera de autorização no contexto de criação/reconsentimento do Item; normalmente null no catálogo.

Example:

null

​
hasMFA
boolean
required

true = conector pode emitir um desafio de MFA (conectores diretos).

Example:

false

​
supportsPaymentInitiation
boolean
required

Sempre false na Malvo (mantido por compatibilidade de wire).

Example:

false

​
health
object
required

Saúde operacional do conector.

Example:
​
createdAt
string<date-time>
required

Timestamp ISO-8601 de criação do registro do conector.

Example:

"2024-06-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp ISO-8601 da última atualização do registro do conector.

Example:

"2025-01-01T00:00:00.000Z"