Reactivate a deactivated subscription

curl --request POST \
  --url http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "adoptedVersion": "1.0.0",
  "adoptionHistory": [
    {
      "adoptedAt": "2026-01-01T00:00:00Z",
      "adoptedBy": "operator@bank.example",
      "version": "1.1.0",
      "supersedes": "1.0.0"
    }
  ],
  "bindingVersion": 3,
  "createdAt": "2026-01-01T00:00:00Z",
  "documentId": "br.bcb.cadoc-4010",
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "active",
  "updatedAt": "2026-01-01T00:00:00Z",
  "version": 1,
  "deactivatedAt": "2026-01-01T00:00:00Z",
  "deactivatedBy": "acme/00000000-0000-0000-0000-000000000000",
  "institutionId": "00000000-0000-0000-0000-000000000000",
  "reactivatedAt": "2026-01-01T00:00:00Z",
  "reactivatedBy": "acme/00000000-0000-0000-0000-000000000000"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Reactivate a deactivated subscription

Switches a deactivated subscription back on, with the mapping the tenant edited and the version they adopted exactly as they were left — the way back that subscribing again is not, since that starts a new subscription from the catalog’s reference mapping. Records who reactivated it and when. Refused with a conflict while ANOTHER subscription of the same document is active: a document is filed by one subscription at a time, and the refusal names the one holding the slot. Reactivating a subscription that is already active answers it unchanged.

POST

regulatory

subscriptions

{subscriptionId}

reactivate

Reactivate a deactivated subscription

curl --request POST \
  --url http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4005/v1/regulatory/subscriptions/{subscriptionId}/reactivate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "adoptedVersion": "1.0.0",
  "adoptionHistory": [
    {
      "adoptedAt": "2026-01-01T00:00:00Z",
      "adoptedBy": "operator@bank.example",
      "version": "1.1.0",
      "supersedes": "1.0.0"
    }
  ],
  "bindingVersion": 3,
  "createdAt": "2026-01-01T00:00:00Z",
  "documentId": "br.bcb.cadoc-4010",
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "active",
  "updatedAt": "2026-01-01T00:00:00Z",
  "version": 1,
  "deactivatedAt": "2026-01-01T00:00:00Z",
  "deactivatedBy": "acme/00000000-0000-0000-0000-000000000000",
  "institutionId": "00000000-0000-0000-0000-000000000000",
  "reactivatedAt": "2026-01-01T00:00:00Z",
  "reactivatedBy": "acme/00000000-0000-0000-0000-000000000000"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

subscriptionId

string

required

Unique subscription identifier.

Response

adoptedVersion

string

required

Version of the document this tenant generates against

Example:

"1.0.0"

adoptionHistory

object[] | null

required

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

Show child attributes

bindingVersion

integer<int64>

required

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

Example:

3

createdAt

string<date-time>

required

Creation timestamp in UTC

Example:

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

documentId

string

required

Curated document this subscription files

Example:

"br.bcb.cadoc-4010"

string

required

Unique subscription identifier

Example:

"00000000-0000-0000-0000-000000000000"

status

string

required

active or inactive

Example:

"active"

updatedAt

string<date-time>

required

Most recent update timestamp in UTC

Example:

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

version

integer<int64>

required

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

Example:

1

deactivatedAt

string<date-time>

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

Example:

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

deactivatedBy

string

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

Example:

"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.

Example:

"00000000-0000-0000-0000-000000000000"

reactivatedAt

string<date-time>

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

Example:

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

reactivatedBy

string

Authenticated subject that last reactivated it; absent if never

Example:

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

Getting started

Templates API

Template Builder API

Reports API

Deadlines API

Data Sources API

Institutions API

Regulatory Catalog API

Regulatory Subscriptions API

Regulatory Bindings API

Regulatory Reports API

Metrics API

Streaming API

Error handling

Events

Reactivate a deactivated subscription

Authorizations

Path Parameters

Response