Skip to main content
POST
companies.registry.filing.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by companies.registry.filings.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

title
string
required

Filing title or plain description of the filing type.

filedOn
string

When the filing was processed, ISO 8601.

category
string

Category of filing.

Maximum string length: 2048
type
string

Official filing type.

Maximum string length: 2048
description
string

Short filing description.

Maximum string length: 2048
pageCount
integer

Number of document pages.

Required range: 0 <= x <= 9007199254740991
documentAvailable
boolean

Whether document metadata or a source link is disclosed; a link may point to an HTML page.

company
object

Company the filing concerns.

annotations
object[]

Filing annotations.

Maximum array length: 100
associatedFilings
object[]

Associated filings.

Maximum array length: 100
resolutions
object[]

Disclosed resolutions.

Maximum array length: 100