Companies

Object Properties

NameTypeDescription
idUUIDUnique identifier for record
created_atDateTimeDatetime of creation
updated_atDateTimeDatetime of last update
nameStringName of the company
entity_typeStringEntity type of the company

GET /companies

Parameters

NameTypeRequiredDescription
limitInteger-Maximum number of results to return (defaults to 50 and max per request is 200)
offsetInteger-Offset to start limit count from (defaults to 0)

Response

{
	"success": true,
	"timestamp": "2018-06-11 06:37:27 -0700",
	"result": [
    {
      "id": "d1414c2f-6dcb-4b90-bc80-dd955ffdefb6",
      "created_at": "2018-06-07 13:12:01 -0700",
      "updated_at": "2018-06-07 13:12:01 -0700",
      "name": "Example A LLC",
      "entity_type": "Limited Liability Company",
      "jurisdictions": ["Oregon", "Kentucky"],
      "home_state": "Oregon"
    },
    {
      "id": "9c0e696b-a9d4-4648-a3ae-c15399149af3",
      "created_at": "2018-06-07 13:11:40 -0700",
      "updated_at": "2018-06-07 13:11:40 -0700",
      "name": "Example B Inc.",
      "entity_type": "Corporation",
      "jurisdictions": "Washington",
      "home_state": "Washington"
    },
    ...
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

GET /companies/:id

Parameters

NameTypeRequiredDescription
idUUIDThe ID of the company

Response

{
  "success": true,
  "timestamp": "2018-06-11 06:40:33 -0700",
  "result": {
    "id": "9c0e696b-a9d4-4648-a3ae-c15399149af3",
    "created_at": "2018-06-07 13:11:40 -0700",
    "updated_at": "2018-06-07 13:11:40 -0700",
    "name": "Example B Inc.",
    "entity_type": "Corporation", 
    "jurisdictions": "California", 
    "home_state": "California"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

POST /companies

Attributes

NameTypeRequiredDescription
companiesObject[]an array of companies to be created.
companies[].nameStringcompany name
companies[].entity_typeStringentity type
companies[].jurisdictionsString[]an array of jurisdictions.
companies[].home_stateStringcompany's domestic registration jurisdiction
  • POST accepts a minimum of 1 company and a maximum of 20 companies.
  • Each company name must be unique.
  • Either a jurisdiction or a home_state can be provided.
  • The home_state cannot be a duplicate jurisdiction in the jurisdictions array.
  • If the company jurisdiction is also the home_state, the jurisdictions param is not required.

Examples of valid requests using the home_state param:

// New company Example A is a corporation with 3 jurisdictions:
// Michigan, California and Oregon. Oregon is the home state.

{
    "companies": [
        {
            "name": "Example A",
            "entity_type": "Corporation",
            "jurisdictions": ["Michigan", "California"],
            "home_state": "Oregon"
        }
    ]
}

// New company Example AAA is a corporation 
// with 1 jurisdiction: Oregon. It is the home state. 
{
    "companies": [
        {
            "name": "Example AAA",
            "entity_type": "Corporation",
            "home_state": "Oregon"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

A Example request body without home_state

// New company Example ABC is a corporation with 1 
// jurisdiction: Michigan. It does not have a specified home state. 
{
    "companies": [
        {
            "name": "Example ABC",
            "entity_type": "Corporation",
            "jurisdictions": ["Michigan"]
        },
        {
            "name": "Example B",
            "entity_type": "Limited Liability Company",
            "jurisdictions": ["Illinois", "Wyoming", "Oregon"]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

PATCH /companies

Attributes

NameTypeRequiredDescription
companiesObject[]an array of companies to be updated.
companies[].company_idUUIDUUID of the company being updated
companies[].companyStringthe name of the company being updated
companies[].jurisdictionsString[]an array of jurisdictions.
companies[].home_stateStringcompany's domestic registration jurisdiction
companies[].nameStringthe new name for the company being updated
companies[].entity_typeStringthe updated entity type.

companies array:

  • PATCH accepts a minimum of 1 company and a maximum of 20 companies.

company_id, company params:

  • Eiter a company_id or company can be provided, but not both.

jurisdictions and home_state params:

  • Jurisdictions can be added to a company, but not removed.
  • The home_state cannot be a duplicated in the jurisdictions array.
  • If the jurisdiction being added is also the home_state, the jurisdictions param is not required.
  • If the home state is already a jurisdiction of the company - but not identified as such, update the company by setting that jurisdiction in the home_state param.

name param:

  • The name of the company can be updated.
  • The state registration is NOT affected by the name changes made through this endpoint. It simply updates the Corptools database. To update the state registration, submit an amendment filing either directly with the sate, or through your onlineaccount.net account.

entity type param:

  • The entity type of the company can be updated.

Example requests and responses:

// update the company name, the entity type, and add 2 new jurisdictions:
{
    "companies": [
        {
            "company": "Sample Company", 
            "name": "My Sample Company", 
            "entity_type": "Corporation", 
            "jurisdictions": ["Texas", "Wyoming"]
        }
    ]
}
// response:
{
   "timestamp":"2019-05-09T12:19:03.174-07:00",
   "success":"true",
   "result":[
      {
         "name":"My Sample Company"",
         "id":"cea613d9-9195-4789-a5f0-cb1c7483d511",
         "created_at":"2019-05-09T12:19:02.000-07:00",
         "updated_at":"2019-05-09T12:19:02.000-07:00",
         "entity_type":"Corporation",
         "jurisdictions":["Texas", "Wyoming", "Ohio"]
      }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// take the existing jurisdiction Wyoming, and make it the home_state:
{
    "companies": [
        {
            "company": "My Sample Company", 
            "home_state": "Wyoming"
           
        }
    ]
}

// response: 
{
   "timestamp":"2019-05-09T12:19:03.174-07:00",
   "success":"true",
   "result":[
      {
         "name": "My Sample Company",
         "id": "cea613d9-9195-4789-a5f0-cb1c7483d511",
         "created_at": "2019-05-09T12:19:02.000-07:00",
         "updated_at": "2019-05-09T12:19:02.000-07:00",
         "entity_type": "Corporation",
         "jurisdictions": ["Texas", "Wyoming", "Ohio"],
         "home_state": "Wyoming"
      }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// add 1 new jurisdiction: and update the home state from Wyoming to Delaware: 
{
    "companies": [
        {
            "company": "My Sample Company", 
            "jurisdictions": ["California"],
            "home_state": "Delaware"
        }
    ]
}

// response: 
{
   "timestamp":"2019-05-09T12:19:03.174-07:00",
   "success":"true",
   "result":[
      {
         "name": "My Sample Company",
         "id": "cea613d9-9195-4789-a5f0-cb1c7483d511",
         "created_at": "2019-05-09T12:19:02.000-07:00",
         "updated_at": "2019-05-09T12:19:02.000-07:00",
         "entity_type": "Corporation",
         "jurisdictions": ["Texas", "Wyoming", "Ohio", "California", "Delaware"],
         "home_state": "Delaware"
      }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27