Skip to main content
GET
Get an institution

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

institutionId
string
requerido

Unique institution identifier.

Respuesta

OK

cnpj
string
requerido

CNPJ of the institution, uppercase and without punctuation; numeric or alphanumeric.

Ejemplo:

"12ABC34501DE35"

createdAt
string<date-time>
requerido

Creation timestamp in UTC.

Ejemplo:

"2026-01-01T00:00:00Z"

id
string
requerido

Unique institution identifier.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

name
string
requerido

Name of the institution.

Ejemplo:

"Banco Exemplo S.A."

scope
object
requerido

The rows of each data source that belong to this institution.

updatedAt
string<date-time>
requerido

Most recent update timestamp in UTC.

Ejemplo:

"2026-01-01T00:00:00Z"

version
integer<int64>
requerido

Version of the institution; an update presents it as If-Match.

Ejemplo:

1