Types

Signature

One signatory's part of a signature request: who is to sign, where it stands and, once signed, the signed PDF. Investors and advisors see only their own. The ip address, user agent and hashes are not exposed.

idrequired
string (uuid)
The signature's id.
signature_request_idrequired
string (uuid)
The signature request this signature belongs to.
document_idrequired
string (uuid)
The document the request asks to have signed.
statusrequired
string
Where the signature stands. A signature with no recorded status is shown as not_initialised.One of: pending, signed, verified, rejected, not_required, not_initialised, initialising, declined, withdrawn, error
signatoryrequired
object
Who is to sign.
signatory_namerequired
string | null
The name written on the signature, or null before it is signed.
signed_document_idrequired
string | null (uuid)
The signed PDF, as an ordinary document: download it with GET /documents/{documentId}/download. Null for an electronic signature, whose proof is a certificate, and before signing.
signed_using_methodrequired
string | null
How the signature was captured, or null before it is signed.
signing_methodsrequired
string[]
The ways the signatory was offered to sign. Empty when none are recorded.
captured_atrequired
string | null (date-time)
When the signature was captured, or null before it is signed.
reasonrequired
string | null
The reason given when the signature was rejected or declined, or null.
errorrequired
string | null
The error the signing provider reported, or null.
created_atrequired
string (date-time)
When the signature was requested.
updated_atrequired
string (date-time)
When the signature last changed.

Used by (3)