Conga Package API

openapi: 3.2.0
info:
  title: Conga Sign Package API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/sign
security:
- JWT: []
tags:
- name: Package
paths:
  /v1/cs-packages:
    post:
      tags:
      - Package
      summary: Create a package
      description: Creates a new package or a template with no attachments. To create a template, set Type to Template. To create a package with attachments, see "Create a package with attachments".
      operationId: Package_CreatePackage
      requestBody:
        x-name: package
        description: Package initial information. Though this does not need to be fully filled, it must contain at least the "name" property.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '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: []
    get:
      tags:
      - Package
      summary: List packages
      description: Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns the specified user's transactions. To retrieve other users' transactions, roles and permissions must be enabled on your account and the API caller must have "Manage users’ transactions, templates, layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
      operationId: Package_ListPackages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultOfPackage'
        '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: []
  /v1/cs-packages/{packageId}:
    delete:
      tags:
      - Package
      summary: Delete a package
      description: Deletes a specified package or template.
      operationId: Package_DeletePackageById
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '204':
          description: No Content
        '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: []
    get:
      tags:
      - Package
      summary: Get package information
      description: Retrieves information about a document package.
      operationId: Package_GetPackageById
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      - name: rawSignatureCapture
        in: query
        description: If set to true, signatures are provided as a vector.
        schema:
          type: boolean
          default: false
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '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:
      - Package
      summary: Update a package
      description: Updates the information pertaining to a specified package.
      operationId: Package_UpdatePackage
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: package
        description: Package initial information. Though this does not need to be fully filled, it must contain at least the "name" property.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '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: []
  /v1/cs-packages/{packageId}/audit:
    get:
      tags:
      - Package
      summary: Get package audit details
      description: Retrieves a package's audit details. The audit trail is embedded directly in the package and can be viewed any time.
      operationId: Package_GetPackageAudit
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportedAuditTrail'
        '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: []
  /v1/cs-packages/{packageId}/bulk_send:
    post:
      tags:
      - Package
      summary: Create packages
      description: "Create and send packages using bulk send. The package ID must be of type template.\n            \n**Prerequisites**\n* Enable the bulk send feature in your account.\n* Create an eligible template. A template is considered eligible if it contains at least one document that is not the consent agreement, placeholder role, and signature field.\n* Create a CSV file with recipient details. The file must include placeholder, first name, last name, and email columns.\n            \nThis API returns a bulk send batch ID."
      operationId: Package_CreatePackagesUsingBulkSend
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                File:
                  type:
                  - string
                  - 'null'
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '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: []
  /v1/cs-packages/{packageId}/clone:
    post:
      tags:
      - Package
      summary: Re-create a package or template
      description: Creates a package or template from an existing package or template. To create a template, set type in the request body to "TEMPLATE".
      operationId: Package_CreatePackageClone
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: package
        description: "In case of template, a new name field must be provided.\n            You can overwrite any of the cloned package or template fields, by adding it to the JSON body, following the Package structure. The owner of the new package is by default the request user. You can specify the owner of the new package by adding a sender object to the JSON body."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '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 Error
          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: []
  /v1/cs-packages/{packageId}/evidence/summary:
    get:
      tags:
      - Package
      summary: Summarize package evidence
      description: Retrieves summary evidence information for a specified package.
      operationId: Package_GetPackageEvidenceSummary
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '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: []
  /v1/cs-packages/{packageId}/fieldSummary:
    get:
      tags:
      - Package
      summary: List package fields
      description: Retrieves a list of form fields in a package. Fields are grouped by document and by signer.
      operationId: Package_GetPackageFieldSummary
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldSummary'
        '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: []
  /v1/cs-packages/{packageId}/readiness:
    get:
      tags:
      - Package
      summary: Get package readiness
      description: Retrieves a package's readiness to be sent for signature. This API returns a True status when the package is ready to send.
      operationId: Package_GetPackageReadiness
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageReadiness'
        '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: []
  /v1/cs-packages/{packageId}/referencedConditions:
    get:
      tags:
      - Package
      operationId: Package_GetPackageReferencedConditions
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: query
        schema:
          type: string
        x-position: 2
      - name: fieldId
        in: query
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferencedConditions'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/roles/{roleId}/signingUrl:
    get:
      tags:
      - Package
      summary: Get package signature URL
      description: Retrieves the URL that a signer can use to sign a package. This can only be done to a package that is not modifiable (e.g., a sent package). It cannot be done to a package in a draft state.
      operationId: Package_GetSigningUrlByRoleId
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: roleId
        in: path
        required: true
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningUrl'
        '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: []
  /v1/cs-packages/{packageId}/signers/{signerId}/approvals:
    get:
      tags:
      - Package
      summary: Retrieve all approvals by signer
      description: Retrieves all approvals for a specified signer in a specific package.
      operationId: Package_GetPackageSignerApprovals
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      - name: signerId
        in: path
        required: true
        description: The unique signer ID.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultOfRole'
        '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: []
  /v1/cs-packages/{packageId}/signingStatus:
    get:
      tags:
      - Package
      summary: Get package signing status
      description: Retrieves the signing status of a package. Retrieved information can be filtered by signer or by document.
      operationId: Package_GetPackageSigningStatus
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningStatus'
        '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: []
