documentMetadata resource

Methods

  • get - Fetch a document's metadata

Resource

{
    "created_at": "date-time",
    "etag": "string",
    "id": "string",
    "links": {
        "document": "string",
        "self": "string"
    },
    "pages": "number",
    "resources": {
        "{content_type}": {
            "content_length": "number",
            "created_at": "date-time",
            "updated_at": "date-time"
        }
    },
    "updated_at": "date-time"
}

Properties

Name Type Description Additional
created_at date-time

The date and time the document was first created
etag string

The ETag of the resource.
id string

The document ID.
links object

Links to other resources associated with this filing history item.
links.document string

Link to the document metadata associated with this document.

 Optional
links.self string

Link to this document.

 Optional
pages number

The document page count

 Optional
resources object

The list of content-types that the document is available as, and associated type specific information

 Optional
resources.{content_type} object

The content-type (MIME type) that the document is available as. Not all content types will be available for all documents. Available content types are application/pdf, application/json, application/xml, application/xhtml+xml and text/csv
resources.{content_type}.content_length number

The size of the document when returned as this content-type.
resources.{content_type}.created_at date-time

The date and time this document type was first created
resources.{content_type}.updated_at date-time

The date and time the document type was last updated

 Optional
updated_at date-time

The date and time the document was last updated

 Optional