For AI agents: visit https://developers.youtrust.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Youtrust Public API v3Youtrust Public API v3
HomeGuidesRecipesAPI ReferenceChangelog
Status PageRoadmapTestimoniesShare feedbackYoutrust Public API v3
API Reference
Status PageRoadmapTestimoniesShare feedback
HomeGuidesRecipesAPI ReferenceChangelog

Introduction

  • OAS specification
  • Errors
  • Errors List
  • Versioning
  • Rate limits

electronic signature

  • Approver
    • Create a new Approverpost
    • Delete an Approverdel
    • Get an Approverget
    • List Signature Request's Approversget
    • Update an Approverpatch
    • Send manual reminder to an Approverpost
  • Audit Trail
    • Download Signature Request Audit Trailsget
    • Get Signer Audit Trailget
    • Download Audit Trail PDFget
  • Document
    • List Signature Request's Documentsget
    • Add a Document to a Signature Requestpost
    • Download Signature Request's Documentsget
    • Delete a Documentdel
    • Get a Documentget
    • Update a Documentpatch
    • Download a single Signature Request's Documentget
    • Replace a Document in a Signature Requestpost
  • Field
    • Lists the Fields of a Signature Request Document.get
    • Create a new Field on a Documentpost
    • Delete a Fielddel
    • Update a Fieldpatch
    • Answer a Fieldpost
  • Follower
    • List the Signature Request's Followersget
    • Create new Followerspost
  • Metadata
    • Delete the Signature Request Metadatadel
    • Get the Signature Request Metadataget
    • Attach Metadata to a Signature Requestpost
    • Update Metadata of a Signature Requestput
  • Signature Request
    • List Signature Requestsget
    • Initiate a new Signature Requestpost
    • Delete a Signature Requestdel
    • Fetch a Signature Requestget
    • Update a Signature Requestpatch
    • Activate a Signature Requestpost
    • Pause a Signature Requestpost
    • Resume a Signature Requestpost
    • Cancel a Signature Requestpost
    • Reactivate an expired Signature Requestpost
    • Retrieves an Embedded Preparation Link for a Signature Requestget
  • Signer
    • List Signature Request's Signersget
    • Create a new Signerpost
    • Delete a Signerdel
    • Get a Signerget
    • Update a Signerpatch
    • Send a One-Time Password (OTP) to a Signerpost
    • Pre-verify an identity documentpost
    • Send manual reminder to a Signerpost
    • Sign a Signature Requestpost
    • Unblock Signer after an identity mismatchpost
    • Download Verified Identity Proof PDFget
  • Signer Document Request
    • List Signer Document Requests of the Signature Requestget
    • Add Signer Document Request to a Signature Requestpost
    • Update a Signer Document Requestpatch
    • Delete a Signer Document Requestdel
    • Remove a Signer from a given Signer Document Requestdel
    • Adds a Signer to a given Signer Document Requestput
    • Delete the Documents uploaded by a Signerdel
    • List the Signer Documents of a Signerget
    • Download a Signer Documentget
  • Signer Consent Request
    • List Signer Consent Requests of the Signature Requestget
    • Add Signer Consent Request to a Signature Requestpost
    • Delete a Signer Consent Requestdel
    • Update a Signer Consent Requestpatch
    • Remove a Signer from a given Signer Consent Requestdel
    • Adds a Signer to a given Signer Consent Requestput
  • Template
    • List Templatesget
  • Custom Property
    • List Custom Propertiesget
    • Create a Custom Propertypost
    • Delete a Custom Propertydel
    • Get a Custom Propertyget
    • Update a Custom Propertypatch
  • Label
    • List Labelsget
    • Create a new Labelpost
    • Delete a Labeldel
    • Get a Labelget
    • Update a Labelpatch
    • List Labels of a Signature Requestget
    • Remove Label from a Signature Requestdel
    • Associate a Label with a Signature Requestput

electronic seal

  • Electronic Seal
    • Create an Electronic Sealpost
    • Get an Electronic Sealget
  • Electronic Seal Audit Trail
    • Get an Electronic Seal Audit Trailget
    • Download an Electronic Seal Audit Trailget
  • Electronic Seal Document
    • Delete an Electronic Seal Documentdel
    • Create an Electronic Seal Documentpost
    • Download an Electronic Seal Documentget
  • Electronic Seal Image
    • Upload an Electronic Seal Imagepost
    • List Electronic Seal Imagesget
    • Delete an Electronic Seal Imagedel
    • Download an Electronic Seal Imageget
    • Generate an Electronic Seal Image Previewpost

Document and identity verification

  • Bank Account Document Verification
    • Initiate a new Bank Account Verificationpost
    • Retrieve a Bank Account Verificationget
    • List Bank Account Verificationsget
  • Image Identity Verification
    • Initiate a new Identity Document Verificationpost
    • Retrieve an Identity Document Verificationget
    • List Identity Document Verificationsget
  • Video Identity Verification
    • Initiate a new Identity Video Verificationpost
    • Retrieve an Identity Video Verificationget
    • List Identity Video Verificationsget
  • Company Registry Verification
    • Initiate a new Company Verificationpost
    • Retrieve a Company Verificationget
    • List Company Verificationsget
  • Watchlist Screening
    • Initiate a new Watchlist Verificationpost
    • Retrieve a Watchlist Verificationget
    • List Watchlist Verificationsget
  • Proof of Address Verification
    • Initiate a new Proof of Address Verificationpost
    • Retrieve a Proof of Address Verificationget
    • List Proof of Address Verificationsget
  • Bank Account IBAN Verification
    • Initiate a new Bank Account Lookup Verificationpost
    • Retrieve a Bank Account Lookup Verificationget
    • List Bank Account Lookup Verificationsget
  • Document Trust
    • Initiate a new Document Trust Analysispost
    • Retrieve a Document Trust Analysisget
    • List Document Trust Analysesget
  • Verification Audit Trail
    • Download Verification Audit Trailget

