Set the institution that files a subscription
Names the institution that files the subscribed document, IF If-Match carries the subscription version the caller read: without it the request is refused with 428, and a stale version with 409 naming both. A subscription made before filings named an institution generates for the tenant’s only one and waits for this when the tenant has none or several. Refused with a conflict while another active subscription of the same document already files for that institution. Reports already generated keep the institution they froze.
Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Subscription version the caller read, from its ETag. Required.
Parámetros de ruta
Unique subscription identifier.
Cuerpo
Institution that files the document. Omitted, the tenant's only institution; "all" is refused.
"00000000-0000-0000-0000-000000000000"
Respuesta
OK
Version of the document this tenant generates against
"1.0.0"
Append-only record of which version was adopted, by whom and when
Version of the mapping in force, the one its ETag carries; 0 when none was written
3
Creation timestamp in UTC
"2026-01-01T00:00:00Z"
Curated document this subscription files
"br.bcb.cadoc-4010"
Unique subscription identifier
"00000000-0000-0000-0000-000000000000"
active or inactive
"active"
Most recent update timestamp in UTC
"2026-01-01T00:00:00Z"
Version of the subscription; setting its institution presents it as If-Match. 0 on a subscription never written since versions were counted.
1
When the subscription was last deactivated, in UTC; absent if never
"2026-01-01T00:00:00Z"
Authenticated subject that last deactivated it; absent if never, or if that request identified nobody
"acme/00000000-0000-0000-0000-000000000000"
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.
"00000000-0000-0000-0000-000000000000"
When the subscription was last reactivated, in UTC; absent if never
"2026-01-01T00:00:00Z"
Authenticated subject that last reactivated it; absent if never
"acme/00000000-0000-0000-0000-000000000000"

