Get started

Overview Quickstart Authentication MCP (AI agents)Errors Versioning Pagination & jobs

Core concepts

Signing Workflows Contacts Document vault Verification AI Notifications

API reference

Authentication

Overview POSTLogin POSTRegister POSTSocial login POSTRequest password reset POSTReset password POSTSend login MFA email POSTVerify login MFA POSTLogin WebAuthn options POSTVerify login WebAuthn POSTResend email verification GETVerify email GETDownload a certificate file POSTSend external identity code POSTVerify external identity code GETList external identities POSTRevoke an external identity POSTLogout GETIntrospect the current token GETList colleagues GETShow profile PATCHUpdate profile DELETEDelete profile seal PATCHChange password GETShow availability PUTUpdate availability GETShow certificate status POSTCreate a signature image PATCHUpdate a signature image DELETEDelete a signature image POSTSend step-up email OTP POSTVerify step-up email OTP GETMFA enrollment status POSTSend MFA email enrollment code POSTConfirm MFA email enrollment DELETEDisable MFA email POSTStart TOTP enrollment POSTConfirm TOTP enrollment DELETEDisable TOTP POSTWebAuthn registration options POSTRegister a WebAuthn credential DELETERemove a WebAuthn credential GETList roles POSTCreate role GETShow role PUTReplace role DELETEDelete role GETList company users PATCHActivate or deactivate a user PATCHAssign a company role POSTReset an employee MFA enrollment GETList company certificates GETList certificate requests POSTRenew a certificate POSTRevoke a certificate POSTRequest a replacement certificate GETCheck certificate revocation GETShow company quotas GETShow allowed signature levels GETShow license POSTActivate license GETList MFA enrollments GETShow security settings PUTUpdate security settings GETList company external identities POSTRevoke a company external identity

Workflows

Overview GETGet workflows trends GETGet workflows completed documents list GETGet workflows cancelled documents list GETGet workflows documents signed list GETGet workflows signature-level impact GETList workflows POSTCreate a workflow GETGet workflows show PUTUpdate a workflow DELETEDelete workflows delete POSTRelaunch a returned workflow GETGet workflows transactions all GETTake a workflow step POSTProcess a workflow step POSTCancel a workflow from the current step POSTReturn to the previous step POSTReturn the circuit to its initiator PUTReplace step assignees POSTPost workflows steps insert DELETEDelete workflows transactions step POSTPost workflows file annex POSTPost workflows new process file annex PUTPut workflows locked file PUTPut workflows unlocked file GETGet workflows download file DELETEDelete workflows delete file GETGet workflows actions all POSTPost workflows actions create GETGet workflows actions show PUTPut workflows actions update DELETEDelete workflows actions delete GETGet workflows models all POSTCreate a workflow model GETGet workflows models show PUTUpdate a workflow model DELETEDelete workflows models delete POSTDuplicate a workflow model GETGet workflows models steps POSTCreate a model step GETGet workflows models steps show PUTUpdate a model step PUTPut workflows models steps update make-default-start DELETEDelete workflows models steps delete POSTSave the model graph PUTPut workflows models steps configs update DELETEDelete workflows models steps configs delete

Clients

Overview GETGet clients all POSTCreate a client POSTFind or create a client by email POSTImport clients GETGet clients show PUTUpdate a client DELETEDelete clients delete

Directory

Overview GETGet companies audit logs GETGet companies audit logs show GETGet companies ldap PUTSave LDAP directory settings PUTSave AD group role mappings POSTTest LDAP bind POSTTest LDAP user lookup POSTImport users from LDAP POSTImport selected LDAP users GETGet companies ldap import latest GETGet companies ldap import POSTSync users from LDAP POSTSync selected LDAP users GETGet companies ldap sync latest GETGet companies ldap sync GETGet roles all POSTPost roles create GETGet roles show PUTPut roles update DELETEDelete roles delete GETList workflow notifications PATCHPatch users notifications read-all PATCHPatch users notifications read DELETEDelete users notifications clear DELETEDelete users notifications POSTCreate a workflow signature appearance GETGet users config signature preview POSTPost users config signature update PATCHPatch users config signature active GETGet users all POSTCreate a company user GETGet users show POSTUpdate a company user DELETEDelete users delete GETGet users new-reset-password-link GETGet users stamp preview POSTImport contacts from LDAP GETGet contacts ldap-connections POSTCreate LDAP connection POSTTest LDAP connection GETGet contacts ldap-connections PUTUpdate LDAP connection DELETEDelete contacts ldap-connections

