Documents

Retrieves a document's details

get/api/documents/{id}

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/documents/{id}
Auth: none declared

Path parameters

idstring uuid required

Response

Success

metadataobject nullable

idstring uuid

keystring nullable

formattedKeystring nullable

signatureType'Pdf' | 'Cms' | 'Xml'

availableUntilstring date-time nullable

Example response

{
  "signers": [
    {
      "date": "2000-01-23T04:56:07.000+00:00",
      "certificate": {
        "emailAddress": "emailAddress",
        "organizationIdentifier": "organizationIdentifier",
        "organization": "organization",
        "thumbprint": "thumbprint",
        "subjectIdentifier": "subjectIdentifier",
        "subjectCommonName": "subjectCommonName",
        "thumbprintSHA256": "thumbprintSHA256",
        "subjectDisplayName": "subjectDisplayName"
      }
    },
    {
      "date": "2000-01-23T04:56:07.000+00:00",
      "certificate": {
        "emailAddress": "emailAddress",
        "organizationIdentifier": "organizationIdentifier",
        "organization": "organization",
        "thumbprint": "thumbprint",
        "subjectIdentifier": "subjectIdentifier",
        "subjectCommonName": "subjectCommonName",
        "thumbprintSHA256": "thumbprintSHA256",
        "subjectDisplayName": "subjectDisplayName"
      }
    }
  ],
  "availableUntil": "2000-01-23T04:56:07.000+00:00",
  "metadata": {
    "key": [
      "metadata",
      "metadata"
    ]
  },
  "originalFile": {
    "name": "name",
    "length": 0,
    "location": "location",
    "mimeType": "mimeType",
    "contentType": "contentType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "markedFile": {
    "name": "name",
    "length": 0,
    "location": "location",
    "mimeType": "mimeType",
    "contentType": "contentType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "signatureType": "Pdf",
  "signedFile": {
    "name": "name",
    "length": 0,
    "location": "location",
    "mimeType": "mimeType",
    "contentType": "contentType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "key": "key",
  "formattedKey": "formattedKey"
}

Changes

No recorded changes to this operation across all 1 revision of this API.