Registered documents, newest listing order, optionally by hash
GET
/v1/entities/{entity_id}/documents
const url = 'https://example.com/v1/entities/example/documents';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/example/documentsParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”entity_id
required
Entity Id
The entity this path is relative to
string
The entity this path is relative to
Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”Successful Response
Media typeapplication/json
DocumentPage
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
items
required
Items
Array<object>
DocumentA 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
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
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "items": [ { "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" } } ], "next_cursor": "example"}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}