KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. DocuSign
  • DocuSign
    • Overview
    • List a XC request's DocuSign envelopes
      GET
    • Get an embeded URL signature for a XC Request
      GET
    • Regenerate a URL signature for the current signer
      GET
    • List the order of signers of a DocuSign Envelope
      GET
    • Create a DocuSign envelope for a XC request
      POST
    • Resend email & recover URL signature for a XC request
      POST
    • Create a DocuSign envelope for multiple signers
      POST
  • XC Client Prices
    • Overview
    • List XC client prices
      GET
    • Get a XC client's price
      GET
    • Create a XC client's price
      POST
    • Update a XC client's price
      PATCH
    • Delete a XC client's price
      DELETE
  • XC Comments
    • Overview
    • List XC comments
      GET
    • Get a XC comment
      GET
    • Create a XC comment
      POST
    • Update a XC comment
      PATCH
    • Delete a XC comment
      DELETE
  • XC Connections
    • Overview
    • List XC connections
      GET
    • Get a XC connection
      GET
    • Create a XC connection
      POST
    • Update a XC connection
      PATCH
    • Delete a XC connection
      DELETE
  • XC Contract Settings
    • Overview
    • List XC contract settings
    • Get a XC contract setting
    • Get a XC Request's contract setting
    • Create a XC contract setting
    • Update a XC contract setting
    • Delete a XC contract setting
  • XC Contract Setting Participants
    • Overview
    • List all XC contract settings participants
    • List a XC contract settings participants
    • Get a XC contract settings participant
    • Create a XC contract settings participant
    • Update a XC contract settings participant
    • Delete a XC contract settings participant
  • XC Data Centers
    • Overview
    • List XC datacenters
    • Create a XC datacenter
    • Update a XC datacenter
    • Delete a XC datacenter
  • XC Documents
    • Overview
    • List XC documents
    • Get a XC document's metadata
    • Get a XC document download URL
    • Get a XC document binary file
    • Upload a XC document
    • Delete a XC document
  • XC Reports
    • Overview
    • Download XC requests report
    • Download XC satisfaction survey report
    • Download XC connections report
  • XC Requests
    • Overview
    • List XC requests
    • Get a XC request
    • Get a XC request (complete details)
    • Create a XC request
    • Upsert a XC request draft
    • Update a XC request's general data
    • Change a XC request's status
    • Delete a XC request
    • Revert a XC request to Revision
  • XC Salesforce
    • Overview
    • Accounts
      • Overview
      • List accounts
      • Get an account
    • Opportunities
      • Overview
      • Attachments
        • Overview
        • List opportunity attachments
        • Upload an opportunity attachment
        • Download an opportunity file
      • List opportunities
      • Get an opportunity
      • Create an opportunity
      • Update an opportunity
    • Products
      • Overview
      • List products
      • Get a product
    • Project Requests
      • Overview
      • List project requests
      • Get a project request
      • Create a project request
      • Update a project request
    • Users
      • Overview
      • List users
      • Get a user
    • XC/IC Requests
      • Overview
      • Attachments
        • Overview
        • List XC/IC attachments
        • Upload a XC/IC attachment
        • Download a XC/IC file
      • List XC/IC requests
      • List all KIO Link connections from Salesforce XC/IC requests
      • Get a XC/IC request
      • Create a XC/IC request
      • Update a XC/IC request
  • XC Satisfaction Survey
    • Overview
    • List XC satisfaction surveys
    • Get a XC satisfaction survey
    • Get a XC satisfaction survey per user
    • Create XC satisfaction survey
  • XC Statuses
    • Overview
    • List XC statuses
    • Get a XC status
    • Create a XC status
    • Update a XC status
    • Delete a XC status
  • XC Status Histories
    • Overview
    • List XC status histories
    • List XC status history time summary
    • Get a XC status history record
  • Schemas
    • DocuSign
      • DocuSign Envelope Signer
      • DocuSign Signing URL Result
      • DocuSign Signer Routing
      • DocuSign Resend Result
      • DocuSign Envelope
    • XC Client Prices
      • XC Client Price
    • XC Comments
      • XC Comment
    • XC Connections
      • XC Connection
    • XC Contract Settings
      • XC Contract Setting
    • XC Contract Setting Participants
      • XC Contract Setting Participant
    • XC Data Centers
      • XC Datacenter
    • XC Documents
      • XC Document
    • XC Requests
      • XC Request With Relations
      • XC Request List Item
      • XC Request
      • XC Request With Details
    • XC Salesforce
      • Salesforce Connection
      • Salesforce Account
      • Salesforce User
      • Salesforce Product
      • Salesforce Opportunity List Item
      • Salesforce Opportunity
      • Salesforce Opportunity Write Result
      • Salesforce Attachment
      • Salesforce Attachment Upload Result
      • Salesforce Attachment Download Result
      • Salesforce Request List Item
      • Salesforce Request Point
      • Salesforce Request
      • Salesforce Request Write Result
      • Salesforce Project Request
      • Salesforce Project Request Write Result
      • Salesforce Quote
      • Salesforce Quote Line
    • XC Satisfaction Surveys
      • XC Satisfaction Survey
    • XC Statuses
      • XC Status
    • XC Status Histories
      • XC Status Time
      • XC Status Stage Time
      • XC Status History
    • Error
    • Date Metadata
    • Pagination Metadata
  1. DocuSign

