getDocuSignStatus
Retrieves the status of the specified DocuSign envelope, such as one created and sent by the sendToDocuSign command.
The status, as reported by the DocuSign API, can be one of the following:
completed - The envelope has been completed and all tags have been signed.
created - The envelope is created as a draft. It can be modified and sent later.
declined - The envelope has been declined by the recipients.
delivered - The envelope has been delivered to the recipients.
sent - The envelope is sent to the recipients.
signed - The envelope has been signed by the recipients.
voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
Attributes
envelopeStatusVar | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | No |
Defines the name of the variable that will hold the status of the envelope as a String. | ||
envelopeId | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | Yes |
Defines the ID of the DocuSign envelope whose status is retrieved. | ||
username | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | Yes |
Defines the user name for DocuSign API authentication. The resolved value is expected to be the DocuSign user's email login or API username. | ||
password | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | Yes |
Defines the password for DocuSign API authentication. | ||
integratorKey | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | Yes |
Defines the integrator key for DocuSign API authentication. | ||
environment | ||
|---|---|---|
Required | Value type | EL-evaluated |
Yes | String | Yes |
Defines if the API is used in production or demo environment. The resolved value is expected to be either "production" or "demo" (case insensitive) - any other value or the value being undefined will produce an error. | ||