API · Manage · Entities
Install compliance routines.
Install recurring compliance routines on an existing entity. Most callers do not need this — the formation packet installs routines automatically by default. See createFormationPacket.routine_install_policy. Use this endpoint for entities formed elsewhere (passthrough, third-party formed) or to re-install after a token-scope change.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
orchestratorstringRequiredWhich scheduled-task surface to register against.
claude_scheduled_tasks is the canonical "Matter as Claude
routine" path. generic_webhook schedules HTTP POSTs to a
caller-owned URL on the same cadence. none returns the
routine specifications as data without registering them
anywhere — useful for previewing, integration tests, or
custom orchestrators.
"claude_scheduled_tasks""generic_webhook""none"obligationsarray<string>OptionalSubset of obligation kinds to register. Defaults to all
obligations currently on the entity's Compliance view
plus the §83(b) one-shot if the entity has one in
pending_signature state.
channelstringOptionalWhere the routine writes its action card or success confirmation.
"default_email_to_founder""webhook""both"token_scopestringOptionalMatter binds each routine to a scoped token at install
time. tier_2_action_card surfaces an "approve to file"
card; tier_3_autofile files automatically and webhooks
the founder; tier_4_autonomous adds bookkeeping +
payment from the entity's funded balance.
"tier_2_action_card""tier_3_autofile""tier_4_autonomous"webhook_urlstring<uri>OptionalRequired when orchestrator: generic_webhook or channel: webhook.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/entities/{id}/compliance/routines" \ -H "Content-Type: application/json" \ -d '{ "orchestrator": "claude_scheduled_tasks" }'const body = JSON.stringify({ "orchestrator": "claude_scheduled_tasks"})fetch("https://api.mattermode.com/v1/entities/{id}/compliance/routines", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/entities/{id}/compliance/routines" body := strings.NewReader(`{ "orchestrator": "claude_scheduled_tasks" }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "orchestrator": "claude_scheduled_tasks"}resp = requests.post( "https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/compliance/routines", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "orchestrator": "claude_scheduled_tasks"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/entities/{id}/compliance/routines")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "orchestrator": "claude_scheduled_tasks"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/entities/{id}/compliance/routines", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/compliance/routines' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "orchestrator": "claude_scheduled_tasks"}'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/compliance/routines", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "orchestrator": "claude_scheduled_tasks" }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"object": "compliance_routine_installation",
"entity_id": "string",
"installed_at": 0,
"orchestrator": "string",
"routines": [
{
"id": "string",
"obligation_kind": "string",
"schedule": "string",
"token_id": "string",
"status": "active",
"next_run_at": 0
}
]
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/scope_denied",
"title": "Scope denied",
"status": 403,
"code": "scope_denied",
"detail": "Token tok_8FbWcEoP9 has no grant on entity ent_Nq3KcAbc.",
"doc_url": "https://mattermode.com/docs/guides/errors#scope_denied",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}{
"title": "Invalid state transition",
"status": 409,
"detail": "Entity ent_Nq3KcAbc is in state `dissolved` and cannot be dissolved again.",
"instance": "/requests/req_Qw9xYz8A",
"code": "invalid_state_transition",
"param": "founders[0].equity",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"retry_after": 30,
"authorized_by": {
"human_principal_id": "usr_4Kj2m8pQ",
"agent_id": "agt_Nq3KcAbc"
},
"type": "https://errors.mattermode.com/terms_acceptance_required",
"terms_version": "string",
"terms_summary": "string",
"terms_url": "http://example.com"
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}