Services

Returns an array of services in the account. A company can be specified to narrow results.

Object properties

NameTypeDescription
idStringUnique identifier for record
created_atDateTimeDatetime of creation
updated_atDateTimeDatetime of last update
statusStringstatus of service; returns active, cancelled, and awaiting-client-input
typeStringservice type
jurisdictionStringJurisdiction of company
jurisdiction_idUUIDid of jurisdiction
companyStringCompany name
company_idUUIDid of company

GET /services

Parameters

NameTypeRequiredDescription
limitInteger-Maximum number of results to return (defaults to 50 and max per request is 100)
offsetInteger-Offset to start limit count from (defaults to 0)
companyStringName of company
company_idUUIDid of company
  • Either a company or company_id is provided, but not both.

Example request body:

{
  "company": "Example B, Inc.",
  "limit": 25

}
1
2
3
4
5

Response

{
   "success":"true",
   "timestamp":"2018-06-27 16: 31: 48 -0700",
   "result":[
      {
         "id":"8dba2be3-fffd-43d3-a0f0-1f7350dbc27d",
         "type":"registered-agent",
         "status":"cancelled",
         "company_id":"89a8c166-7412-422b-b164-7217125ad2df",
         "created_at":"2017-07-14 14:54:04 -0700",
         "updated_at":"2018-04-13 11:36:17 -0700",
         "jurisdiction":"Wyoming",
         "jurisdiction_id":"3b71df54-04f5-4552-91f1-9cd710ac7938",
         "company":"Example B, LLC",
         "company_id": "9c0e696b-a9d4-4648-a3ae-c15399149af3"
      },
      ...
   ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

POST /services

Attributes

NameTypeRequiredDescription
companyStringcompany name to add the service to
company_idUUIDcompany_id to add the service to
jurisdictionsStringan array of jurisdictions
jurisdiction_idsUUIDan array of valid jurisdiction ids
  • Either a company or company_id is required, but not both.
  • Either jurisdictions or jurisdiction_ids are required, but not both.

Example request body:

{
   "company": "Example A, Inc.",
   "jurisdictions": [
      "Rhode Island", "California"
   ]
}
1
2
3
4
5
6

POST /services/:id/cancel-request

  • Submitting a cancel request via the API notifies our staff of the service requesting to be cancelled. It does not automatically cancel the service.
  • If the service has an outstanding balance, the response will be a 400 status, with a list of the unpaid invoices.
  • These invoices must be paid or cancelled before the service can be successfully cancelled.

Parameters

NameTypeRequiredDescription
idUUIDThe ID of the service

Example response body:

  • response body is the service requested for cancellation
 {
   "timestamp": "2018-09-18T14:42:07.070-07:00",
   "success": "true",
   "result": {
     "id": "227c0427-2e09-4829-9538-dbfe235ee289",
     "type": "registered-agent",
     "status": "cancel-requested",
     "company_id": "02bee818-6d37-437b-8807-22a46591c2c1",
     "created_at": "2018-07-09T11:55:58.000-07:00",
     "updated_at": "2018-07-09T11:57:14.000-07:00",
     "jurisdiction": "Wyoming",
     "jurisdiction_id": "9f3cf515-105d-45de-ae1a-8c90bc2cb06c",
     "company": My Company, LLC"
   }
 }	
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15