Notifications

Overview POSTSend SMS or WhatsApp POSTSend email

Signature

Overview GETDownload a signed document GETPublic QR verification GETGet attachments download GETGet public signing session POSTRequest public envelope OTP POSTRequest a second public envelope OTP POSTVerify public envelope OTP POSTStart public identity enrollment POSTRescan public identity POSTPublic identity document check POSTPrepare public identity before sign POSTSign a public envelope POSTRefuse a public envelope GETPreview a public envelope document GETShow the signing user POSTInspect a PDF before signing POSTLegacy mass sign POSTValidate a mass-sign payload POSTSend self-sign OTP GETCheck self-sign second factor POSTSend qualified self-sign OTP POSTSelf-sign documents POSTSend qualified signature OTP POSTQualified signature with a one-shot certificate GETShow signing stats GETList signed documents GETShow a signed document DELETEDelete documents POSTCreate a signed-document share link GETGet documents access-log GETGet batches GETGet batches POSTPost users regenerate-api-key POSTUpload a signature or stamp image GETGet a signature or stamp image DELETEDelete a signature or stamp image GETGet companies GETGet companies PUTPut companies DELETEDelete companies PUTPut companies archive POSTCreate a signing envelope GETList sent envelopes GETList received envelopes POSTClear an envelope box GETShow an envelope DELETEDelete a sent envelope DELETEHide a received envelope POSTRestore signer access POSTCancel an envelope GETGet envelopes documents file GETGet envelopes signers identity-proof

Contacts

Overview GETGet contacts auth check GETShow contacts settings PUTUpdate contacts settings GETList possible duplicates POSTPreview CSV import POSTImport contacts from CSV POSTImport contacts from Google POSTImport contacts from Outlook GETList import jobs GETShow import job GETList contacts POSTCreate contact GETGet contacts PUTUpdate contact DELETEDelete contact

Document vault (EDM)

Overview GETOpen a shared document GETGet edm auth check GETShow vault settings PUTUpdate vault preferences GETList typologies POSTCreate a typology GETGet edm typologies PUTUpdate a typology DELETEDelete edm typologies GETList documents in a folder GETList folders POSTCreate a folder GETGet edm folders PUTUpdate a folder DELETEDelete edm folders GETShow effective rights GETList permissions POSTGrant a permission PUTPut edm permissions DELETEDelete edm permissions GETGet edm documents content GETGet edm documents preview GETGet edm documents versions POSTUpload a new version POSTRestore a document version POSTSet or clear legal hold POSTSeal a document GETVerify a sealed document GETGet a deposit attestation POSTCreate a document share GETList documents POSTUpload a document GETGet edm documents PUTUpdate a document DELETEDelete edm documents GETList documents due for purge POSTPurge documents past retention POSTRun vault integrity check GETSearch the repository GETGet edm shares DELETEDelete edm shares GETList vault audit events GETGet edm audit export GETGet edm reports dashboard GETGet edm reports retention GETGet edm reports compliance POSTExport the vault GETGet edm export

Verification

Overview POSTVerify a signed PDF POSTInspect PDF signatures GETDownload a verification proof PDF GETGet a verification proof GETList verification history

AI

Overview GETGet ai auth check POSTUpload a document for AI GETPoll AI document status POSTAnalyze document POSTDetect signature zones POSTRisk-review a document POSTSummarize a document POSTValidator summary GETShow an AI document POSTStart a document conversation POSTAsk a follow-up question GETList conversation messages GETShow an AI job GETShow my AI usage GETShow company AI usage

Logs & audit

