Get signing documents status

Shortened faster query for status of signing documents

Query Parameters

• filter string

  Filter on archived status, default is false

• offset integer

  Offset from start of dataset. Use with the limit query to iterate through dataset.

• limit integer

  Length of dataset to return. Use with offset query to iterate through results.

Responses

• 200

---

operation successful

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  limit int32

  next string

  offset int32

  previous string

  total_count int32

  total number of objects

• objects object[]

  archived boolean

  resource_uri string

  status integer

  Possible values: [4, 5, 10, 15, 20, 30, 35, 39, 40, 50, 60]

  Signer status options:

  • 4 - unsent
  • 5 - scheduled to be sent
  • 10 - sent
  • 15 - email opened
  • 20 - visited
  • 30 - fields complete
  • 35 - fields complete ex signature
  • 39 - waiting for witness to complete
  • 40 - signed
  • 50 - downloaded
  • 60 - rejected

  download_final boolean

  tag string

  tag1 string

  tag2 string

{
  "meta": {
    "limit": 0,
    "next": "string",
    "offset": 0,
    "previous": "string",
    "total_count": 0
  },
  "objects": [
    {
      "archived": false,
      "download_final": false,
      "resource_uri": "/api/v1/status/f0f0f0f0-f0f0-f0f0-f0f0-f0f0f0f0f0f0/",
      "status": 10,
      "tag": "contract2020",
      "tag1": "userRef",
      "tag2": "otherRef"
    }
  ]
}

Loading...