Skip to main content
GET
Get one activated document

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

subscriptionId
string
requerido

Unique subscription identifier.

Respuesta

OK

adoptedVersion
string
requerido

Version of the document this tenant generates against

Ejemplo:

"1.0.0"

adoptionHistory
object[] | null
requerido

Append-only record of which version was adopted, by whom and when

bindingVersion
integer<int64>
requerido

Version of the mapping in force, the one its ETag carries; 0 when none was written

Ejemplo:

3

createdAt
string<date-time>
requerido

Creation timestamp in UTC

Ejemplo:

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

documentId
string
requerido

Curated document this subscription files

Ejemplo:

"br.bcb.cadoc-4010"

id
string
requerido

Unique subscription identifier

Ejemplo:

"00000000-0000-0000-0000-000000000000"

status
string
requerido

active or inactive

Ejemplo:

"active"

updatedAt
string<date-time>
requerido

Most recent update timestamp in UTC

Ejemplo:

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

version
integer<int64>
requerido

Version of the subscription; setting its institution presents it as If-Match. 0 on a subscription never written since versions were counted.

Ejemplo:

1

deactivatedAt
string<date-time>

When the subscription was last deactivated, in UTC; absent if never

Ejemplo:

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

deactivatedBy
string

Authenticated subject that last deactivated it; absent if never, or if that request identified nobody

Ejemplo:

"acme/00000000-0000-0000-0000-000000000000"

institutionId
string

Institution that files the document. Absent on a subscription made before filings named an institution: it generates for the tenant's only institution, and with none or several it waits until one is set.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

reactivatedAt
string<date-time>

When the subscription was last reactivated, in UTC; absent if never

Ejemplo:

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

reactivatedBy
string

Authenticated subject that last reactivated it; absent if never

Ejemplo:

"acme/00000000-0000-0000-0000-000000000000"