DocumentKeys

Allocates a document key to be used later on a document signature

To allocate a number of document keys at once, use the POST /api/document-keys/batch API instead. Limitations on the total number of unused document keys allocated may apply.

post/api/document-keys

Request

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

Request body

provisionalMetadataobject nullable

Example request

{
  "provisionalMetadata": {
    "key": [
      "provisionalMetadata",
      "provisionalMetadata"
    ]
  }
}

Response

Success

keystring nullable
formattedKeystring nullable

Example response

{
  "key": "key",
  "formattedKey": "formattedKey"
}

Changes

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