API · Exit · Entities
Start creditor claims window.
Open a new statutory creditor-notice window for the entity under DGCL §281 (default 60-day) or §280 (long-form) procedure. Sends notice_of_dissolution Documents to the supplied known creditors and orders newspaper publication when publish: true. The dissolve cascade requires an open or closed window before the Certificate of Dissolution can file when procedure = default_281 or procedure = long_form_280.
Returns 202 with the new ccw_* resource. Errors with 409 window_already_open if a window is already running for the entity.
Last updated
Query Parameters
dry_runbooleanOptionalIf true, simulate the mutation and return the would-be resource, any cascaded
resources, and a fee estimate — without side effects. Available on every mutation.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
procedurestringRequired"default_281""long_form_280"statutory_window_daysintegerOptionalOverride the procedure's default. Most callers omit.
known_creditorsarray<object>Optionalrecipient_idstringOptionalrecipient_namestringRequirednotice_channelstringRequired"certified_mail""registered_mail""email_with_receipt""in_person""newspaper_publication_only"addressobjectOptionalStructured address.
line1stringRequiredline2stringOptionalcitystringRequiredcountystringOptionalCounty, parish, or borough. Optional for most addresses but required
in the registered-agent block of certain state filings (DE Certificate
of Incorporation per 8 Del. C. §131; analogous fields in NY and MD,
parishes in LA). When omitted, the recommendation engine derives the
county from line1 + region against the @repo/jurisdictions data
— populated automatically for Matter-provided registered agents.
regionstringRequiredState, province, or region code (e.g. DE, CA, NY).
postal_codestringRequiredcountrystringRequiredISO 3166-1 alpha-2.
publishbooleanOptionalOrder newspaper publication of the
notice_of_dissolution. Required for long_form_280;
optional for default_281 (belt-and-braces).
publication_jurisdictionstringOptionalTwo-letter state code. Defaults to the entity's home state.
Response Body
application/json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/entities/{id}/creditor_claims_window/start" \ -H "Content-Type: application/json" \ -d '{ "procedure": "default_281" }'const body = JSON.stringify({ "procedure": "default_281"})fetch("https://api.mattermode.com/v1/entities/{id}/creditor_claims_window/start", { 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}/creditor_claims_window/start" body := strings.NewReader(`{ "procedure": "default_281" }`) 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 = { "procedure": "default_281"}resp = requests.post( "https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/creditor_claims_window/start", 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("""{ "procedure": "default_281"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/entities/{id}/creditor_claims_window/start")) .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("""{ "procedure": "default_281"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/entities/{id}/creditor_claims_window/start", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/creditor_claims_window/start' \ --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 '{ "procedure": "default_281"}'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/creditor_claims_window/start", { 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({ "procedure": "default_281" }),});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": "creditor_claims_window",
"id": "string",
"entity_id": "string",
"procedure": "default_281",
"statutory_window_days": 60,
"publication_date": "2019-08-24",
"opened_at": "2019-08-24T14:15:22Z",
"closes_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"status": "pending_publication",
"known_creditors": [
{
"recipient_id": "string",
"recipient_name": "string",
"notice_channel": "certified_mail",
"notice_sent_at": "2019-08-24T14:15:22Z",
"notice_document_id": "string",
"delivery_confirmed_at": "2019-08-24T14:15:22Z"
}
],
"publication_records": [
{
"publication": "string",
"publication_date": "2019-08-24",
"proof_document_id": "string"
}
],
"claims_received": [
{
"claim_id": "string",
"claimant_name": "string",
"received_at": "2019-08-24T14:15:22Z",
"amount_claimed_usd": 0,
"basis": "string",
"status": "open",
"settled_at": "2019-08-24T14:15:22Z",
"settlement_document_id": "string"
}
],
"created": 0,
"updated": 0,
"livemode": true
}{
"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/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"code": "invalid_state_transition",
"detail": "Entity ent_Nq3KcAbc is in state `dissolved`; `dissolve` is not a valid transition.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"current_state": "dissolved",
"attempted_transition": "dissolve",
"allowed_transitions": []
}{
"type": "https://mattermode.com/docs/errors/dissolution_prerequisites_missing",
"title": "Dissolution prerequisites missing",
"status": 409,
"code": "dissolution_prerequisites_missing",
"detail": "Voluntary dissolution requires `board_resolution_id` and `stockholder_consent_id`, or `auto_generate_resolutions: true`.",
"doc_url": "https://mattermode.com/docs/guides/errors#dissolution_prerequisites_missing",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/valuation_stale",
"title": "409A valuation stale",
"status": 409,
"code": "valuation_stale",
"detail": "Active 409A val_AbCd1234 is older than 12 months or superseded by a material event. Issuing ISOs at the prior strike risks IRC §409A violation. Refresh via POST /entities/{id}/valuations/{id}/refresh_request.",
"doc_url": "https://mattermode.com/docs/guides/errors#valuation_stale",
"request_id": "req_Qw9xYz8A"
}