Overview

DocuSign#

Endpoints for generating, signing, tracking, and resending DocuSign envelopes for an XC (Cross-Connect) request's SOW and Acta de Entrega documents.

Concepts#

Envelope: a document package sent to DocuSign for signature, stored in docusign_envelopes. It's created from an existing base document on the request (SOW_GENERADO or ACTA_ENTREGA, or an explicit base_document_id).
document_type: either SOW or ACTA_ENTREGA — determines which base document is used and which signed document type is produced once completed (SOW_FIRMADO / ACTA_ENTREGA_FIRMADA).
Single vs. multiple signers: an envelope can have one signer (embedded signing, clientUserId set) or several signers who sign sequentially by routing_order (remote signing — DocuSign emails each one automatically once the previous signer completes).
Signing link / redirect: created envelopes are shared with signers as a link to GET /xc/requests/signing/redirect/:token, which resolves a secure per-envelope token to a fresh DocuSign signing URL and redirects the signer there. This avoids DocuSign's signing URLs expiring after a few minutes.
Webhook: DocuSign notifies status changes (sent, delivered, completed, declined, voided) via POST /webhooks/docusign (documented in the XC Webhook folder). On completion, the signed PDF is downloaded and stored as an xc_document, and the related XC request's status is advanced automatically (SOW signed → IMPLEMENTACIÓN, Acta signed → COMPLETA).

Endpoints#

Create a DocuSign Envelope for a XC Request#

POST /v1/xc/requests/{id}/signing/envelopes
Creates a single-signer envelope and emails the signer a signing link.

Create a DocuSign Envelope for multiple signers#

POST /v1/xc/requests/{id}/signing/envelopes/multiple-signers
Creates an envelope with 1–100 signers who sign in order of routing_order.

List a XC Request's DocuSign Envelopes#

GET /v1/xc/requests/{id}/signing/envelopes
Lists envelopes for a request, optionally filtered by document_type and/or status.

Get an embeded URL signature for a XC Request#

GET /v1/xc/requests/{id}/signing/url
Returns a fresh embedded signing URL for the latest envelope of a document type (single-signer flow only).

Regenerate a URL signature for the current signer#

GET /v1/xc/envelopes/{envelopeId}/signing/url/regenerate
Public endpoint that regenerates a signing URL for whichever signer is currently active in the routing order — used when a signer's link has expired.

Resend email & recover URL signature for a XC Request#

POST /v1/xc/requests/{id}/signing/envelopes/resend
Resends the signing notification: DocuSign's native resend for multi-signer envelopes, or a custom email with a new link for single-signer envelopes.

List the order of signers of a DocuSign Envelope#

GET /v1/xc/envelopes/{docusignEnvelopeId}/signing/signers/routing
Returns previous_signers, current_signer, and next_signers for a multi-signer envelope, synced from DocuSign's recipient statuses.

Status values#

CREATED, SENT, DELIVERED, COMPLETED, DECLINED, VOIDED, EXPIRED.

Source#

Router: routes/v1/xc/docusign-envelopes.router.js
Controller: controllers/xc/docusign-envelopes.controller.js
Service: services/xc/docusign-envelopes.service.js
DocuSign client: services/docusign.js
Entities: entities/docusign-envelope.js, entities/docusign-envelope-signer.js
Modified at 2026-09-25 00:03:33
Next
List a XC request's DocuSign envelopes
Built with