Simulate an event (test keys only)

curl --request POST \
  --url https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ein": "<string>",
  "entitlements": {
    "federal_tax_filing": 1,
    "state_tax_filing": 0
  },
  "order": "<string>",
  "step": "<string>",
  "form_required": true,
  "completed": true,
  "file_name": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate"

payload = {
    "name": "<string>",
    "ein": "<string>",
    "entitlements": {
        "federal_tax_filing": 1,
        "state_tax_filing": 0
    },
    "order": "<string>",
    "step": "<string>",
    "form_required": True,
    "completed": True,
    "file_name": "<string>",
    "message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    ein: '<string>',
    entitlements: {federal_tax_filing: 1, state_tax_filing: 0},
    order: '<string>',
    step: '<string>',
    form_required: true,
    completed: true,
    file_name: '<string>',
    message: '<string>'
  })
};

fetch('https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate', 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.clemta.com/v1/sandbox/companies/{companyID}/simulate",
  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([
    'name' => '<string>',
    'ein' => '<string>',
    'entitlements' => [
        'federal_tax_filing' => 1,
        'state_tax_filing' => 0
    ],
    'order' => '<string>',
    'step' => '<string>',
    'form_required' => true,
    'completed' => true,
    'file_name' => '<string>',
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.clemta.com/v1/sandbox/companies/{companyID}/simulate"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.clemta.com/v1/sandbox/companies/{companyID}/simulate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "company",
  "id": "cmp_0346sFPEvSkJvY8vt14NNw",
  "account_id": "acct_0346sFPEvSkJvY8vt14NNw",
  "livemode": true,
  "name": "<string>",
  "state": "DE",
  "entity_type": "llc",
  "status": "requires_information",
  "verification": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "account": {
    "object": "account",
    "id": "acct_0346sFPEvSkJvY8vt14NNw",
    "livemode": true,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "phone": "<string>",
    "metadata": {}
  },
  "ending": "<string>",
  "industry": "<string>",
  "industry_description": "<string>",
  "custom_industry": "<string>",
  "timezone": "<string>",
  "name_style": "plain",
  "legal_name": "<string>",
  "owner_privacy": "public",
  "pre_existing": true,
  "ein": "<string>",
  "verified_at": "2023-11-07T05:31:56Z",
  "dissolved_at": "2023-11-07T05:31:56Z",
  "incorporated_at": "2023-11-07T05:31:56Z",
  "ein_assigned_at": "2023-11-07T05:31:56Z",
  "stage": "preparing_documents",
  "incorporation_date": "<string>",
  "address": {
    "country": "<string>",
    "line1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "line2": "<string>"
  },
  "foreign_qualifications": [
    {
      "state": "DE",
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "line2": "<string>"
    }
  ],
  "entitlements": {
    "federal_tax_filing": 1,
    "state_tax_filing": 0
  },
  "open_requirements": 123,
  "service_orders": [
    {
      "object": "service_order",
      "id": "so_0346sFPEvSkJvY8vt14NNw",
      "company": "<string>",
      "product_key": "ein",
      "status": "received",
      "unit_amount": 7900,
      "currency": "usd",
      "created_at": "2023-11-07T05:31:56Z",
      "interval": "one_time",
      "options": {
        "llc_members": "multi_member"
      },
      "form_required": true,
      "workflow_status": "<string>",
      "form": {
        "fields": [
          {
            "field_name": "<string>",
            "field_type": "text",
            "key": "<string>",
            "required": true,
            "options": [
              "<string>"
            ],
            "guidance": "<string>",
            "help": "<string>",
            "note": "<string>",
            "placeholder": "<string>",
            "info_points": [
              "<string>"
            ],
            "conditional": {
              "field": "<string>",
              "values": [
                "<string>"
              ]
            },
            "validation": {
              "pattern": "<string>",
              "min_length": 123,
              "max_length": 123,
              "min": 123,
              "max": 123
            },
            "file": {
              "accepted_types": [
                "<string>"
              ],
              "max_size_bytes": 123
            }
          }
        ],
        "title": "<string>",
        "warning": "<string>"
      },
      "quote": {
        "state": "pending",
        "unit_amount": 123,
        "currency": "<string>",
        "quoted_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "accepted_at": "2023-11-07T05:31:56Z"
      },
      "shareholder": "<string>",
      "outcome": "<string>",
      "included_in": "<string>",
      "fees": [
        {
          "kind": "state_fee",
          "unit_amount": 30000,
          "currency": "usd"
        }
      ],
      "next_renewal_at": "2023-11-07T05:31:56Z",
      "renewal_cancel_requested_at": "2023-11-07T05:31:56Z",
      "renewal_canceled_at": "2023-11-07T05:31:56Z",
      "renewal_ends_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "requirements": [
    {
      "object": "requirement",
      "id": "rqmt_0346sFPEvSkJvY8vt14NNw",
      "company": "<string>",
      "type": "document",
      "status": "open",
      "requested_by": "system",
      "livemode": true,
      "created_at": "2023-11-07T05:31:56Z",
      "service_order": "<string>",
      "shareholder": "<string>",
      "purpose": "identity_document",
      "document_name": "<string>",
      "signers": [
        {
          "ref": "<string>",
          "status": "pending_email",
          "email": "<string>",
          "name": "<string>",
          "viewed_at": "2023-11-07T05:31:56Z",
          "started_at": "2023-11-07T05:31:56Z",
          "signed_at": "2023-11-07T05:31:56Z",
          "declined_at": "2023-11-07T05:31:56Z"
        }
      ],
      "message": "<string>",
      "cancel_reason": "<string>",
      "form": {
        "fields": [
          {
            "field_name": "<string>",
            "field_type": "text",
            "key": "<string>",
            "required": true,
            "options": [
              "<string>"
            ],
            "guidance": "<string>",
            "help": "<string>",
            "note": "<string>",
            "placeholder": "<string>",
            "info_points": [
              "<string>"
            ],
            "conditional": {
              "field": "<string>",
              "values": [
                "<string>"
              ]
            },
            "validation": {
              "pattern": "<string>",
              "min_length": 123,
              "max_length": 123,
              "min": 123,
              "max": 123
            },
            "file": {
              "accepted_types": [
                "<string>"
              ],
              "max_size_bytes": 123
            }
          }
        ],
        "title": "<string>",
        "warning": "<string>"
      },
      "response": [
        {
          "value": "<unknown>",
          "key": "<string>",
          "field_name": "<string>"
        }
      ],
      "attachments": [
        {
          "filename": "<string>",
          "field": "<string>",
          "field_name": "<string>",
          "content_type": "<string>",
          "size": 123
        }
      ],
      "resolved_at": "2023-11-07T05:31:56Z"
    }
  ],
  "shareholders": [
    {
      "object": "shareholder",
      "id": "<string>",
      "type": "individual",
      "relationship": {
        "title": "sole_owner",
        "custom_title": "<string>",
        "percent_ownership": 99,
        "representative": true,
        "director": true
      },
      "document": {
        "status": "required"
      },
      "first_name": "<string>",
      "last_name": "<string>",
      "name": "<string>",
      "representative_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "phone_country": "<string>",
      "tax_id_type": "ssn",
      "address": {
        "country": "<string>",
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line2": "<string>"
      }
    }
  ],
  "officers": [
    {
      "object": "officer",
      "id": "off_0346sFPEvSkJvY8vt14NNw",
      "roles": [
        "member"
      ],
      "shareholder": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "title": "<string>",
      "source": "onboarding",
      "address": {
        "country": "<string>",
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line2": "<string>"
      }
    }
  ],
  "management_type": "member_managed",
  "officers_settled": true,
  "metadata": {}
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

POST

sandbox

companies

{companyID}

simulate

Simulate an event (test keys only)

curl --request POST \
  --url https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ein": "<string>",
  "entitlements": {
    "federal_tax_filing": 1,
    "state_tax_filing": 0
  },
  "order": "<string>",
  "step": "<string>",
  "form_required": true,
  "completed": true,
  "file_name": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate"

payload = {
    "name": "<string>",
    "ein": "<string>",
    "entitlements": {
        "federal_tax_filing": 1,
        "state_tax_filing": 0
    },
    "order": "<string>",
    "step": "<string>",
    "form_required": True,
    "completed": True,
    "file_name": "<string>",
    "message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    ein: '<string>',
    entitlements: {federal_tax_filing: 1, state_tax_filing: 0},
    order: '<string>',
    step: '<string>',
    form_required: true,
    completed: true,
    file_name: '<string>',
    message: '<string>'
  })
};

fetch('https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate', 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.clemta.com/v1/sandbox/companies/{companyID}/simulate",
  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([
    'name' => '<string>',
    'ein' => '<string>',
    'entitlements' => [
        'federal_tax_filing' => 1,
        'state_tax_filing' => 0
    ],
    'order' => '<string>',
    'step' => '<string>',
    'form_required' => true,
    'completed' => true,
    'file_name' => '<string>',
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.clemta.com/v1/sandbox/companies/{companyID}/simulate"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.clemta.com/v1/sandbox/companies/{companyID}/simulate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clemta.com/v1/sandbox/companies/{companyID}/simulate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"entitlements\": {\n    \"federal_tax_filing\": 1,\n    \"state_tax_filing\": 0\n  },\n  \"order\": \"<string>\",\n  \"step\": \"<string>\",\n  \"form_required\": true,\n  \"completed\": true,\n  \"file_name\": \"<string>\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "company",
  "id": "cmp_0346sFPEvSkJvY8vt14NNw",
  "account_id": "acct_0346sFPEvSkJvY8vt14NNw",
  "livemode": true,
  "name": "<string>",
  "state": "DE",
  "entity_type": "llc",
  "status": "requires_information",
  "verification": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "account": {
    "object": "account",
    "id": "acct_0346sFPEvSkJvY8vt14NNw",
    "livemode": true,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "phone": "<string>",
    "metadata": {}
  },
  "ending": "<string>",
  "industry": "<string>",
  "industry_description": "<string>",
  "custom_industry": "<string>",
  "timezone": "<string>",
  "name_style": "plain",
  "legal_name": "<string>",
  "owner_privacy": "public",
  "pre_existing": true,
  "ein": "<string>",
  "verified_at": "2023-11-07T05:31:56Z",
  "dissolved_at": "2023-11-07T05:31:56Z",
  "incorporated_at": "2023-11-07T05:31:56Z",
  "ein_assigned_at": "2023-11-07T05:31:56Z",
  "stage": "preparing_documents",
  "incorporation_date": "<string>",
  "address": {
    "country": "<string>",
    "line1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "line2": "<string>"
  },
  "foreign_qualifications": [
    {
      "state": "DE",
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "line2": "<string>"
    }
  ],
  "entitlements": {
    "federal_tax_filing": 1,
    "state_tax_filing": 0
  },
  "open_requirements": 123,
  "service_orders": [
    {
      "object": "service_order",
      "id": "so_0346sFPEvSkJvY8vt14NNw",
      "company": "<string>",
      "product_key": "ein",
      "status": "received",
      "unit_amount": 7900,
      "currency": "usd",
      "created_at": "2023-11-07T05:31:56Z",
      "interval": "one_time",
      "options": {
        "llc_members": "multi_member"
      },
      "form_required": true,
      "workflow_status": "<string>",
      "form": {
        "fields": [
          {
            "field_name": "<string>",
            "field_type": "text",
            "key": "<string>",
            "required": true,
            "options": [
              "<string>"
            ],
            "guidance": "<string>",
            "help": "<string>",
            "note": "<string>",
            "placeholder": "<string>",
            "info_points": [
              "<string>"
            ],
            "conditional": {
              "field": "<string>",
              "values": [
                "<string>"
              ]
            },
            "validation": {
              "pattern": "<string>",
              "min_length": 123,
              "max_length": 123,
              "min": 123,
              "max": 123
            },
            "file": {
              "accepted_types": [
                "<string>"
              ],
              "max_size_bytes": 123
            }
          }
        ],
        "title": "<string>",
        "warning": "<string>"
      },
      "quote": {
        "state": "pending",
        "unit_amount": 123,
        "currency": "<string>",
        "quoted_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "accepted_at": "2023-11-07T05:31:56Z"
      },
      "shareholder": "<string>",
      "outcome": "<string>",
      "included_in": "<string>",
      "fees": [
        {
          "kind": "state_fee",
          "unit_amount": 30000,
          "currency": "usd"
        }
      ],
      "next_renewal_at": "2023-11-07T05:31:56Z",
      "renewal_cancel_requested_at": "2023-11-07T05:31:56Z",
      "renewal_canceled_at": "2023-11-07T05:31:56Z",
      "renewal_ends_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "requirements": [
    {
      "object": "requirement",
      "id": "rqmt_0346sFPEvSkJvY8vt14NNw",
      "company": "<string>",
      "type": "document",
      "status": "open",
      "requested_by": "system",
      "livemode": true,
      "created_at": "2023-11-07T05:31:56Z",
      "service_order": "<string>",
      "shareholder": "<string>",
      "purpose": "identity_document",
      "document_name": "<string>",
      "signers": [
        {
          "ref": "<string>",
          "status": "pending_email",
          "email": "<string>",
          "name": "<string>",
          "viewed_at": "2023-11-07T05:31:56Z",
          "started_at": "2023-11-07T05:31:56Z",
          "signed_at": "2023-11-07T05:31:56Z",
          "declined_at": "2023-11-07T05:31:56Z"
        }
      ],
      "message": "<string>",
      "cancel_reason": "<string>",
      "form": {
        "fields": [
          {
            "field_name": "<string>",
            "field_type": "text",
            "key": "<string>",
            "required": true,
            "options": [
              "<string>"
            ],
            "guidance": "<string>",
            "help": "<string>",
            "note": "<string>",
            "placeholder": "<string>",
            "info_points": [
              "<string>"
            ],
            "conditional": {
              "field": "<string>",
              "values": [
                "<string>"
              ]
            },
            "validation": {
              "pattern": "<string>",
              "min_length": 123,
              "max_length": 123,
              "min": 123,
              "max": 123
            },
            "file": {
              "accepted_types": [
                "<string>"
              ],
              "max_size_bytes": 123
            }
          }
        ],
        "title": "<string>",
        "warning": "<string>"
      },
      "response": [
        {
          "value": "<unknown>",
          "key": "<string>",
          "field_name": "<string>"
        }
      ],
      "attachments": [
        {
          "filename": "<string>",
          "field": "<string>",
          "field_name": "<string>",
          "content_type": "<string>",
          "size": 123
        }
      ],
      "resolved_at": "2023-11-07T05:31:56Z"
    }
  ],
  "shareholders": [
    {
      "object": "shareholder",
      "id": "<string>",
      "type": "individual",
      "relationship": {
        "title": "sole_owner",
        "custom_title": "<string>",
        "percent_ownership": 99,
        "representative": true,
        "director": true
      },
      "document": {
        "status": "required"
      },
      "first_name": "<string>",
      "last_name": "<string>",
      "name": "<string>",
      "representative_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "phone_country": "<string>",
      "tax_id_type": "ssn",
      "address": {
        "country": "<string>",
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line2": "<string>"
      }
    }
  ],
  "officers": [
    {
      "object": "officer",
      "id": "off_0346sFPEvSkJvY8vt14NNw",
      "roles": [
        "member"
      ],
      "shareholder": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "title": "<string>",
      "source": "onboarding",
      "address": {
        "country": "<string>",
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line2": "<string>"
      }
    }
  ],
  "management_type": "member_managed",
  "officers_settled": true,
  "metadata": {}
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

{
  "type": "https://docs.clemta.com/partner/errors#resource_already_exists",
  "title": "<string>",
  "status": 349,
  "code": "api_key_invalid",
  "detail": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "reason": "<string>",
      "location": "<string>",
      "validation_type": "<string>",
      "how_to_fix": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Headers

Clemta-Version

string

Date-based API version to run this request against.

Example:

"2026-08-13"

Path Parameters

companyID

string

required

ID of the company.

Pattern: ^cmp_[0-9A-Za-z]{22}$

Body

application/json

Which event to simulate on a test company. The company (or its order, filing, file) is moved exactly as a live change would move it, then the event is delivered to your test webhooks - so every handler can be rehearsed against the real behaviour. Only the fields the event uses are read.

event

enum<string>

required

The event to produce. Events with a once-only rule keep it here too: company.incorporated fires the first time only. A bounce through company.status.changed back to active fires status.changed and not incorporated again.

Available options:

company.status.changed,

company.incorporated,

company.verified,

company.name.changed,

company.ein.assigned,

company.entitlements.changed,

service_order.status.changed,

service_order.completed,

tax_filing.created,

tax_filing.status.changed,

file.created,

requirement.created,

invoice.finalized

status

enum<string>

For company.status.changed - the status to move to. Moving to active the first time also fires company.incorporated.

Available options:

in_progress,

active,

cancelled

name

string

For company.name.changed - the new legal name.

Maximum string length: 200

ein

string

For company.ein.assigned. A second, different EIN updates the field without firing again.

Pattern: ^[0-9]{2}-[0-9]{7}$

entitlements

object

Rights the company holds, as counts remaining. An order for an entitlement product adds one. A tax filing consumes one when it is submitted. Some may be granted directly. company.entitlements.changed announces every move.

Show child attributes

order

string

For service_order.* - the test order on this company.

Pattern: ^so_[0-9A-Za-z]{22}$

step

string

For service_order.status.changed - the workflow step name to move the order to.

Maximum string length: 100

form_required

boolean

For service_order.status.changed - whether the step waits on a form (opens a form requirement, status requires_action).

completed

boolean

For service_order.status.changed - whether the step is the final one (status completed, fires service_order.completed once).

tax_filing

object

The tax filing to open or move (sandbox).

Show child attributes

file_name

string

For file.created - the document's filename. A placeholder PDF is served from the file's content endpoint.

Maximum string length: 200

message

string

For requirement.created - the Clemta ask (an information requirement).

Maximum string length: 500

Response

The company after the simulated change.

object

enum<string>

required

Entity name. Identifies this object when it arrives without its URL - nested under an expand[], inside an event payload, or in a webhook.

Available options:

company

string

required

Identifier of the company.

Pattern: ^cmp_[0-9A-Za-z]{22}$

Example:

"cmp_0346sFPEvSkJvY8vt14NNw"

account_id

string

required

The account (the incorporator) this company was created under. Expand account to embed the full object.

Pattern: ^acct_[0-9A-Za-z]{22}$

Example:

"acct_0346sFPEvSkJvY8vt14NNw"

livemode

boolean

required

False for a company created with a test key. A test company is a sandbox simulation - it never reaches fulfillment or billing.

name

string

required

Legal name of the company.

state

enum<string>

required

US state of formation, as a two-letter code.

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

DC

Example:

"DE"

entity_type

enum<string>

required

Entity type being formed.

Available options:

llc,

c_corp

Example:

"llc"

status

enum<string>

required

Lifecycle status. A company starts in requires_information while it waits for its owners' identity documents. It moves to in_progress once every required document is present and it is submitted for formation, and to active once fulfilled.

Available options:

requires_information,

in_progress,

active,

cancelled,

dissolved

verification

enum<string>

required

Whether the company's owners have submitted the identity documents needed to file. verified_at records when. State filings wait for it.

Available options:

pending,

verified

created_at

string<date-time>

required

When the company was created.

updated_at

string<date-time>

required

When the company was last modified. Also written to the Last-Modified response header on a single-company fetch, so a conditional If-Modified-Since request can be answered 304 Not Modified.

external_id

string

Your own identifier for this company, unique across your companies.

account

object

The full account this company was created under. Present only when requested with expand[]=account.

Show child attributes

ending

string

industry

string

industry_description

string

Free-text description of the business, present when industry is other.

custom_industry

string

Short name of the custom industry, present when industry is other.

timezone

string

The company's IANA time zone.

name_style

enum<string>

How the legal name renders around the ending.

Available options:

plain,

comma

legal_name

string

read-only

The rendered legal name - name, the name_style separator, and the ending ("Acme, LLC").

owner_privacy

enum<string>

Whether the owners are kept off the public filing. Choosable only in DE, NV, WY, NM.

Available options:

public,

private

pre_existing

boolean

True when the company already existed before it was brought to Clemta. False when Clemta forms it.

ein

string

The federal tax id, once the IRS has issued it. Fires company.ein.assigned when it lands.

verified_at

string<date-time>

When every owner's identity document was in and the company was ready for formation. company.verified announces this moment, and it does not change afterward.

dissolved_at

string<date-time>

When the company was dissolved. Terminal: the company's status is dissolved from that moment, every recurring service stopped renewing, open requirements were closed, and nothing further can be ordered. company.dissolved announces this moment, and it does not change afterward.

incorporated_at

string<date-time>

When the company was marked incorporated in Clemta - the moment company.incorporated fires. It can differ from incorporation_date, the legal formation date the state assigned.

ein_assigned_at

string<date-time>

When the EIN was assigned. company.ein.assigned announces this moment, and it does not change afterward.

stage

enum<string>

The fine-grained formation step under status - where formation stands right now. Changes fire company.status.changed. Reaching incorporated also fires company.incorporated.

Available options:

preparing_documents,

documents_generated,

signature_requested,

submitted_to_state,

name_conflict,

incorporated,

closed

incorporation_date

string

The legal formation date the state assigned, recorded from the formation document (for a pre_existing company, the one uploaded through its requirement). It can differ from incorporated_at, which is when Clemta marked the company incorporated. Never an input. company.updated announces changes.

address

object

The company's legal address, maintained by Clemta.

Show child attributes

foreign_qualifications

object[]

States the company is registered in beside its formation state.

Show child attributes

entitlements

object

Show child attributes

open_requirements

integer<int64>

read-only

How many requirements currently stand open on this company - "is anything waiting on you" in one number, without touching status. Derived at read time on API responses. Webhook data.object snapshots omit it.

service_orders

object[]

read-only

Every service order on the company, newest first, embedded when the request carries expand[]=service_orders - including the mandatory products a create attached automatically. The same rows GET /companies/{id}/service-orders lists.

Show child attributes

requirements

object[]

read-only

The open requirements themselves, embedded when the request carries expand[]=requirements - the list behind open_requirements. Resolved history stays on GET /companies/{id}/requirements.

Show child attributes

shareholders

object[]

The company's owners. Collect a missing identity document by attaching an uploaded file (passport) or by creating a verification session for the owner.

Show child attributes

officers

object[]

The management roster - everyone who holds a position. A director is an officer holding the director role. There is no separate directors list. Includes officers who are not owners. Set at company creation, and kept current as the roster changes.

Show child attributes

management_type

enum<string>

LLC only - whether the company is member-managed or manager-managed.

Available options:

member_managed,

manager_managed

officers_settled

boolean

Whether the officer roster is final. When true with an empty officers, the company has no officers by design, not a roster still being collected.

metadata

object

Your own key-value pairs, stored and returned verbatim. Clemta never reads them.

Identity

Accounts

Companies

Officers & directors

Products and pricing

Service orders

Tax filings

Fixed assets

Requirements

Verification and signing

Files

File links

Calendar

Status tracking

Events

Hosted links

Sandbox

Webhook events

Simulate an event (test keys only)

Authorizations

Headers

Path Parameters

Body

Response