Skip to main content
GET
Status
At any time you can get the status of a package by calling packages/{packageId}/status endpoint. Depending on your needs you may want to process the documents or signers array (sometimes both).
Package status will not contain links unless you set generateSignerLinks to true when calling packages/add.

Request

Request

Parameters

string
required
Unique identifier of the package to retrieve status for.

Response

string
Unique identifier for the package.
string
Unique identifier for the organization.
string
Unique identifier for the member who owns the package.
string
Name of the package.
string
Date by which the package should be signed (ISO 8601 format).
string
Type of the package.
string
Current state of the package.
object
External data associated with the package.
boolean
Set to true if all documents have been signed by all signers.
object[]
List of documents in the package.
object[]
List of signers for the package.

Examples

Response (200)