Documents

Object Properties

NameTypeDescription
idUUIDUnique identifier for record
created_atDateTimeDatetime of creation
updated_atDateTimeDatetime of last update
titleStringName of the document
statusStringread, unread
typeStringRegular Mail, State Compliance, Initial Filing, Annual Report, Filing Document, Delivered Service of Process, Original Filing, High Priority, Ongoing Filing, Rejection Notice
sourceStringmail, generated, hand-delivered
pagesIntegerNumber of pages in this document
payment_lockedBooleanTrue if document is received for client not having active registered agent service
stateStringName of state where the document was received
company_nameStringName of company the document is addressed to
company_idUUIDUUID of the company

GET /documents

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)
statusString-Filter by document status (read, unread, defaults to unread)
startDatetime-Lower bound for the created_at field
stopDatetime-Upper bound for the created_at field

Response

{
	"success": true,
	"timestamp": "2018-05-28 05:59:45 -0700",
	"result": [
    {
      "id": "61fe0872-d901-4398-bb60-9783ab7bd616",
      "title": "State Filing Document -- Test Company LLC",
      "status": "unread",
      "type": "Filing Document",
      "source": "mail",
      "company_id": "9c0e696b-a9d4-4648-a3ae-c15399149af3",
      "created_at": "2018-05-27 12:25:12 -0700",
      "updated_at": "2018-05-27 12:25:41 -0700",
      "pages": 9,
      "state": "Washington",
      "company_name": "Test Company LLC",
      "company_id": "9c0e696b-a9d4-4648-a3ae-c15399149af3",
      "payment_locked": false
    },
    ...
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

GET /documents/:id

Parameters

NameTypeRequiredDescription
idUUIDThe ID of the document

GET /documents/:id/page/:page_number

Parameters

NameTypeRequiredDescription
idUUIDThe ID of the document
page_numberInteger0-indexed page number
dpiInteger-DPI of returned image. Possible values are 300, 150, 72

Response

This request will respond with a PNG image of the requested page.

GET /documents/:id/download

Parameters

NameTypeRequiredDescription
idUUIDThe ID of the document

Response

This route will respond with the actual PDF file associated with the document. If the status of the document is unread when this is called, it will be changed to read.