> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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).

<Tip>
  Package status will not contain links unless you set generateSignerLinks to true when calling packages/add.
</Tip>

## Request

```http Request theme={null}
GET /packages/{packageId}/status
```

### Parameters

<ParamField body="packageId" type="string" required>
  Unique identifier of the package to retrieve status for.
</ParamField>

## Response

<ResponseField name="packageId" type="string">
  Unique identifier for the package.
</ResponseField>

<ResponseField name="organizationId" type="string">
  Unique identifier for the organization.
</ResponseField>

<ResponseField name="memberId" type="string">
  Unique identifier for the member who owns the package.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the package.
</ResponseField>

<ResponseField name="timeSignBy" type="string">
  Date by which the package should be signed (ISO 8601 format).
</ResponseField>

<ResponseField name="type" type="string">
  Type of the package.

  <Expandable title="values">
    | Value                | Description                                                                                     |
    | :------------------- | :---------------------------------------------------------------------------------------------- |
    | concurrent           | **Concurrent**: Allows multiple signers to sign the document simultaneously.                    |
    | Sequential           | **Sequential**: Requires signers to sign the document in a specific order.                      |
    | Counterpart          | **Group Send**: Enables group signing, where all signers receive the document at the same time. |
    | video\_closing\_room | **Video Signing Room**: A virtual room for signing documents via video conference.              |
    | Live Session         | **In Person**: An in-person signing session with all parties present.                           |

    <Note>
      Even though the signing workflow names have evolved, the constants used to identify them have remained the same.
    </Note>

    <Tip>
      The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.
    </Tip>
  </Expandable>
</ResponseField>

<ResponseField name="state" type="string">
  Current state of the package.

  <Expandable title="values">
    <Tip>
      New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.
    </Tip>

    <Note>
      Release 4.0 introduces two new package states, `executed` and `expired`. In 3.6 both executed and expired packages were in an `open` state.
    </Note>

    | Value     | Version | Description                                                                                                                                                                                                                                                                                                          |
    | :-------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | draft     | 1.0     | Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.                                                                                                                    |
    | open      | 1.0     | The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.                                                                                                                                                                                                                   |
    | executed  | 4.0     | The package has been fully executed by all signers.                                                                                                                                                                                                                                                                  |
    | expired   | 4.0     | The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.                                                                                                                                                                              |
    | rescinded | 3.5     | The package was rescinded and is no longer available for signing.                                                                                                                                                                                                                                                    |
    | select    | 3.6     | Use the select state only when the package will be opened in the **embedded package editor** and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.                                    |
    | add       | 2.9     | Use the add state only when the package will be opened in the **embedded package editor** and you want the workflow to function as if you're creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours. |
  </Expandable>
</ResponseField>

<ResponseField name="externalData" type="object" post={["nullable"]}>
  External data associated with the package.
</ResponseField>

<ResponseField name="isExecuted" type="boolean">
  Set to `true` if all documents have been signed by all signers.
</ResponseField>

