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

# Remind signer

The `/packages/signers/remind` endpoint sends a reminder to one signer in a package that is available for signing.

For a Video Signing Room (VSR) package, the signer receives a meeting notification. For other package types, the signer receives a signing reminder.

## Request

```http Request theme={null}
POST /packages/signers/remind
{
  "packageId": "cf91071d-966d-41ea-b9bf-aa96a8e56c02",
  "signerId": "95d2f093-cd27-4d7f-bb51-442e98ad56e8"
}
```

### Body

<ParamField body="packageId" type="string" required>
  Unique identifier for the package containing the signer.
</ParamField>

<ParamField body="signerId" type="string" required>
  Unique identifier for the signer to remind.
</ParamField>

## Response

<ResponseField name="signer" type="object">
  Signer who received the reminder.

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

    <ResponseField name="packageId" type="string">
      Package identifier the signer belongs to.
    </ResponseField>

    <ResponseField name="memberId" type="string" post={["nullable"]}>
      Member identifier when the signer is an organization member. (optional)
    </ResponseField>

    <ResponseField name="signerTag" type="string">
      Tag associated with the signer. (optional)
    </ResponseField>

    <ResponseField name="timeCreated" type="string">
      When the signer record was created (ISO 8601).
    </ResponseField>

    <ResponseField name="timeDeclined" type="string" post={["nullable"]}>
      Time the signer declined (if applicable).
    </ResponseField>

    <ResponseField name="timeUpdated" type="string">
      Last update time for the signer record.
    </ResponseField>

    <ResponseField name="index" type="number">
      Signing order index.
    </ResponseField>

    <ResponseField name="locale" type="string" post={["nullable"]}>
      Locale for the signer. (optional)
    </ResponseField>

    <ResponseField name="signCac" type="boolean">
      Set to `true` if signer requires CAC signing.
    </ResponseField>

    <ResponseField name="verify" type="boolean">
      Set to `true` if signer requires identity verification before signing.
    </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 for the signer.
    </ResponseField>

    <ResponseField name="mobileNumberCountryCode" type="string" post={["nullable"]}>
      Country code for the mobile number. (optional)
    </ResponseField>

    <ResponseField name="mobileNumberOriginal" type="string" post={["nullable"]}>
      Original mobile number provided.
    </ResponseField>

    <ResponseField name="mobileNumber" type="string" post={["nullable"]}>
      Normalized mobile number (E.164) when available.
    </ResponseField>

    <ResponseField name="declineMessage" type="string" post={["nullable"]}>
      Message left by the signer when declining (if any).
    </ResponseField>

    <ResponseField name="declineReason" type="string" post={["nullable"]}>
      Reason code for decline (if applicable).
    </ResponseField>

    <ResponseField name="next" type="boolean">
      Set to `true` if this signer is next in signing order across the package.
    </ResponseField>

    <ResponseField name="revisionsSigned" type="number">
      Number of revisions the signer has signed.
    </ResponseField>

    <ResponseField name="revisionsCount" type="number">
      Number of revisions assigned to the signer.
    </ResponseField>

    <ResponseField name="role" type="string">
      Role of the signer.

      <Expandable title="values">
        | Value  | Description                                                             |
        | :----- | :---------------------------------------------------------------------- |
        | signer | Signer                                                                  |
        | guest  | Guest of VSR or In Person signing that is not a signer of any documents |
        | host   | Host of VSR or In Person signing                                        |
      </Expandable>
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of signer.

      <Expandable title="values">
        | Value  | Description                                                               |
        | :----- | :------------------------------------------------------------------------ |
        | signer | Signer                                                                    |
        | guest  | Signer that was added by the host during VSR or In Person signing session |
      </Expandable>
    </ResponseField>

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

      <Expandable title="values">
        | Value    | Description                                                     |
        | :------- | :-------------------------------------------------------------- |
        | active   | Signer that is actively participating in the signing process.   |
        | declined | Signer that has declined to participate in the signing process. |
        | deleted  | Signer that has been removed from the package.                  |
      </Expandable>
    </ResponseField>

    <ResponseField name="verification" type="object" post={["nullable"]}>
      Signer verification status. (if any)

      <Expandable title="properties">
        <ResponseField name="verificationId" type="string">
          Identifier for the verification record.
        </ResponseField>

        <ResponseField name="signerId" type="string">
          Signer identifier associated with this verification.
        </ResponseField>

        <ResponseField name="canSign" type="boolean">
          Set to `true` if the signer is can sign documents after verification.
        </ResponseField>

        <ResponseField name="canJoin" type="boolean">
          Set to `true` if the signer can join VSR after verification.
        </ResponseField>

        <ResponseField name="canRetry" type="boolean">
          Set to `true` if the signer may retry verification on failure.
        </ResponseField>

        <ResponseField name="hasSigned" type="boolean">
          Set to `true` if the signer has successfully signed after verification.
        </ResponseField>

        <ResponseField name="isLocked" type="boolean">
          Set to `true` if the verification is currently locked.
        </ResponseField>

        <ResponseField name="attempts" type="number">
          Number of verification attempts made.
        </ResponseField>

        <ResponseField name="errors" type="number">
          Number of errors encountered during verification.
        </ResponseField>

        <ResponseField name="continue" type="boolean">
          Whether the verification flow should continue to next step.
        </ResponseField>

        <ResponseField name="continueOnError" type="boolean">
          Whether to continue the flow when verification errors occur.
        </ResponseField>

        <ResponseField name="error" type="string" post={["nullable"]}>
          Current verification error code (if any).
        </ResponseField>

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

          <Expandable title="values">
            | State                | Description                                                                                     |
            | -------------------- | ----------------------------------------------------------------------------------------------- |
            | not\_started         | Signer has not started identity verification.                                                   |
            | start                | Signer is on start step.                                                                        |
            | consent              | Signer is on consent step.                                                                      |
            | consent\_processing  | Server is processing consent.                                                                   |
            | identity             | Signer is on identity verification step.                                                        |
            | identity\_processing | Server is processing identity verification.                                                     |
            | kba                  | Signer is on KBA verification step.                                                             |
            | kba\_processing      | Server is processing KBA verification.                                                          |
            | document             | Signer is on document verification step.                                                        |
            | document\_processing | Server is processing document verification.                                                     |
            | end                  | Server is finalizing identity verification result.                                              |
            | passed               | Identity verification has passed.                                                               |
            | failed               | Identity verification has failed and can be retried by signer.                                  |
            | failed\_reset        | Identity verification has failed and must be reset by package owner for signer to retry.        |
            | failed\_locked       | Identity verification has failed and is now locked and can no longer be reset by package owner. |
            | error                | A server error has occurred and can be retried by signer.                                       |
            | error\_reset         | A server error has occurred and must be reset by package owner for signer to retry.             |
            | error\_locked        | A server error has occurred and can no longer be reset by package owner.                        |
            | cancelled            | Identity verification has been cancelled.                                                       |
            | cancelled\_reset     | Identity verification has been cancelled due to package owner resetting signer's verification.  |
            | invalid              | Identity verification is in an invalid state and cannot be processed.                           |
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>