oksign_get_credits
Get credits and storage
The account's remaining credits (quantity), when they expire (validuntil), the plan (subscription), whether it is paid, and storage used (account_size) versus the maximum (max_account_size) in bytes. GET /v1/credits/retrieve.
Takes no parameters.
oksign_list_users
List users
The users of the OKsign account: name, email, mobile, role, status, language and the immutable signerid (use it to tell who signed). GET /v1/users/retrieve.
Parameterslimitoffset
oksign_list_email_templates
List email templates
The email templates defined in the account: id, name, subject, HTML body, reminder_days and repeat. GET /v1/email-templates/retrieve.
Parameterslimitoffset
oksign_list_contacts
List contacts
The account's contact list: name, email, mobile, actingas (capacity) and group. GET /v1/contacts/retrieve.
Parameterslimitoffset
oksign_list_active_documents
List active documents
Documents in the account's Active Documents tab: docid, filename, creator, createdate, signatures required/valid, orgtoken, status (1 active, 10 briefcase, 11 document in a briefcase, 12 reusable, 14 template), viaapi and signed_docid when signed. OKsign allows this call only once every 3 minutes (429 otherwise). GET /v1/documents/active.
Parameterslimitoffsetsignedorgtokenfilename_contains
oksign_list_signed_documents
List signed documents
Documents uploaded through the API that were signed between two moments: signed_docid, source_docid, filename, signerid, signing source, signature counts, completed fields, credits per signer and timestamp. Keep the window short; OKsign allows this call only once every 3 minutes (429 otherwise). GET /v1/documents/signed.
Parametersendrequiredlimitstartrequiredoffset
oksign_list_notification_errors
List email and SMS delivery errors
Email and SMS delivery problems (hard_bounce, soft_bounce, blocked, spam, invalid_email, deferred) for signing invitations sent between two moments: recipient, source_docid, reason, orgtoken and timestamp. Only error events are reported. OKsign allows this call only once every 3 minutes (429 otherwise). GET /v1/webhooks/retrieve.
Parametersendrequiredlimitstartrequiredoffset
oksign_document_exists
Check a document exists
Whether a (signed) document still exists on the platform; returns its filename and whether it is a template. GET /v1/document/exists.
Parametersdocidrequired
oksign_get_document_metadata
Get signed document metadata
Metadata of a signed document (pass the signed_docid): filename, size, signatures required/valid, who signed, and the values of all completed fields (can contain personal data). Metadata v2. GET /v2/metadata/retrieve.
Parameterssigned_docidrequired
oksign_get_form_descriptor
Get a document's form descriptor
The form descriptor of an uploaded document: its signature and form fields (type, page, position, signer, required, signing options) and the signing URL of each signer. The URLs let their holders sign, so share them only with the signer. GET /v1/formdesc/retrieve.
Parametersdocidrequired
oksign_get_linked_document
Find the source or signed copy of a document
Given a source_docid, the signed_docid of its signed copy (absent if not signed yet) and the timestamp; given a signed_docid, the source_docid. An empty result means the document never existed here or was removed. GET /v1/linkedlist/retrieve.
Parametersdocidrequired
oksign_upsert_contacts
Add or update contacts
WRITE: add contacts to the account's contact list, or update them when a contact with the same email AND name exists (its other fields are replaced). Existing contacts are never cleared. Contacts OKsign rejects are skipped and reported. POST /v1/contacts/upload.
Parameterscontactsrequired
oksign_remove_contacts
Remove contacts
WRITE: permanently remove contacts from the account's contact list. A contact is identified by its email AND name. Cannot be undone (re-add with oksign_upsert_contacts). POST /v1/contacts/remove.
Parameterscontactsrequired
oksign_remove_document
Remove a document
WRITE: permanently remove a (signed) document from the OKsign platform. This deletes the file and its pending webhook events and cannot be undone. A signed document removed right after its callback may answer 'Too soon': retry later. DELETE /v1/document/remove.
Parametersdocidrequired