components:
  schemas:
    PackageSettings:
      type: object
      description: Object to manage package settings
      additionalProperties: false
      properties:
        ceremony:
          description: CeremonySettings
          oneOf:
          - $ref: '#/components/schemas/CeremonySettings'
    AttachmentFile:
      type: object
      description: Attachment file information.
      additionalProperties: false
      properties:
        id:
          type: integer
          description: Attachment file Id.
          format: int32
        insertDate:
          type: integer
          description: Attachment creation date in epoch format.
          format: int64
        name:
          type: string
          description: Attachment file name.
        preview:
          type: boolean
          description: Can see attachment previews.
    GroupMembership:
      type: object
      description: Object to manage group membership
      additionalProperties: false
      properties:
        groupId:
          type: string
          description: GroupId
        groupName:
          type: string
          description: GroupName
        memberType:
          description: MemberType
          oneOf:
          - $ref: '#/components/schemas/MemberType'
    IdvWorkflow:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The unique Id of the Id verification workflow configuration.
        type:
          type: string
          description: The Id verification workflow type.
        tenant:
          type: string
          description: The customer alias.
        desc:
          type: string
          description: Id verification workflow description.
    AuthChallenge:
      type: object
      additionalProperties: false
      properties:
        answer:
          type: string
          description: Secret question answer.
        maskInput:
          type: boolean
          description: To hide the user input.
        question:
          type: string
          description: Secret question.
    SignerInformationForLexisNexis:
      type: object
      description: Signer identity details needed for LexisNexis verification.
      additionalProperties: false
      properties:
        firstName:
          type: string
          description: First name of the signer. (Required)
        lastName:
          type: string
          description: Last name of the signer. (Required)
        city:
          type: string
          description: City of the signer. (Required)
        zip:
          type: string
          description: ZIP or postal code of the signer. (Required)
        state:
          type: string
          description: State or province of the signer. (Optional)
        houseName:
          type: string
          description: House name of the signer’s residence. (Optional)
        flatOrApartmentNumber:
          type: string
          description: Flat or apartment number. (Optional)
        houseNumber:
          type: string
          description: House number of the signer’s residence. (Optional)
        socialSecurityNumber:
          type: string
          description: Social Security Number of the signer. (Optional)
        dateOfBirth:
          type:
          - string
          - 'null'
          description: Date of birth of the signer. (Optional)
          format: date-time
    AuditType:
      type: string
      description: ''
      x-enumNames:
      - Accept
      - ClickToSign
      - ClickToInitial
      - CaptureSignature
      - Confirm
      - Download
      - DownloadZip
      - FormField
      - Login
      - View
      - OptOut
      - SigningSessionForRecipient
      - Decline
      enum:
      - Accept
      - ClickToSign
      - ClickToInitial
      - CaptureSignature
      - Confirm
      - Download
      - DownloadZip
      - FormField
      - Login
      - View
      - OptOut
      - SigningSessionForRecipient
      - Decline
    GroupMember:
      type: object
      description: Object to manage a group member
      additionalProperties: false
      properties:
        email:
          type: string
          description: Email string
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        memberType:
          description: MemberType
          oneOf:
          - $ref: '#/components/schemas/MemberType'
        pending:
          type:
          - boolean
          - 'null'
          description: Pending
        userId:
          type: string
          description: UserId
    TextualSignatureStyle:
      type: object
      description: Object to manage a text signature
      additionalProperties: false
      properties:
        color:
          type: string
          description: Signature color.
        font:
          type: string
          description: Signature font.
    License:
      type: object
      description: License information.
      additionalProperties: false
      properties:
        created:
          type:
          - string
          - 'null'
          description: License creation date.
          format: date-time
        paidUntil:
          type:
          - string
          - 'null'
          description: Paid license expiration.
          format: date-time
        plan:
          description: License plan.
          oneOf:
          - $ref: '#/components/schemas/Plan'
        status:
          description: License status.
          oneOf:
          - $ref: '#/components/schemas/LicenseStatus'
        transactions:
          type: array
          description: Transactions associated with this license
          items:
            $ref: '#/components/schemas/Transaction'
    Signer:
      type: object
      description: Object to manage a signer
      additionalProperties: false
      properties:
        address:
          description: Signer address.
          oneOf:
          - $ref: '#/components/schemas/Address'
        auth:
          description: Auth settings.
          oneOf:
          - $ref: '#/components/schemas/Auth'
        company:
          type: string
          description: Signer's company name.
        created:
          type:
          - string
          - 'null'
          description: Signer creation date.
          format: date-time
        data:
          type: object
          description: Signer metadata.
          additionalProperties: {}
        delivery:
          description: Signer delivery settings.
          oneOf:
          - $ref: '#/components/schemas/Delivery'
        email:
          type: string
          description: Signer email.
        external:
          description: External provider information.
          oneOf:
          - $ref: '#/components/schemas/External'
        firstName:
          type: string
          description: Signer's first name.
        group:
          description: Signer's group.
          oneOf:
          - $ref: '#/components/schemas/Group'
        id:
          type: string
          description: Signer Id.
        knowledgeBasedAuthentication:
          description: Knowledge base authentication through Equifax.
          oneOf:
          - $ref: '#/components/schemas/KnowledgeBasedAuthentication'
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        lastName:
          type: string
          description: Signer's lastname.
        name:
          type: string
          description: Signer's name.
        phone:
          type: string
          description: Signer's phone.
        professionalIdentityFields:
          type: array
          description: ' '
          items:
            $ref: '#/components/schemas/ProfessionalIdentityField'
        signature:
          description: Signer's signature style.
          oneOf:
          - $ref: '#/components/schemas/SignatureStyle'
        signerType:
          description: Type of signer
          oneOf:
          - $ref: '#/components/schemas/SignerType'
        specialTypes:
          type: array
          description: Special User Types. Currently only NOTARY is supported.
          items:
            type: string
        title:
          type: string
          description: Signer's title.
        updated:
          type:
          - string
          - 'null'
          description: Last time signer was updated.
          format: date-time
        userCustomFields:
          type: array
          description: Signer's custom fields.
          items:
            $ref: '#/components/schemas/UserCustomField'
        digipassAuthentication:
          type: boolean
          description: Indicates whether Digipass authentication is enabled for the signer.
        timezoneId:
          type: string
          description: Timezone ID of the signer, e.g., "America/New_York".
        notificationMethods:
          description: Default notification methods for the signer.
          oneOf:
          - $ref: '#/components/schemas/NotificationMethods'
    RoleType:
      type: string
      description: ''
      x-enumNames:
      - SIGNER
      - SENDER
      enum:
      - SIGNER
      - SENDER
    CreditCard:
      type: object
      additionalProperties: false
      properties:
        cvv:
          type: string
        expiration:
          $ref: '#/components/schemas/CcExpiration'
        name:
          type: string
        number:
          type: string
        type:
          type: string
    Package:
      type: object
      description: Object to manage a package
      additionalProperties: false
      properties:
        autocomplete:
          type: boolean
          description: Determines if "Review Before Completion" is enabled
        completed:
          type:
          - string
          - 'null'
          description: The date the transaction was completed
          format: date-time
        consent:
          type: string
          description: Consent
        data:
          type: object
          description: Custom meta data
          additionalProperties: {}
        description:
          type: string
          description: Package description
        documents:
          type: array
          description: List of package documents
          items:
            $ref: '#/components/schemas/Document'
        due:
          type:
          - string
          - 'null'
          description: The date the package will expire
          format: date-time
        emailMessage:
          type: string
          description: Message to be included emails to signers
        id:
          type: string
          description: Unique package Id
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        limits:
          description: Limits
          oneOf:
          - $ref: '#/components/schemas/PackageArtifactsLimits'
        messages:
          type: array
          description: Messages
          items:
            $ref: '#/components/schemas/Message'
        name:
          type: string
          description: Package name
        notarized:
          type: boolean
          description: Notarized
        notaryRoleId:
          type: string
          description: NotaryRoleId
        roles:
          type: array
          description: List of roles in the package
          items:
            $ref: '#/components/schemas/Role'
        conditions:
          type: array
          description: List of field conditions for the package
          items:
            $ref: '#/components/schemas/FieldCondition'
        sender:


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