API Console | Online Notary Center

Authentication

Exchanges an authorization code for an access token. Documentation ↗

Uses HTTP Basic auth with your client credentials — no bearer token needed. Get the code by opening the authorize page from the console settings above; you land back on your redirect URI with ?code=… in the query string. The returned access_token is saved into the console automatically.

Body — form fields (empty fields are skipped)

grant_type

code *

Trades a refresh token for a fresh access token. Documentation ↗

Body — form fields (empty fields are skipped)

grant_type

refresh_token *

Extends the token currently in the console to 365 days. Documentation ↗

No parameters — this request only needs the access token from the console.

Notary Sessions

Starts a notary session and uploads its documents. Documentation ↗

Body — file upload

files[] — PDF document(s) *

Replaces the signer list of a notary session. Documentation ↗

Body — JSON ({{variables}} are replaced with the console values on send)

Finalizes the session and returns the join link and passcode. Documentation ↗

Heads up — Sends the invitation to every signer on the session. Confirmation is asked before sending.

Body — JSON ({{variables}} are replaced with the console values on send)

Returns the current room state of a session. Documentation ↗

Path parameters

notary_id *

Downloads the notarized documents as a ZIP archive. Documentation ↗

Path parameters

notary_id *

Broadcasts a "new room" push to online notaries. Documentation ↗

Body — form fields (empty fields are skipped)

notary_id *

notarized_by

file_title

file_id

schedule_id

session_state

display_ringer

recipients

eSign Sessions

Starts an eSign session and uploads its documents. Documentation ↗

Body — file upload

files[] — PDF document(s) *

Replaces the signer list of an eSign session. Documentation ↗

Body — JSON ({{variables}} are replaced with the console values on send)

Activates the files and returns the signing links. Documentation ↗

Body — JSON ({{variables}} are replaced with the console values on send)

Sends a saved template out for signature in one call. Documentation ↗

Heads up — Emails a signing link to every signer you list. Confirmation is asked before sending.

Body — JSON ({{variables}} are replaced with the console values on send)

Templates & Partners

All active templates created by a user. Documentation ↗

Path parameters

user_id *

Signer roles defined on a template. Documentation ↗

Path parameters

notary_id *

Custom fields defined on a template. Documentation ↗

Path parameters

notary_id *

Template sessions of a user, newest first. Documentation ↗

Path parameters

user_id *

Fills a template and emails every contact a join link. Documentation ↗

Heads up — Emails a join link and passcode to every contact you list. Confirmation is asked before sending.

Path parameters

notary_id *

Body — JSON ({{variables}} are replaced with the console values on send)

Downloads the signed document of a template session. Documentation ↗

Path parameters

file_id *

session_id *

Removes a template session and its contacts. Documentation ↗

Heads up — Permanently removes the session and its contacts. Confirmation is asked before sending.

Path parameters

session_id *