Workflows

  • Workflow Session
    • Create a new Workflow Sessionpost
    • Get a Workflow Sessionget
    • List Workflow Sessionsget
    • Resolve an Actionpost
  • Workflow Template
    • List Workflow Templatesget
  • Workflow Session Links
    • Generate Workflow Session Linksget
  • Applicants
    • List Applicantsget
    • Create a new Applicantpost
    • Get an Applicantget
    • Update an Applicantpatch

Settings & Administration

  • Consumption
    • Get Consumptionsget
    • Get detailed addon consumption.get
    • Get detailed Consumption dataget
    • Export Consumption dataget
    • Get Invited signers consumption recordsget
    • Get Electronic Seals consumption recordsget
    • Get Identifications consumption recordsget
  • Contact
    • List Contactsget
    • Create a Contactpost
    • Delete a Contactdel
    • Get a Contactget
    • Update a Contactpatch
  • Custom Experience
    • List Custom Experiencesget
    • Create a Custom Experiencepost
    • Delete a Custom Experiencedel
    • Get a Custom Experienceget
    • Update a Custom Experiencepatch
    • Delete a Custom Experience logodel
    • Update a Custom Experience logopost
  • User
    • List Usersget
    • Create a new Userpost
    • Delete a Userdel
    • Get a Userget
    • Update a Userpatch
    • Remove a user from a workspacedel
    • Associate a user to a workspaceput
  • User Invitation
    • List User Invitationsget
    • Get an Invitationget
    • Get a User Invitation via the Userget
  • Workspace
    • List Workspacesget
    • Create a Workspacepost
    • Get the default Workspaceget
    • Mark the given Workspace as defaultpost
    • Delete a Workspacedel
    • Get a Workspaceget
    • Update a Workspacepatch
  • Deprecated
    • [DEPRECATED] Upload a Documentpost
  • Archiving
    • Direct upload an archived filepost
    • Download archived fileget

webhook subscription

  • Webhook
    • List Webhook subscriptionsget
    • Create a Webhook subscriptionpost
    • Delete a Webhook subscriptiondel
    • Get a Webhook subscriptionget
    • Update a Webhook subscriptionpatch

Webhook Events

  • Approver Events
    • approver.approvedpost
    • approver.notifiedpost
    • approver.rejectedpost
    • approver.notification_delivery_failedpost
  • Contact Events
    • contact.createdpost
  • Verification Events
    • verification.identity_document.donepost
    • verification.identity_video.donepost
    • verification.bank_account.donepost
    • verification.bank_account_lookup.donepost
    • verification.bank_account_connection.donepost
    • verification.proof_of_address.donepost
    • verification.company.donepost
    • verification.watchlist.donepost
    • monitoring.natural_person.activatedpost
    • monitoring.natural_person.inconclusivepost
    • monitoring.natural_person.canceledpost
    • monitoring.natural_person.updatedpost
  • Electronic Seal Events
    • electronic_seal.donepost
    • electronic_seal.errorpost
  • Signature Request Events
    • signature_request.activatedpost
    • signature_request.approvedpost
    • signature_request.canceledpost
    • signature_request.declinedpost
    • signature_request.deletedpost
    • signature_request.donepost
    • signature_request.expiredpost
    • signature_request.permanently_deletedpost
    • signature_request.reactivatedpost
    • signature_request.reminder_executedpost
    • signature_request.automatic_reminder_executedpost
    • signature_request.rejectedpost
    • signature_request.pausedpost
    • signature_request.resumedpost
  • Signer Events
    • signer.declinedpost
    • signer.donepost
    • signer.errorpost
    • signer.identification_blockedpost
    • signer.identification_failedpost
    • signer.identification_succeededpost
    • signer.identity_savedpost
    • signer.link_openedpost
    • signer.notifiedpost
    • signer.sender_contactedpost
    • signer.notification_delivery_failedpost
    • signer.identification_expiredpost
  • User Events
    • user.completedpost
  • Workflow Events
    • workflow_action_group.blockedpost
    • workflow_action_group.donepost
    • workflow_action_group.startedpost
    • workflow_session.blockedpost
    • workflow_session.donepost
    • workflow_session.startedpost
  • Document Trust Analysis Events
    • document_analysis.donepost
  • Applicant Events
    • applicant.notifiedpost
    • applicant.processedpost
    • applicant.session_blockedpost
Powered by 
  1. Webhook Events

Workflow Events

Related guide: Workflows

Updated 4 months ago


user.completed
workflow_action_group.blocked

Updated 4 months ago


user.completed
workflow_action_group.blocked