Skip to main content

Get Docusign envelope and recipient status

GET 
/esignature/docusign/:documentId/envelopes/:envelopeId

Retrieves the DocuSign envelope using include=recipients and returns the DocuSign response directly, including envelope status and recipient routing information. No FormKiQ fields or wrapper are added. The envelope must be associated with the selected document or artifact. This read-only operation does not update document attributes or download the signed document. Available as an Add-On Module. Repeated status polling must be at least 15 minutes apart. Use recipients.signers[].recipientId from this response as entries in the optional recipientIds array in POST /esignature/docusign/{documentId}/envelopes/{envelopeId}/reminders to request reminders for selected signers.

Request​

Path Parameters

    documentId stringrequired

    Document Identifier

    envelopeId stringrequired

    Docusign Envelope Id

Query Parameters

    siteId string

    Site Identifier

    artifactId string

    Artifact Document Identifier

    environment DocusignEnvironment

    Possible values: [PRODUCTION, DEVELOPMENT]

    DocuSign environment. Defaults to the site's docusignEnvironment; required when the site has no default. Use the environment in which the envelope was created.

Responses​

DocuSign envelope with recipients

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    envelopeId string

    DocuSign envelope identifier

    status string

    Envelope status reported by DocuSign, such as created, sent, delivered, signed, completed, declined, or voided.

    statusChangedDateTime date-time

    Time DocuSign reports the envelope status changed

    sentDateTime date-time
    deliveredDateTime date-time
    completedDateTime date-time
    declinedDateTime date-time
    voidedDateTime date-time

    recipients

    object

    Recipient information returned by DocuSign

    recipientCount string

    Number of recipients, represented as a DocuSign string

    currentRoutingOrder string

    Current routing step. Match this to recipient routingOrder and inspect recipient status to identify outstanding actions. Multiple recipients can share a routing order. Also check envelope status before treating a recipient as awaiting action.

    signers

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • inPersonSigners

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • agents

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • editors

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • intermediaries

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • carbonCopies

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • certifiedDeliveries

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • witnesses

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • seals

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • notaries

    object[]

  • Array [

    • recipientId string
    recipientIdGuid string
    recipientType string
    name string
    email string
    signerName string
    signerEmail string
    hostName string
    hostEmail string
    routingOrder string
    status string

    Recipient status reported by DocuSign

    sentDateTime date-time
    deliveredDateTime date-time
    signedDateTime date-time
    declinedDateTime date-time

  • ]

    • property name* any

    Recipient information returned by DocuSign

    property name* any

    The DocuSign Get Envelope response with include=recipients, returned without enrichment. Additional DocuSign fields are preserved. Optional fields are returned only when supplied by DocuSign. A completed envelope does not confirm that FormKiQ has stored the signed PDF.

Loading...