<ResponseField name="documents" type="object[]">
  List of documents in the package.

  <Expandable title="properties">
    <ResponseField name="packageId" type="string">
      Unique identifier for the package.
    </ResponseField>

    <ResponseField name="documentId" type="string">
      Unique identifier for the document.
    </ResponseField>

    <ResponseField name="fileId" type="string">
      Unique identifier for the file associated with the document.
    </ResponseField>

    <ResponseField name="externalId" type="string" post={["nullable"]}>
      External system identifier for the document, if available.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the document.
    </ResponseField>

    <ResponseField name="fileName" type="string">
      File name of the document.
    </ResponseField>

    <ResponseField name="order" type="number">
      Order of the document in the package.
    </ResponseField>

    <ResponseField name="isExecuted" type="boolean">
      Set to `true` if document has been signed by all signers.
    </ResponseField>

    <ResponseField name="revisions" type="object[]">
      List of revisions for the document.

      <Expandable title="Properties">
        <ResponseField name="packageId" type="string">
          Unique identifier for the package.
        </ResponseField>

        <ResponseField name="documentId" type="string">
          Unique identifier for the document.
        </ResponseField>

        <ResponseField name="revisionId" type="string">
          Unique identifier for the revision.
        </ResponseField>

        <ResponseField name="signerId" type="string">
          Unique identifier for the signer.
        </ResponseField>

        <ResponseField name="link" type="string">
          Link for signer to sign their revision of document.
        </ResponseField>

        <ResponseField name="isNext" type="boolean">
          Set to `true` if signer is next signer in sequential signing.
        </ResponseField>

        <ResponseField name="isSigned" type="boolean">
          Set to `true` if signer has signed their revision of document.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="signers" type="object[]">
  List of signers for the package.

  <Expandable title="properties">
    <ResponseField name="signerId" type="string">
      Unique identifier for the signer.
    </ResponseField>

    <ResponseField name="firstName" type="string">
      First name of the signer.
    </ResponseField>

    <ResponseField name="lastName" type="string">
      Last name of the signer.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email address of the signer.
    </ResponseField>

    <ResponseField name="mobileNumber" type="string">
      Mobile number of the signer.
    </ResponseField>

    <ResponseField name="order" type="number">
      Order of the signer in the signing process.
    </ResponseField>

    <ResponseField name="links" type="object[]">
      List of signing links for the signer.

      <Expandable title="properties">
        <ResponseField name="token" type="string">
          Token for the signing link.
        </ResponseField>

        <ResponseField name="packageId" type="string">
          Unique identifier for the package.
        </ResponseField>

        <ResponseField name="documentId" type="string">
          Unique identifier for the document.
        </ResponseField>

        <ResponseField name="revisionId" type="string">
          Unique identifier for the revision.
        </ResponseField>

        <ResponseField name="name" type="string">
          Name of document.
        </ResponseField>

        <ResponseField name="link" type="string">
          Link for signer to sign their revision of document.
        </ResponseField>

        <ResponseField name="timeExpires" type="string">
          Time link expires (ISO 8601 format).
        </ResponseField>

        <ResponseField name="type" type="string">
          Link type.
        </ResponseField>

        <ResponseField name="isNext" type="boolean">
          Set to `true` if signer is next signer in sequential signing.
        </ResponseField>

        <ResponseField name="isSigned" type="boolean">
          Set to `true` if signer has signed their revision of document.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Examples

```json Response (200) expandable  theme={null}
{
    "packageId": "7a17e4e7-bc32-4256-bf81-27eac794c2b7",
    "organizationId": "24261ee6-5f66-4692-ba49-533c9b58999b",
    "memberId": "3e09a4ce-577c-492c-ba7c-c1ebf825f9b5",
    "name": "My First Signing",
    "timeSignBy": "2022-03-02T20:08:41Z",
    "type": "Sequential",
    "state": "open",
    "externalData": null,
    "isExecuted": false,
    "documents": [
        {
            "packageId": "7a17e4e7-bc32-4256-bf81-27eac794c2b7",
            "documentId": "ad8eac67-94e9-481b-a799-7396b447b8eb",
            "fileId": null,
            "exernalId": null,
            "name": null,
            "fileName": "agreement.pdf",
            "order": 0,
            "isExecuted": false,
            "revisions": [
                {
                    "packageId": "7a17e4e7-bc32-4256-bf81-27eac794c2b7",
                    "documentId": "ad8eac67-94e9-481b-a799-7396b447b8eb",
                    "revisionId": "a53b203b-af52-4766-a8be-eb0cdd18eb5f",
                    "signerId": "229c1a3b-c9d3-4546-bcf5-44cb8ea3bd1c",
                    "link": "https://localhost/tws/link/BKhD5EA0Dw6o0fv7-p3wnw",
                    "isNext": true,
                    "isSigned": false
                }
            ]
        }
    ],
    "signers": [
        {
            "signerId": "229c1a3b-c9d3-4546-bcf5-44cb8ea3bd1c",
            "firstName": "Signer",
            "lastName": "One",
            "email": "signer.one@example.com",
            "mobileNumber": "",
            "order": 0,
            "links": [
                {
                    "name": "agreement",
                    "link": "https://localhost/tws/link/BKhD5EA0Dw6o0fv7-p3wnw",
                    "type": "document",
                    "token": "BKhD5EA0Dw6o0fv7-p3wnw",
                    "timeExpires": "2022-03-02T20:08:41.261Z",
                    "packageId": "7a17e4e7-bc32-4256-bf81-27eac794c2b7",
                    "documentId": "ad8eac67-94e9-481b-a799-7396b447b8eb",
                    "revisionId": "a53b203b-af52-4766-a8be-eb0cdd18eb5f",
                    "isNext": true,
                    "isSigned": false
                }
            ],
            "signLink": {
                "name": "My First Signing",
                "link": "https://localhost/tws/link/MnWkMecgfNjfFZsye1YJmg",
                "type": "package_sign",
                "token": "MnWkMecgfNjfFZsye1YJmg",
                "timeExpires": "2022-03-02T20:08:41.261Z",
                "packageId": "7a17e4e7-bc32-4256-bf81-27eac794c2b7"
            },
            "meetingLink": null
        }
    ]
}
```