Sertifi API Documentation
Glossary
The Site specific code used for API interactions. Can be found by logging onto your sertifi site, then going to Administration -> Account Settings.
Example API code: ABCDEFGH-1234-IJKLMNOPQ-567890123456
A document refers to a word or pdf document which either serves as a reference or requires a signature from all the signers associated with the file.
Exception to requiring a signature from all signers: Using Consolidated Signing some signers might not be required to explicitely sign every document in a file, however Sertifi maintains a record that such documents were displayed to everyone who signed when they signed the other documents in the file.
Document Id
A unique Id Sertifi gives to each document uploaded to the system.Document Identifier
A unique numeric identifier for the document.Document Library
A place in the web portal that you can use to store pdf documents within the Sertifi system so that the documents can be added to files using an id instead of uploading the pdf every time. It also stores reference documents and document templates.Document Name
The human readable name of a document so people know what it is. (ie: Patient Medical History)
A grouping of signable documents, reference documents, payments, signers, Carbon Copies (CCs), etc. Files relate to a transaction or series of transactions between the signers in the file.
Files are sometimes also referred to as Folders or Rooms.
File Id
A unique Id given to each file created in the system.File Name
A name associated with each file that people can use to tell the files apart. (for example: Leasing Documents for 1234 Some Street)
Owner
The user who created the file and is assumed to have interest in or responsibility for the signing process for the documents in the file.
Prefill
Data (typically supplied in XML format) for a specific document that gets filled in on the signing page by Sertifi.
There are 2 possible meanins for Request:
1) It normally refers to a File.
2) It could refer to a specific "request to sign" between a specific signer and a specific document.
Someone in the second group to be able to sign a document.
See Also: Signer
Someone listed as needing to sign a document.
If signers must sign in a particular order, the signers get referred to by the order they are expected to sign in. (first signer, second signer, etc.)
Conceptually: Signers get broken up into groups called "Signer Level". Each Signer Level gets access to sign documents in a file at the same time, can only sign after everyone at the previous signer level finishes signing all documents, and must sign all documents before anyone in the next signer level may sign.
Concretely: Each signer in a file gets associated with one or more signer levels. When a signer level becomes ready for signatures, all signers associated with that level will receive an invite email to sign the documents and have the ability to sign the documents. If a signer is associated with multiple signing levels, they will be invited and required to sign at each level they are associated with.
Stream
The page that lists all the signing documents, payments and comments from which signers can select documents to sign and proceed to the signing page.
Template
A document with fields pre-added to it so that, when the template is applied, those fields get added to the document all at once instead of one at a time. Multiple templates can be made for one document, and used interchangably.
Web Portal
The sertifi site, often specified to a specific client. For example: http://www.sertifi.com/sales is the web portal for the Sertifi Sales department.