Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeRecipients

Gets the status of recipients for an envelope.

Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.

The currentRoutingOrder property of the response contains the routingOrder value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Related topics

  • How to list envelope recipients
  • How to retrieve ID Evidence events
  • How to retrieve ID Evidence media
get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

include_anchor_tab_locationsstring

When true and include_tabs value is set to true, all tabs with anchor tab properties are included in the response.

include_extendedstring

When true, the extended properties are included in the response.

include_metadatastring

Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).

include_tabsstring

When true, the tab information associated with the recipient is included in the response.

Response

Successful response.