Qualified Electronic Signature

Upload documents to sign

Changed on

Use this endpoint for Qualified Electronic Signature workflows to upload the document(s) to sign. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: <br />• Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/qes-integration">integration guide</a>. <br />• <code>signatureId</code> and <code>workflowId</code> are string identifiers that can be used interchangeably. <br />• Documents can be uploaded in parallel as long as each document uses a unique document_id.<br />• Requests around 26 MB may hit the default request size limit.<br />• For optimal reliability and experience, we recommend keeping the number of documents per signature low (typically two or three).<br />• A successful response is empty.

post/v1/onboarding/signatures/{workflowId}/documentsToSign

Request

  • Base URL
    https://api.ext-sandbox.fourthline.com
  • URL
    https://api.ext-sandbox.fourthline.com/v1/onboarding/signatures/{workflowId}/documentsToSign
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Path parameters

workflowIdstring required

Our unique identifier for the workflow, returned in the Create workflow response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this as the reference number for any questions.

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Content-Typestring

Set to multipart/form-data.

Request body application/x-www-form-urlencoded

filesstring binary required

An array of form data files, one for each document to sign. <br /> Required headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match 1 filename in documentsToSign) <br /> Content-Type: application/pdf

Response

Documents upload accepted

object required

The request was accepted. The response body is empty.

Changes

    • breaking

      added subschema #1: Invalid ID document ID to the response body oneOf list for the response status

    • info

      removed subschema #1: Invalid document ID from the response body oneOf list for the response status