Skip to main content
POST
Register an institution

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

JSON request payload.

cnpj
string
obrigatório

CNPJ of the institution, numeric or alphanumeric, with or without punctuation.

Exemplo:

"12.ABC.345/01DE-35"

name
string
obrigatório

Name of the institution.

Exemplo:

"Banco Exemplo S.A."

scope
object
obrigatório

The rows of each data source that belong to this institution, keyed by data source name. May be empty.

Resposta

Created

cnpj
string
obrigatório

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

Exemplo:

"12ABC34501DE35"

createdAt
string<date-time>
obrigatório

Creation timestamp in UTC.

Exemplo:

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

id
string
obrigatório

Unique institution identifier.

Exemplo:

"00000000-0000-0000-0000-000000000000"

name
string
obrigatório

Name of the institution.

Exemplo:

"Banco Exemplo S.A."

scope
object
obrigatório

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

updatedAt
string<date-time>
obrigatório

Most recent update timestamp in UTC.

Exemplo:

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

version
integer<int64>
obrigatório

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

Exemplo:

1