Skip to main content

Polls the ESS to get the latest status & update all envelopes that havent been sent or completed

GET 
/organisations/ess/poll

polls docusign for all envelope statuses and updates the resources accordingly

Request​

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Responses​

External Signing Service Poll All response

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • OrganisationId OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    EssEnvelopeId ExternalSigningServiceEnvelopeId (string)

    Possible values: Value must match regular expression ^[^<>]*$

    The envelope id of the ess signing request

    ExternalSigningServiceEnvelopeStatus ExternalSigningServiceEnvelopeStatus

    Possible values: [completed, created, declined, deleted, delivered, processing, sent, signed, template, voided, expired, reissued]

  • ]

Loading...