signatures.get
One signature request: the document text (or stored PDF id) and its sha256, and the signature when signed (who, typed name, consent text and its sha256, surface, time).
When to use it
One signature request: the document text (or stored PDF id) and its sha256, and the signature when signed (who, typed name, consent text and its sha256, surface, time).
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
signature_request_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/signatures/get?signature_request_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
signature_request_id | string (uuid) | yes |
shop_id | string (uuid) | yes |
job_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
customer_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
kind | string | yes |
subject_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
title | string | yes |
job_document_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
document_sha256 | string | yes |
signer_role | string | yes |
signer_email | ['string', 'null'] | yes |
status | string | yes |
created_by | string (uuid) | yes |
created_at | string (date-time) | yes |
cancelled_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
text | ['string', 'null'] | yes |
signature | | yes |
{
"signature_request_id": "00000000-0000-4000-8000-000000000000",
"shop_id": "00000000-0000-4000-8000-000000000000",
"job_id": "00000000-0000-4000-8000-000000000000",
"customer_id": "00000000-0000-4000-8000-000000000000",
"kind": "...",
"subject_id": "00000000-0000-4000-8000-000000000000",
"title": "...",
"job_document_id": "00000000-0000-4000-8000-000000000000",
"document_sha256": "...",
"signer_role": "...",
"signer_email": "...",
"status": "...",
"created_by": "00000000-0000-4000-8000-000000000000",
"created_at": "...",
"cancelled_at": "...",
"text": "...",
"signature": "..."
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |