curl --request POST \
--url https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company \
--header 'Content-Type: application/json' \
--header 'X-WorldMonitor-Key: <api-key>' \
--data '
{
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"patch": {
"addClaims": [
{
"type": "COMPANY_CLAIM_TYPE_ALIAS",
"value": "example"
}
],
"customerReference": "example",
"domicileCountry": "DOMICILE_COUNTRY_US",
"name": "WorldMonitor Analyst",
"removeClaimIds": [
"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV"
]
}
}
'import requests
url = "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company"
payload = {
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"patch": {
"addClaims": [
{
"type": "COMPANY_CLAIM_TYPE_ALIAS",
"value": "example"
}
],
"customerReference": "example",
"domicileCountry": "DOMICILE_COUNTRY_US",
"name": "WorldMonitor Analyst",
"removeClaimIds": ["cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV"]
}
}
headers = {
"X-WorldMonitor-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-WorldMonitor-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: 'cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV',
patch: {
addClaims: [{type: 'COMPANY_CLAIM_TYPE_ALIAS', value: 'example'}],
customerReference: 'example',
domicileCountry: 'DOMICILE_COUNTRY_US',
name: 'WorldMonitor Analyst',
removeClaimIds: ['cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV']
}
})
};
fetch('https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV',
'patch' => [
'addClaims' => [
[
'type' => 'COMPANY_CLAIM_TYPE_ALIAS',
'value' => 'example'
]
],
'customerReference' => 'example',
'domicileCountry' => 'DOMICILE_COUNTRY_US',
'name' => 'WorldMonitor Analyst',
'removeClaimIds' => [
'cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-WorldMonitor-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company"
payload := strings.NewReader("{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-WorldMonitor-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company")
.header("X-WorldMonitor-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"company": {
"canonicalUrl": "https://example.com/worldmonitor",
"claims": [
{
"allowedUses": [
"COMPANY_CLAIM_ALLOWED_USE_DISCOVERY"
],
"claimId": "cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"expiresAt": "2026-01-15T12:00:00Z",
"provenance": "example",
"trustState": "COMPANY_CLAIM_TRUST_STATE_DECLARED"
}
],
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"coverage": "COMPANY_COVERAGE_STATE_AWAITING_FIRST_SCAN",
"createdAt": "2026-01-15T12:00:00Z"
}
}{
"violations": [
{
"field": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"code": "subscription_lapsed",
"requiredTier": 123,
"currentTier": 123,
"planKey": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"requiredTier": 123
}{
"message": "<string>"
}UpdateMonitoredCompany
Applies a bounded patch to an account-scoped monitored-company record. Requires company_monitoring:write; runtime remains disabled until dependency #6003 passes.
curl --request POST \
--url https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company \
--header 'Content-Type: application/json' \
--header 'X-WorldMonitor-Key: <api-key>' \
--data '
{
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"patch": {
"addClaims": [
{
"type": "COMPANY_CLAIM_TYPE_ALIAS",
"value": "example"
}
],
"customerReference": "example",
"domicileCountry": "DOMICILE_COUNTRY_US",
"name": "WorldMonitor Analyst",
"removeClaimIds": [
"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV"
]
}
}
'import requests
url = "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company"
payload = {
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"patch": {
"addClaims": [
{
"type": "COMPANY_CLAIM_TYPE_ALIAS",
"value": "example"
}
],
"customerReference": "example",
"domicileCountry": "DOMICILE_COUNTRY_US",
"name": "WorldMonitor Analyst",
"removeClaimIds": ["cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV"]
}
}
headers = {
"X-WorldMonitor-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-WorldMonitor-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: 'cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV',
patch: {
addClaims: [{type: 'COMPANY_CLAIM_TYPE_ALIAS', value: 'example'}],
customerReference: 'example',
domicileCountry: 'DOMICILE_COUNTRY_US',
name: 'WorldMonitor Analyst',
removeClaimIds: ['cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV']
}
})
};
fetch('https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV',
'patch' => [
'addClaims' => [
[
'type' => 'COMPANY_CLAIM_TYPE_ALIAS',
'value' => 'example'
]
],
'customerReference' => 'example',
'domicileCountry' => 'DOMICILE_COUNTRY_US',
'name' => 'WorldMonitor Analyst',
'removeClaimIds' => [
'cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-WorldMonitor-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company"
payload := strings.NewReader("{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-WorldMonitor-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company")
.header("X-WorldMonitor-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.worldmonitor.app/api/company-monitoring/v1/update-monitored-company")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"patch\": {\n \"addClaims\": [\n {\n \"type\": \"COMPANY_CLAIM_TYPE_ALIAS\",\n \"value\": \"example\"\n }\n ],\n \"customerReference\": \"example\",\n \"domicileCountry\": \"DOMICILE_COUNTRY_US\",\n \"name\": \"WorldMonitor Analyst\",\n \"removeClaimIds\": [\n \"cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"company": {
"canonicalUrl": "https://example.com/worldmonitor",
"claims": [
{
"allowedUses": [
"COMPANY_CLAIM_ALLOWED_USE_DISCOVERY"
],
"claimId": "cm_claim_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"expiresAt": "2026-01-15T12:00:00Z",
"provenance": "example",
"trustState": "COMPANY_CLAIM_TRUST_STATE_DECLARED"
}
],
"companyId": "cm_company_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"coverage": "COMPANY_COVERAGE_STATE_AWAITING_FIRST_SCAN",
"createdAt": "2026-01-15T12:00:00Z"
}
}{
"violations": [
{
"field": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"code": "subscription_lapsed",
"requiredTier": 123,
"currentTier": 123,
"planKey": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"requiredTier": 123
}{
"message": "<string>"
}Authorizations
User-issued WorldMonitor API key.
Headers
Optional client-generated idempotency key. Retrying a POST with the same key and an identical request body replays the original response (only the status, body, and Content-Type are reproduced) instead of re-executing; reusing the key with a different body is rejected with 422. For mutations this avoids duplicating the side effect, while for batch-read POSTs it replays a cached snapshot that can be up to 24 hours stale. Keys are scoped per authenticated caller (falling back to the source IP for unauthenticated endpoints) and retained for 24 hours.
1 - 255^[\x21-\x7E]{1,255}$Body
Response
Successful response
MonitoredCompany is a compact account-scoped portfolio row.
Show child attributes
Show child attributes
Was this page helpful?
