v5

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-23254688.8 KB
signer

Get signer

Get status and details of an individual signer

get/signer/{signerId}/

Path parameters

signerIdstring required

ID of signer

Response

operation successful

documentstring
emailstring
first_namestring
last_namestring
has_fieldsboolean
orderinteger
resource_uristring
status4 | 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

Example response

{
  "document": "/api/v1/document/d0d0d0d0-d0fd0-d0d0-d0d0-d0d0d0d0d0d0/",
  "email": "joe.biggins@widgets.com",
  "first_name": "Joe",
  "has_fields": true,
  "last_name": "Biggins",
  "order": 0,
  "resource_uri": "/api/v1/signers/s0s0s0s0-s0s0-s0s0-s0s0-s0s0s0s0s0s0/",
  "status": 20
}