Add Document Certification

POST 
/documents/:documentId/certifications

Applies one or more certifications (digital signatures) to a document using one or more certificates. Target determines whether a presigned download is returned, a new version is created, or a new document is created. ; available as an Add-On Module

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

application/json

Body

required

target DocumentCertificationTarget (string)required

Target for Document Certification

Possible values: [DOWNLOAD]

certificates

object[]

required

One or more certificates used to certify/sign the document (in order).

Possible values: >= 1

Array [

alias stringrequired

Certificate alias.

sourceType DocumentCertificationSourceType (string)

Document Certification Source Type

Possible values: [AWS_SECRETS_MANAGER]

awsSecretsManager

object

certificateArn stringrequired

AWS Secrets Manager - Certificate ARN

passwordArn string

AWS Secrets Manager - Certificate password ARN

]

Responses

201

201 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

documentId string

Document identifier (NEW_VERSION / NEW_DOCUMENT).

url string

Presigned download URL (DOWNLOAD).

Example (from schema)

{
  "documentId": "string",
  "url": "string"
}

400

400 BAD REQUEST

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...