Conga

Conga Documents API

The Documents API from Conga — 38 operation(s) for documents.

Documentation GitHub OpenAPI

Operations 51

POST /v1/cs-packages/{packageId}/documents Add a new document to an existing package #

DELETE /v1/cs-packages/{packageId}/documents Delete multiple documents from a package #

PUT /v1/cs-packages/{packageId}/documents Update documents #

GET /v1/cs-packages/{packageId}/documents/all-documents/zip Retrieve zipped file containing all documents including supporting documents #

POST /v1/cs-packages/{packageId}/documents/signConfirm Create a signature confirmation #

POST /v1/cs-packages/{packageId}/documents/signed_documents Sign all documents in a package #

GET /v1/cs-packages/{packageId}/documents/visibility Retrieve document visibility information #

POST /v1/cs-packages/{packageId}/documents/visibility Update document visibility #

GET /v1/cs-packages/{packageId}/documents/zip Retrieve zipped documents #

DELETE /v1/cs-packages/{packageId}/documents/{documentId} Delete a document from a package #

GET /v1/cs-packages/{packageId}/documents/{documentId} Retrieve the specified document #

POST /v1/cs-packages/{packageId}/documents/{documentId} Update a document #

PUT /v1/cs-packages/{packageId}/documents/{documentId} Update the specified document #

PUT /v1/cs-packages/{packageId}/documents/{documentId}/fields Replace approvals and imprint fields for a document #

POST /v1/cs-packages/{packageId}/documents/{documentId}/layout Apply a layout to a document #

PUT /v1/cs-packages/{packageId}/documents/{documentId}/metadata Update document custom metadata #

GET /v1/cs-packages/{packageId}/documents/{documentId}/original Retrieve an original PDF document #

GET /v1/cs-packages/{packageId}/documents/{documentId}/pages/{index} Retrieve a page #

GET /v1/cs-packages/{packageId}/documents/{documentId}/pdf Retrieve a specific document in PDF form #

DELETE /api/document-management/v1/documents Delete documents by their IDs

POST /api/document-management/v1/documents Upload documents

GET /api/document-management/v1/documents/bulk Get documents by their IDs

POST /api/document-management/v1/documents/multipart-uploads Initiate a multipart upload

GET /api/document-management/v1/documents/objects/{objectId} Get documents by object ID and file type

DELETE /api/document-management/v1/documents/objects/{objectType}/{objectId} Delete documents by object type and ID

GET /api/document-management/v1/documents/objects/{objectType}/{objectId} Get documents by object type and ID

GET /api/document-management/v1/documents/objects/{objectType}/{objectId}/versions Get version details by object type and ID

POST /api/document-management/v1/documents/search Search documents using advanced query parameters

POST /api/document-management/v1/documents/upload Upload a single document

DELETE /api/document-management/v1/documents/{documentId} Delete a document by its ID

PUT /api/document-management/v1/documents/{documentId} Update a document

POST /api/document-management/v1/documents/{documentId}/clone Clone a document

GET /api/document-management/v1/documents/{documentId}/exists Check a document

GET /api/document-management/v1/documents/{documentId}/metadata Get a document's metadata by its ID

PUT /api/document-management/v1/documents/{documentId}/metadata Update the document metadata information for all versions

DELETE /api/document-management/v1/documents/{documentId}/multipart-uploads Abort a multipart upload

POST /api/document-management/v1/documents/{documentId}/multipart-uploads Complete multipart upload

PUT /api/document-management/v1/documents/{documentId}/multipart-uploads Upload a single part of a large file

GET /api/document-management/v1/documents/{documentId}/versions Retrieve document versions

DELETE /api/document-management/v1/documents/{documentId}/versions/{versionId} Delete a versioned document

GET /api/document-management/v1/documents/{documentId}/versions/{versionId} Get a document by its ID and version

GET /api/document-management/v1/documents/{id} Get document information by its ID

GET /api/document-management/v1/documents/{id}/download Get a document by its ID

POST /v2/documents/convert Convert documents' format #

POST /v2/documents/generate Generate a document from merge templates and data sources #

POST /v2/documents/join Join documents from multiple sources #

POST /v2/documents/process #

POST /v2/documents/protect Change document protection #

POST /v2/documents/{documentId}/convert Convert a document's format #

POST /v2/documents/{documentId}/process #

POST /v2/documents/{documentId}/protect Change document protection #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/conga-documents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Conga Documents API
  version: '1.0'
  description: 'Operations tagged Documents across 3 of this provider''s published API definitions: conga-conga-sign.json, conga-document-management.json, conga-ingress.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rls.congacloud.com/api/sign
