Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Status Page
Roadmap
Testimonies
Share feedback
API Reference
Status Page
Roadmap
Testimonies
Share feedback
Home
Guides
Recipes
API Reference
Changelog
User
All
Pages
Start typing to search…
JUMP TO
Introduction
OAS specification
Errors
Errors List
Versioning
electronic signature
Approver
Create a new Approver
post
Delete an Approver
del
Get an Approver
get
Update an Approver
patch
Send manual reminder to an Approver
post
Audit Trail
Download Signature Request Audit Trails
get
Get Signer Audit Trail
get
Download Audit Trail PDF
get
Document
List Signature Request's Documents
get
Upload Document to a Signature Request
post
Add a sealed Document to a Signature Request
post
Download Signature Request's Documents
get
Delete a Document
del
Get a Document
get
Update a Document
patch
Download a single Signature Request's Document
get
Replace a Document in a Signature Request
post
Field
Lists the Fields of a Signature Request Document.
get
Create a new Field on a Document
post
Delete a Field
del
Update a Field
patch
Answer a Field
post
Follower
List the Signature Request's Followers
get
Create new Followers
post
Label
List Labels
get
Create a new Label
post
Delete a Label
del
Get a Label
get
Update a Label
patch
List Labels of a Signature Request
get
Remove Label from a Signature Request
del
Associate a Label with a Signature Request
put
Metadata
Delete the Signature Request Metadata
del
Get the Signature Request Metadata
get
Attach Metadata to a Signature Request
post
Update Metadata of a Signature Request
put
Signature Request
List Signature Requests
get
Initiate a new Signature Request
post
Delete a Signature Request
del
Fetch a Signature Request
get
Update a Signature Request
patch
Activate a Signature Request
post
Cancel a Signature Request
post
Reactivate an expired Signature Request
post
Signer
List Signature Request's Signers
get
Create a new Signer
post
Delete a Signer
del
Get a Signer
get
Update a Signer
patch
Send a One-Time Password (OTP) to a Signer
post
Pre-verify an identity document
post
Send manual reminder to a Signer
post
Sign a Signature Request
post
Sign a Signature Request with a signature image
post
Unblock Signer after an identity mismatch
post
Signer Document Request
List Signer Document Requests of the Signature Request
get
Add Signer Document Request to a Signature Request
post
Delete a Signer Document Request
del
Remove a Signer to a given Signer Document Request
del
Adds a Signer to a given Signer Document Request
put
Delete the Documents uploaded by a Signer
del
List the Signer Documents of a Signer
get
Download a Signer Document
get
Signer Consent Request
List Signer Consent Requests of the Signature Request
get
Add Signer Consent Request to a Signature Request
post
Delete a Signer Consent Request
del
Update a Signer Consent Request
patch
Remove a Signer from a given Signer Consent Request
del
Adds a Signer to a given Signer Consent Request
put
Template
List Templates
get
signature experience
Custom Experience
List Custom Experiences
get
Create a Custom Experience
post
Delete a Custom Experience
del
Get a Custom Experience
get
Update a Custom Experience
patch
Delete a Custom Experience logo
del
Update a Custom Experience logo
post
electronic seal
Electronic Seal
Create an Electronic Seal
post
Get an Electronic Seal
get
Electronic Seal Audit Trail
Get an Electronic Seal Audit Trail
get
Download an Electronic Seal Audit Trail
get
Electronic Seal Document
Create an Electronic Seal Document
post
Upload an Electronic Seal Document
post
Download an Electronic Seal Document
get
Electronic Seal Image
Upload an Electronic Seal Image
post
List Electronic Seal Images
get
Delete an Electronic Seal Image
del
Download an Electronic Seal Image
get
Document and identity verification
Bank Account Document Verification
Initiate a new Bank Account Document Verification
post
Retrieve a Bank Account Document Verification
get
List Bank Account Document Verifications
get
Image Identity Verification
Initiate a new Image Identity Verification
post
Retrieve an Image Identity Verification
get
List Image Identity Verifications
get
Video Identity Verification
Initiate a new Video Identity Verification
post
Retrieve a Video Identity Verification
get
List Video Identity Verifications
get
Company Registry Verification
Initiate a new Company Registry Verification
post
Initiate a new Company Registry Verification from a file
post
Retrieve a Company Registry Verification
get
List Company Registry Verifications
get
Watchlist Screening
Initiate a Watchlist Screening
post
Retrieve a Watchlist Screening
get
List Watchlist Screenings
get
Proof of Address Verification
Initiate a new Proof of Address Verification
post
Retrieve a Proof of Address Verification
get
List Proof of Address Verifications
get
Bank Account Verification - Open Banking
Initiate a new Bank Account Verification - Open Banking
post
Retrieve a Bank Account Verification - Open Banking
get
List Bank Account Verifications - Open Banking
get
Bank Account Verification
Initiate a new Bank Account Verification
post
Initiate a Bank Account Verification from a file
post
Retrieve a Bank Account Verification
get
List Bank Account Verifications
get
Document Analysis
Initiate a new Document Analysis
post
Retrieve a Document Analysis
get
List Document Analyses
get
Verification Audit Trail
Download Verification Audit Trail
get
Workflows
Workflow Session
Create a new Workflow Session
post
Get a Workflow Session
get
List Workflow Sessions
get
Resolve an Action
post
Workflow Template
List Workflow Templates
get
other resources
Consumption
Get detailed addon consumption.
get
Get detailed Consumption data
get
Get Invited signers consumption records
get
Get Electronic Seals consumption records
get
Get Identifications consumption records
get
Contact
List Contacts
get
Create a Contact
post
Delete a Contact
del
Get a Contact
get
Update a Contact
patch
User
List Users
get
Create a new User
post
Delete a User
del
Get a User
get
Update a User
patch
Remove a user from a workspace
del
Associate a user to a workspace
put
User Invitation
List User Invitations
get
Get an Invitation
get
Get a User Invitation via the User
get
Webhook
List Webhook subscriptions
get
Create a Webhook subscription
post
Delete a Webhook subscription
del
Get a Webhook subscription
get
Update a Webhook subscription
patch
Workspace
List Workspaces
get
Create a Workspace
post
Get the default Workspace
get
Mark the given Workspace as default
post
Delete a Workspace
del
Get a Workspace
get
Update a Workspace
patch
Deprecated
[DEPRECATED] Upload a Document
post
Webhook Events
Approver Events
approver.approved
post
approver.notified
post
approver.rejected
post
approver.notification_delivery_failed
post
Contact Events
contact.created
post
Verification Events
verification.identity_document.done
post
verification.identity_video.done
post
verification.bank_account.done
post
verification.bank_account_lookup.done
post
verification.bank_account_connection.done
post
verification.proof_of_address.done
post
verification.company.done
post
verification.watchlist.done
post
Electronic Seal Events
electronic_seal.done
post
electronic_seal.error
post
Signature Request Events
signature_request.activated
post
signature_request.approved
post
signature_request.canceled
post
signature_request.declined
post
signature_request.deleted
post
signature_request.done
post
signature_request.expired
post
signature_request.permanently_deleted
post
signature_request.reactivated
post
signature_request.reminder_executed
post
signature_request.automatic_reminder_executed
post
signature_request.rejected
post
Signer Events
signer.declined
post
signer.done
post
signer.error
post
signer.identification_blocked
post
signer.identification_failed
post
signer.identification_succeeded
post
signer.identity_saved
post
signer.link_opened
post
signer.notified
post
signer.sender_contacted
post
signer.notification_delivery_failed
post
User Events
user.completed
post
Workflow Events
workflow_action_group.blocked
post
workflow_action_group.done
post
workflow_action_group.started
post
workflow_session.blocked
post
workflow_session.done
post
workflow_session.started
post
Document Analysis Events
document_analysis.done
post
Powered by
User
Ask AI
A person who can access the Yousign web app of your organization.
