Get package status - Nitro APIs

GET

/

packages

/

{packageId}

/

status

Error

A valid request URL is required to generate request examples

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

packageId

string<guid>

required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

OK

The status of a package

Update package statusUpdates the status of a package. Only two transitions are supported: - **Draft → Pending.** When the package is ready, set it to `pending` to send it to the stakeholders. The package then becomes visible to each stakeholder in their Signer Portal. - **Pending → Revoked.** A package that has been sent but not yet completed - or whose signing has failed - can be revoked. Once revoked, stakeholders can no longer act on it. The new status is the request body itself (for example `"pending"`), not a named field: send only the bare value, not `{"Status": "pending"}`.

Error

A valid request URL is required to generate request examples

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]