- url: https://rls.congacloud.com
- url: https://rls.congacloud.com/api/ingress
tags:
- name: Documents
paths:
  /v1/cs-packages/{packageId}/documents:
    post:
      tags:
      - Documents
      summary: Add a new document to an existing package
      description: Adds a new document to an existing package by using a document resource.
      operationId: Documents_CreateDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                File:
                  type:
                  - string
                  - 'null'
                  format: binary
                Payload:
                  type:
                  - string
                  - 'null'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    delete:
      tags:
      - Documents
      summary: Delete multiple documents from a package
      description: Deletes multiple documents, identified by their documentID, from a specified package.
      operationId: Documents_DeleteDocuments
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: documentIds
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
        x-position: 2
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    put:
      tags:
      - Documents
      summary: Update documents
      description: Updates the documents in a package. For example, to re-order them.
      operationId: Documents_UpdateDocuments
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: documents
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Document'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/all-documents/zip:
    get:
      tags:
      - Documents
      summary: Retrieve zipped file containing all documents including supporting documents
      description: 'Retrieves a zipped file that contains both signable documents and Supporting Documents.

        This differs from the /zip endpoint which only returns signable documents.'
      operationId: Documents_GetAllDocumentsZip
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: flatten
        in: query
        description: Flatten the pdf.
        schema:
          type: boolean
          default: false
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/signConfirm:
    post:
      tags:
      - Documents
      summary: Create a signature confirmation
      description: Confirms that the application can execute the signing process on the document.
      operationId: Documents_CreateSignatureConfirmation
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignedDocument'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/signed_documents:
    post:
      tags:
      - Documents
      summary: Sign all documents in a package
      description: Signs all documents in a specified package.
      operationId: Documents_SignAllDocuments
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: documents
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignedDocuments'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignedDocuments'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/visibility:
    get:
      tags:
      - Documents
      summary: Retrieve document visibility information
      description: Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony.
      operationId: Documents_GetDocumentVisibility
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentVisibilityConfiguration'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    post:
      tags:
      - Documents
      summary: Update document visibility
      description: 'Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony.

        The response is a Document Visibility object that contains a list of configurations. Each configuration has:

        (1) the Document ID of a specific document; (2) a list of Role IDs of the signers who can view the document.

        Note that: Documents not in the Document Visibility object are visible to all recipients. The Package Owner can

        always see all documents in the package, regardless of its Document Visibility configuration.'
      operationId: Documents_UpdateDocumentsVisibility
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentVisibility'
        required: true
        x-position: 2
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/zip:
    get:
      tags:
      - Documents
      summary: Retrieve zipped documents
      description: Retrieves a zipped file that contains all documents that were added to the package.
      operationId: Documents_GetZip
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: flatten
        in: query
        description: Flatten the pdf.
        schema:
          type: boolean
          default: false
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}:
    delete:
      tags:
      - Documents
      summary: Delete a document from a package
      description: Deletes a document from a specified package.
      operationId: Documents_DeleteDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - Documents
      summary: Retrieve the specified document
      description: 'Retrieves all information related to a given document, including ID, name, description, presentation index,

        any associated data elements, approvals and fields.'
      operationId: Documents_GetDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    post:
      tags:
      - Documents
      summary: Update a document
      description: Updates a single, specified document. This endpoint accepts multi-part data, or the JSON structure of a document.
      operationId: Documents_UpdateDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    put:
      tags:
      - Documents
      summary: Update the specified document
      description: Updates the specified document.
      operationId: Documents_UpdateDocumentPut
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}/fields:
    put:
      tags:
      - Documents
      summary: Replace approvals and imprint fields for a document
      description: 'Replaces approvals and imprint fields with those provided in the request.

        - If an array is not provided then nothing will be updated for that field type.

        - If an empty array is provided then all fields of that type will be deleted.

        - Only the editable imprint fields will be replaced.'
      operationId: Documents_ReplaceDocumentFields
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: documentFields
        description: Arrays of approvals and imprint fields to replace.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentFields'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentFields'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}/layout:
    post:
      tags:
      - Documents
      summary: Apply a layout to a document
      description: Applies a specific layout to a specified document. At least one parameter needs to be applied, either layoutID, or layoutName.
      operationId: Documents_ApplyLayoutToDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      - name: layoutId
        in: query
        description: The unique layout id.
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: layoutName
        in: query
        description: The unique layout name.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: removeOutOfBound
        in: query
        description: 'Default value : false'
        schema:
          type: boolean
          default: false
        x-position: 5
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}/metadata:
    put:
      tags:
      - Documents
      summary: Update document custom metadata
      description: 'Updates the document custom metadata by overriding it with those in the payload.

        Internal metadata defined by OneSpan cannot be updated and will be ignored if included in the payload.


        Metadata is stored as key-value pairs where keys are strings and values can be any JSON-serializable type.'
      operationId: Documents_UpdateDocumentMetadata
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: metadata
        description: Document metadata as key-value pairs.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}/original:
    get:
      tags:
      - Documents
      summary: Retrieve an original PDF document
      description: Retrieves the original PDF document that was included in a package.
      operationId: Documents_GetOriginalDocument
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /v1/cs-packages/{packageId}/documents/{documentId}/pages/{index}:
    get:
      tags:
      - Documents
      summary: Retrieve a page
      description: Retrieves the document page you specify, returning it as a .png image file.
      operationId: Documents_GetDocumentPageByIndex
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: path
        required: true
        description: The unique document id.
        schema:
          type: string
        x-position: 2
      - name: index
        in: path
        required: true
        description: The page index.
 

# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-documents-api-openapi.yml