Regulatory catalog

GET

/api/v1/regulatory-requirements

const url = 'https://example.com/api/v1/regulatory-requirements';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/regulatory-requirements \
  --cookie ttx_access_token=<ttx_access_token>

The regulatory frameworks and requirements catalog.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

RegulatoryCatalogResponse

object

frameworks

required

Frameworks

Array<object>

RegulatoryFrameworkRead

A framework a regulatory trigger can name; OTHER isn’t one (it’s implied, always offered last, with free text).

object

binding

required

Binding

boolean

required

string

jurisdiction

required

Jurisdiction

string

label_en

required

Label En

string

label_es

required

Label Es

string

name_en

required

Name En

string

name_es

required

Name Es

string

rationale_en

required

Rationale En

string

rationale_es

required

Rationale Es

string

rationale_reference

required

Rationale Reference

string

requires_exercises

required

Requires Exercises

boolean

scope_en

required

Scope En

string

scope_es

required

Scope Es

string

items

required

Items

Array<object>

RegulatoryRequirementRead

object

description_en

required

Description En

string

description_es

required

Description Es

string

framework

required

Framework

string

required

string

notifications

Notifications

Array<object>

default:

NotificationMilestoneRead

object

clock_en

required

Clock En

string

clock_es

required

Clock Es

string

deadline_en

required

Deadline En

string

deadline_es

required

Deadline Es

string

recipient_en

required

Recipient En

string

recipient_es

required

Recipient Es

string

stage_en

required

Stage En

string

stage_es

required

Stage Es

string

reference

required

Reference

string

Example

{
  "items": [
    {
      "notifications": []
    }
  ]
}