Check regulatory changes

GET

/api/v1/compliance/changes

const url = 'https://api.ultimateteam.ai/api/v1/compliance/changes';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

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://api.ultimateteam.ai/api/v1/compliance/changes \
  --header 'X-API-Key: <X-API-Key>'

Check for new regulatory changes affecting the tenant.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

RegulatoryChangesEnvelope

Typed envelope for GET /changes.

object

data

required

RegulatoryChangesResponse

Response body listing recent regulatory changes.

Attributes: changes: List of regulatory changes affecting the tenant.

object

changes

Changes

Regulatory changes affecting the tenant

Array<object>

RegulatoryChangeItem

A newly detected regulatory change.

Attributes: id: Unique identifier for the change. title: Short headline for the change. effective_date: When the change takes effect. jurisdiction: Geographic jurisdiction. category: Compliance category. summary: Plain-language summary of the change. business_impact: How the change affects the business. action_required: What the business should do. source_url: Link to the official source.

object

action_required

Action Required

Required action

string

business_impact

required

Business Impact

Business impact

string

category

required

Category

Compliance category

string

effective_date

Any of:

string
null

string format: date

required

Change identifier

string

jurisdiction

Jurisdiction

Jurisdiction

string

source_url

Source Url

Official source URL

string

summary

required

Summary

Plain-language summary

string

title

required

Title

Short headline

string

meta

required

ResponseMeta

Standard metadata attached to every API response.

object

request_id

required

Request Id

Unique request identifier

string

timestamp

required

Timestamp

Server timestamp of the response

string format: date-time

Example

{
  "data": {
    "changes": [
      {
        "action_required": "",
        "jurisdiction": "",
        "source_url": ""
      }
    ]
  }
}