Overview GETGet logs-audit auth check GETList activity log GETList audit events POSTRecord an audit event POSTVerify the audit hash chain GETShow retention settings PUTUpdate retention settings POSTPurge expired audit events GETGet logs-audit exports POSTCreate an audit export GETGet logs-audit exports download GETGet logs-audit reports metrics GETGet logs-audit reports series GETGet logs-audit reports departments GETGet logs-audit reports files POSTGenerate a report file GETGet logs-audit reports files download GETGet logs-audit security settings PUTUpdate security settings (audit console)GETGet logs-audit security enrollments POSTPost logs-audit security enrollments remind POSTPost logs-audit security enrollments reset GETGet logs-audit security idps POSTCreate an identity provider POSTPost logs-audit security idps test PUTPut logs-audit security idps DELETEDelete logs-audit security idps GETGet logs-audit security sessions POSTPost logs-audit security sessions revoke-all POSTPost logs-audit security sessions revoke GETGet logs-audit siem connectors POSTCreate a SIEM connector POSTPost logs-audit siem connectors test PUTPut logs-audit siem connectors DELETEDelete logs-audit siem connectors GETGet logs-audit siem syslog PUTUpdate syslog forwarding GETGet logs-audit alerts PATCHUpdate an alert GETGet logs-audit monitoring overview GETGet logs-audit monitoring services history GETGet logs-audit monitoring services GETGet logs-audit monitoring scheduler GETGet logs-audit backups POSTRun a backup GETGet logs-audit backups download GETGet logs-audit dr-plan PUTPut logs-audit dr-plan POSTRecord a disaster-recovery test POSTRun monitoring checks now POSTRun built-in alert detection POSTForward new events to SIEM

API reference

Directory

Company users, workflow roles, LDAP directory sync, and audit logs.

GETGet companies audit logs/api/companies/{company}/audit/logs GETGet companies audit logs show/api/companies/{company}/audit/logs/{auditLog}/show GETGet companies ldap/api/companies/{company}/ldap PUTSave LDAP directory settings/api/companies/{company}/ldap/save PUTSave AD group role mappings/api/companies/{company}/ldap/role-mappings POSTTest LDAP bind/api/companies/{company}/ldap/test-config POSTTest LDAP user lookup/api/companies/{company}/ldap/test-find POSTImport users from LDAP/api/companies/{company}/ldap/import POSTImport selected LDAP users/api/companies/{company}/ldap/import/users GETGet companies ldap import latest/api/companies/{company}/ldap/import/latest GETGet companies ldap import/api/companies/{company}/ldap/import/{importRun}POSTSync users from LDAP/api/companies/{company}/ldap/sync POSTSync selected LDAP users/api/companies/{company}/ldap/sync/users GETGet companies ldap sync latest/api/companies/{company}/ldap/sync/latest GETGet companies ldap sync/api/companies/{company}/ldap/sync/{syncRun}GETGet roles all/api/roles/all POSTPost roles create/api/roles/create GETGet roles show/api/roles/show/{role}PUTPut roles update/api/roles/update/{role}DELETEDelete roles delete/api/roles/delete/{role}GETList workflow notifications/api/users/notifications PATCHPatch users notifications read-all/api/users/notifications/read-all PATCHPatch users notifications read/api/users/notifications/{notificationId}/read DELETEDelete users notifications clear/api/users/notifications/clear DELETEDelete users notifications/api/users/notifications/{notificationId}POSTCreate a workflow signature appearance/api/users/config/signature/create GETGet users config signature preview/api/users/config/signature/{userSignature}/preview POSTPost users config signature update/api/users/config/signature/{signature}/update PATCHPatch users config signature active/api/users/config/signature/{signature}/active GETGet users all/api/users/all POSTCreate a company user/api/users/create GETGet users show/api/users/show/{user}POSTUpdate a company user/api/users/update/{user}DELETEDelete users delete/api/users/delete/{user}GETGet users new-reset-password-link/api/users/new-reset-password-link/{user}GETGet users stamp preview/api/users/{user}/stamp/preview POSTImport contacts from LDAP/api/contacts/imports/ldap GETGet contacts ldap-connections/api/contacts/ldap-connections POSTCreate LDAP connection/api/contacts/ldap-connections POSTTest LDAP connection/api/contacts/ldap-connections/{connection_id}/test GETGet contacts ldap-connections/api/contacts/ldap-connections/{connection_id}PUTUpdate LDAP connection/api/contacts/ldap-connections/{connection_id}DELETEDelete contacts ldap-connections/api/contacts/ldap-connections/{connection_id}