Skip to main content
POST
Register an institution

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json

JSON request payload.

cnpj
string
required

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

Example:

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

name
string
required

Name of the institution.

Example:

"Banco Exemplo S.A."

scope
object
required

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

Response

Created

cnpj
string
required

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

Example:

"12ABC34501DE35"

createdAt
string<date-time>
required

Creation timestamp in UTC.

Example:

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

id
string
required

Unique institution identifier.

Example:

"00000000-0000-0000-0000-000000000000"

name
string
required

Name of the institution.

Example:

"Banco Exemplo S.A."

scope
object
required

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

updatedAt
string<date-time>
required

Most recent update timestamp in UTC.

Example:

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

version
integer<int64>
required

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

Example:

1