Get institution config by id

Returns the institution’s configuration as a safe metadata view. The institution is addressed by the path id.

GET /v1/institutions/{institutionId}

Get institution config by id

cURL

curl --request GET \
  --url https://api.example.com/v1/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>'

200

{
  "connectorType": "midaz",
  "createdAt": "2024-01-15T10:30:00Z",
  "enabled": true,
  "institutionCode": "12345678",
  "institutionId": "550e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2024-01-15T12:00:00Z",
  "accountFormat": "^[0-9]{1,12}$",
  "branchFormat": "^[0-9]{4}$",
  "connectionSource": "env",
  "connectorMetadata": {
    "blockableAccountTypes": [
      "deposit"
    ],
    "blockableBalances": [
      "default"
    ],
    "organizations": [
      {
        "ledgers": [
          "019fcd7c-1e18-7034-8cd3-9e39c1759e41"
        ],
        "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
      }
    ]
  },
  "connectorMetadataValid": false,
  "effectiveCrmMode": "legacy",
  "retryPolicyConfig": {
    "maxAttempts": 3
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

institutionId · string · requerido

The institution's unique identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

Respuesta

200

application/json

OK

connectorType · string · requerido

The outbound connector type for this institution.

Ejemplo:

"midaz"

createdAt · string · requerido

RFC 3339 creation timestamp (UTC).

Ejemplo:

"2024-01-15T10:30:00Z"

enabled · boolean · requerido

Whether the connector configuration is active.

Ejemplo:

true

institutionCode · string · requerido

The institution's BACEN CNPJ (8 digits) for return-file headers and file header validation.

Ejemplo:

"12345678"

institutionId · string · requerido

The institution's unique identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt · string · requerido

RFC 3339 last-update timestamp (UTC).

Ejemplo:

"2024-01-15T12:00:00Z"

accountFormat · string

The regular expression the institution declared for the account number of a court-indicated target; omitted when none is declared.

Ejemplo:

"^[0-9]{1,12}$"

branchFormat · string

The regular expression the institution declared for the branch (agência) number of a court-indicated target; omitted when none is declared.

Ejemplo:

"^[0-9]{4}$"

connectionSource · enum<string> · read-only

Where the Midaz connection comes from: env, the MIDAZ_* environment of the installation. Derived and read-only.

Opciones disponibles: env

Ejemplo:

"env"

connectorMetadata · any

Connector-specific configuration bag. The non-secret connector-owned keys (crmMode, organizations[], blockableBalances, blockableAccountTypes, salaryAccountTypes) are preserved verbatim. blockableBalances carries the LEDGER's balance-key values — for Midaz, balanceKey (default/overdraft/a client-registered key), not the available/onHold fields of a balance.

Ejemplo:

{
  "blockableAccountTypes": ["deposit"],
  "blockableBalances": ["default"],
  "organizations": [
    {
      "ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
      "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
    }
  ]
}

connectorMetadataValid · boolean · read-only

Present and false only when the stored connector metadata cannot be parsed by its connector; absent otherwise. The offending value is never echoed.

Ejemplo:

false

effectiveCrmMode · enum<string> · read-only

The CRM surface this institution resolves to (legacy|embedded): its own crmMode override when the connector metadata names one, the service-wide default otherwise. Derived and read-only; omitted when the connector metadata cannot be parsed.

Opciones disponibles: legacy, embedded

Ejemplo:

"legacy"

retryPolicyConfig · any

Operational retry policy (backoff/attempts) as arbitrary JSON.

Ejemplo:

{ "maxAttempts": 3 }