DocumentKeys

Queries documents by key

The key may be given either in formatted form (e.g. XXXX-XXXX-XXXX-XXXX) or unformatted (e.g. XXXXXXXXXXXXXXXX)

If a document with the given key is not found, the response is a 200 (Success) with "found": false.

If the given key has been allocated in advance but is not yet associated with a document, the response is a 200 (Success) with "found": true and "hasDocument": false. In this case, the field provisionalMetadata contains any provisional metadata passed during the document key allocation, which serves as an indicative of the metadata that a future document will likely have.

Only if "found": true and "hasDocument": true is the field document filled. In this case, provisionalMetadata is not filled.

get/api/document-keys/{key}

Request

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

Path parameters

keystring required

Response

Success

foundboolean

formattedKeystring nullable

hasDocumentboolean

provisionalMetadataobject nullable

Example response

{
  "found": true,
  "hasDocument": true,
  "provisionalMetadata": {
    "key": [
      "provisionalMetadata",
      "provisionalMetadata"
    ]
  },
  "document": {
    "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"
  },
  "formattedKey": "formattedKey"
}

Changes

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