Kickserv APIv2 - Signatures Object

This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not. You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.

Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.

When a signature is requested a signature object is created. These can all be seen in the web UI by viewing the estimate and scrolling down to the signature section. Multiple signature requests can exist at the same time, and all three documents (estimate, work order, and invoice) can have signatures attached to them. If a live signature is captured as opposed to a customer signing after receive the document via email, some of the fields will be null. Even if there's only one signature, the data is stored and returned in an array.

If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.

Back to object map list

[
{
"signature": {
"id": 6677889900,
"account_id": 999,
"signable_id": 39028231,
"signable_type": "Job",
"sender_id": 445566,
"recipient_id": 23232323,
"recipient_type": "Customer",
"alternate_recipient_name": null,
"alternate_recipient_email": "[\"customer@email_address.com\"]",
"sent_at": "2022-04-22T16:45:52-04:00",
"reason": "",
"signature": {
"url": "https://url/signature.png",
"thumb": {
"url": "https://url/thumb_signature.png"
}
},
"signer_id": null,
"signer_type": null,
"alternate_signer_name": "",
"signed_at": "2022-05-09T14:41:34-04:00",
"document_type": "estimate",
"created_at": "2022-04-22T16:45:52-04:00",
"updated_at": "2022-05-09T14:41:34-04:00"
}
}
]