Skip to content
Haddon

One document and every record that cites it

GET
/v1/entities/{entity_id}/documents/{document_id}
curl --request GET \
  --url https://example.com/v1/entities/example/documents/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
document_id
required
Document Id
string
entity_id
required
Entity Id

The entity this path is relative to

string

The entity this path is relative to

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DocumentResponse
object
entity_id
required
Entity Id
string
legal_name
required
Legal Name
string
base_currency
required
Base Currency
string
snapshot_seq
required
Snapshot Seq
integer
document
required
Document

A registered document, read back.

links.content is present only when the bytes are here to be served. An external document has nothing at that address, and the link would only give the interface a button that always fails.

object
sha256
required
Sha256

SHA-256 of the registered bytes, and the document’s identity

string
filename
required
Filename
string
media_type
required
Media Type
string
size_bytes
required
Size Bytes
integer
storage
required
Storage

Stored | external

string
external_ref
required
Any of:
string
id
required
Id
string
filing_count
required
Filing Count

How many records cite this document

integer
created_at
required
Created At
string
created_by
required
Created By
string
links
required
Links
object
key
additional properties
string
created
required
Created

False when this call found the document already registered

boolean
filings
required
Filings
Array<object>
DocumentFiling

One place a document is cited: which record, where in the file, and what it says.

object
evidence_id
required
Evidence Id
string
subject_kind
required
Subject Kind

Entry | statement

string
subject_id
required
Any of:
string
page
required
Any of:
integer
locator
required
Locator
string
caption
required
Caption
string
created_at
required
Created At
string
created_by
required
Created By
string

Example generated

{
  "entity_id": "example",
  "legal_name": "example",
  "base_currency": "example",
  "snapshot_seq": 1,
  "document": {
    "sha256": "example",
    "filename": "example",
    "media_type": "example",
    "size_bytes": 1,
    "storage": "example",
    "external_ref": "example",
    "id": "example",
    "filing_count": 1,
    "created_at": "example",
    "created_by": "example",
    "links": {
      "additionalProperty": "example"
    }
  },
  "created": true,
  "filings": [
    {
      "evidence_id": "example",
      "subject_kind": "example",
      "subject_id": "example",
      "page": 1,
      "locator": "example",
      "caption": "example",
      "created_at": "example",
      "created_by": "example"
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

404

Section titled “404”

Not Found

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

409

Section titled “409”

Conflict

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

412

Section titled “412”

Precondition Failed

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

422

Section titled “422”

Unprocessable Content

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
retryable
required
Retryable
boolean
details
required
Details
Array<object>
object
key
additional properties
any
request_id
Any of:
string
next_action
Any of:
object
key
additional properties
any

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}