### Account - Get Account Guide Source: https://api.digisign.org/api/docs Retrieves the account guide. ```APIDOC ## GET /api/account/guide ### Description Get Account guide. ### Method GET ### Endpoint /api/account/guide ``` -------------------------------- ### AccountSettings - Get Account Settings Source: https://api.digisign.org/api/docs Retrieves the account settings. ```APIDOC ## GET /api/account/settings ### Description Get Account Settings. ### Method GET ### Endpoint /api/account/settings ``` -------------------------------- ### Me - Get Me Source: https://api.digisign.org/api/docs Retrieves information about the current user. ```APIDOC ## GET /api/account/me ### Description Get Me. ### Method GET ### Endpoint /api/account/me ``` -------------------------------- ### Account - Get Account Source: https://api.digisign.org/api/docs Retrieves the account information. ```APIDOC ## GET /api/account ### Description Get Account. ### Method GET ### Endpoint /api/account ``` -------------------------------- ### Me - Get Permissions Source: https://api.digisign.org/api/docs Retrieves the permissions of the logged-in identity. ```APIDOC ## GET /api/account/me/permissions ### Description Get permissions of the logged identity. ### Method GET ### Endpoint /api/account/me/permissions ``` -------------------------------- ### MyAccounts - Get All Source: https://api.digisign.org/api/docs Retrieves a list of all accounts associated with the user. ```APIDOC ## GET /api/my/accounts ### Description Get all My Accounts ### Method GET ### Endpoint /api/my/accounts ``` -------------------------------- ### MyAccounts - Get Specific Source: https://api.digisign.org/api/docs Retrieves details for a specific account. ```APIDOC ## GET /api/my/accounts/{account} ### Description Get My Account ### Method GET ### Endpoint /api/my/accounts/{account} ``` -------------------------------- ### Get EnvelopeTemplate Source: https://api.digisign.org/api/docs Retrieves details of a specific envelope template. ```APIDOC ## GET /api/envelope-templates/{template} ### Description Get EnvelopeTemplate ### Method GET ### Endpoint /api/envelope-templates/{template} ``` -------------------------------- ### AccountSecurity - Get Account Security Source: https://api.digisign.org/api/docs Retrieves the account security settings. ```APIDOC ## GET /api/account/security ### Description Get Account Security. ### Method GET ### Endpoint /api/account/security ``` -------------------------------- ### AccountBranding - Get Brandings Info Source: https://api.digisign.org/api/docs Retrieves information about account brandings. ```APIDOC ## GET /api/account/brandings/info ### Description Get Brandings info. ### Method GET ### Endpoint /api/account/brandings/info ``` -------------------------------- ### Account - Get Billing Info Source: https://api.digisign.org/api/docs Retrieves the billing information for the account. ```APIDOC ## GET /api/account/billing ### Description Get Billing info. ### Method GET ### Endpoint /api/account/billing ``` -------------------------------- ### Get EnvelopeRecipientAttachment Source: https://api.digisign.org/api/docs Retrieves details of a specific EnvelopeRecipientAttachment. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/attachments/{attachment} ### Description Get EnvelopeRecipientAttachment ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/attachments/{attachment} ``` -------------------------------- ### Get EnvelopeRecipient Signature Scenario Source: https://api.digisign.org/api/docs Retrieves the signature scenario for an EnvelopeRecipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/scenario ### Description Get EnvelopeRecipient signature scenario ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/scenario ``` -------------------------------- ### MyIdentification - Get Info Source: https://api.digisign.org/api/docs Retrieves information for a specific identification. ```APIDOC ## GET /api/my/identifications/{identification}/info ### Description Get MyIdentification info ### Method GET ### Endpoint /api/my/identifications/{identification}/info ``` -------------------------------- ### User - Get User Source: https://api.digisign.org/api/docs Retrieves a specific user by their ID. ```APIDOC ## GET /api/account/users/{user} ### Description Get User. ### Method GET ### Endpoint /api/account/users/{user} ``` -------------------------------- ### Account - Get Account Statistics Source: https://api.digisign.org/api/docs Retrieves the account statistics. ```APIDOC ## GET /api/account/statistics ### Description Get Account Statistics. ### Method GET ### Endpoint /api/account/statistics ``` -------------------------------- ### AccountIdentifyScenario - Get Identify Scenarios Info Source: https://api.digisign.org/api/docs Retrieves information about identify scenarios. ```APIDOC ## GET /api/account/identify-scenarios/info ### Description Get Identify scenarios info. ### Method GET ### Endpoint /api/account/identify-scenarios/info ``` -------------------------------- ### Get Envelope Tag Source: https://api.digisign.org/api/docs Retrieves details of a specific envelope tag. ```APIDOC ## GET /api/envelopes/{envelope}/tags/{tag} ### Description Get Envelope Tag ### Method GET ### Endpoint /api/envelopes/{envelope}/tags/{tag} ``` -------------------------------- ### AccountSignatureScenario - Get Signature Scenarios Info Source: https://api.digisign.org/api/docs Retrieves information about signature scenarios. ```APIDOC ## GET /api/account/signature-scenarios/info ### Description Get Signature scenarios info. ### Method GET ### Endpoint /api/account/signature-scenarios/info ``` -------------------------------- ### AccountMessaging - Get Account Messaging Source: https://api.digisign.org/api/docs Retrieves the account messaging settings. ```APIDOC ## GET /api/account/messaging ### Description Get Account Messaging. ### Method GET ### Endpoint /api/account/messaging ``` -------------------------------- ### AccountIdentifyScenario - Get Identify Scenario Version Source: https://api.digisign.org/api/docs Retrieves a specific version of an identify scenario. ```APIDOC ## GET /api/account/identify-scenarios/{scenario}/versions/{version} ### Description Get Identify scenario Version. ### Method GET ### Endpoint /api/account/identify-scenarios/{scenario}/versions/{version} ``` -------------------------------- ### Get EnvelopeTemplateNotification Source: https://api.digisign.org/api/docs Retrieves details of a specific notification for an envelope template. ```APIDOC ## GET /api/envelope-templates/{template}/notifications/{notification} ### Description Get EnvelopeTemplateNotification ### Method GET ### Endpoint /api/envelope-templates/{template}/notifications/{notification} ``` -------------------------------- ### ApiKey - Get ApiKey Source: https://api.digisign.org/api/docs Retrieves a specific API key by its ID. ```APIDOC ## GET /api/account/api-keys/{apiKey} ### Description Get ApiKey. ### Method GET ### Endpoint /api/account/api-keys/{apiKey} ``` -------------------------------- ### AccountIdentifyScenario - Get Identify Scenario Source: https://api.digisign.org/api/docs Retrieves a specific identify scenario by its ID. ```APIDOC ## GET /api/account/identify-scenarios/{scenario} ### Description Get Identify scenario. ### Method GET ### Endpoint /api/account/identify-scenarios/{scenario} ``` -------------------------------- ### AccountIdentifyScenario - Get Default Inspection Checks Source: https://api.digisign.org/api/docs Retrieves the default inspection checks for identify scenarios. ```APIDOC ## GET /api/account/identify-scenarios/inspection-checks/defaults ### Description Get default inspection checks for the identify scenarios. ### Method GET ### Endpoint /api/account/identify-scenarios/inspection-checks/defaults ``` -------------------------------- ### AccountIdentifyScenario - Get Latest Identify Scenario Version Source: https://api.digisign.org/api/docs Retrieves the latest version of an identify scenario. ```APIDOC ## GET /api/account/identify-scenarios/{scenario}/versions/latest ### Description Get Latest Identify scenario Version. ### Method GET ### Endpoint /api/account/identify-scenarios/{scenario}/versions/latest ``` -------------------------------- ### AccountBranding - Get Account Branding Source: https://api.digisign.org/api/docs Retrieves a specific account branding by its ID. ```APIDOC ## GET /api/account/brandings/{branding} ### Description Get Account Branding. ### Method GET ### Endpoint /api/account/brandings/{branding} ``` -------------------------------- ### AccountEnvelopeTemplate - Get Default Account Envelope Template Source: https://api.digisign.org/api/docs Retrieves the default account envelope template. ```APIDOC ## GET /api/account/envelope-template ### Description Get default Account EnvelopeTemplate. ### Method GET ### Endpoint /api/account/envelope-template ``` -------------------------------- ### Get EnvelopeTemplateDocument Source: https://api.digisign.org/api/docs Retrieves details of a specific document within an envelope template. ```APIDOC ## GET /api/envelope-templates/{template}/documents/{document} ### Description Get EnvelopeTemplateDocument ### Method GET ### Endpoint /api/envelope-templates/{template}/documents/{document} ``` -------------------------------- ### AccountSignatureScenario - Get Signature Scenario Version Source: https://api.digisign.org/api/docs Retrieves a specific version of a signature scenario. ```APIDOC ## GET /api/account/signature-scenarios/{scenario}/versions/{version} ### Description Get Signature scenario Version. ### Method GET ### Endpoint /api/account/signature-scenarios/{scenario}/versions/{version} ``` -------------------------------- ### Get Certificate Info by Recipient Source: https://api.digisign.org/api/docs Retrieves certificate information for a specific recipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/certificate-info ### Description Get Certificate Info by Recipient ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/certificate-info ``` -------------------------------- ### Account - Get Account SMS Log Source: https://api.digisign.org/api/docs Retrieves the account SMS log. ```APIDOC ## GET /api/account/sms-log ### Description Get Account SMS Log. ### Method GET ### Endpoint /api/account/sms-log ``` -------------------------------- ### Get EnvelopeRecipient Verified Claims Source: https://api.digisign.org/api/docs Retrieves verified claims for an Envelope Recipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/verified-claims ### Description Get EnvelopeRecipient verified claims ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/verified-claims ``` -------------------------------- ### AccountRequest - Get Account Request Source: https://api.digisign.org/api/docs Retrieves a specific account request by its ID. ```APIDOC ## GET /api/account/requests/{request} ### Description Get Account Request. ### Method GET ### Endpoint /api/account/requests/{request} ``` -------------------------------- ### AccountSignatureScenario - Get Signature Scenario Source: https://api.digisign.org/api/docs Retrieves a specific signature scenario by its ID. ```APIDOC ## GET /api/account/signature-scenarios/{scenario} ### Description Get Signature scenario. ### Method GET ### Endpoint /api/account/signature-scenarios/{scenario} ``` -------------------------------- ### AccountSignatureScenario - Get Latest Signature Scenario Version Source: https://api.digisign.org/api/docs Retrieves the latest version of a signature scenario. ```APIDOC ## GET /api/account/signature-scenarios/{scenario}/versions/latest ### Description Get Latest Signature scenario Version. ### Method GET ### Endpoint /api/account/signature-scenarios/{scenario}/versions/latest ``` -------------------------------- ### Me - Get 2FA Status Source: https://api.digisign.org/api/docs Retrieves the current user's two-factor authentication status. ```APIDOC ## GET /api/account/me/2fa ### Description Get 2FA Status. ### Method GET ### Endpoint /api/account/me/2fa ``` -------------------------------- ### Me - Get Signature Image Content Source: https://api.digisign.org/api/docs Retrieves the content of the user's signature image. ```APIDOC ## GET /api/account/me/signature-image/content ### Description Get signatureImage content. ### Method GET ### Endpoint /api/account/me/signature-image/content ``` -------------------------------- ### Get Envelope Template Document Assignments Source: https://api.digisign.org/api/docs Retrieves document assignments for an envelope template. ```APIDOC ## GET /api/envelope-templates/{template}/documents/assignments ### Description Get Envelope Template Document Assignments ### Method GET ### Endpoint /api/envelope-templates/{template}/documents/assignments ``` -------------------------------- ### AccountSignatureScenario - List Signature Scenario Versions Source: https://api.digisign.org/api/docs Lists all versions of a signature scenario. ```APIDOC ## GET /api/account/signature-scenarios/{scenario}/versions ### Description List Signature scenario Versions. ### Method GET ### Endpoint /api/account/signature-scenarios/{scenario}/versions ``` -------------------------------- ### MyBulkSign - List Signatures Source: https://api.digisign.org/api/docs Lists all bulk signatures that require signing. ```APIDOC ## GET /api/my/bulk-sign/bulk-signatures ### Description List My BulkSignatures to sign ### Method GET ### Endpoint /api/my/bulk-sign/bulk-signatures ``` -------------------------------- ### AccountIdentifyScenario - List Identify Scenario Versions Source: https://api.digisign.org/api/docs Lists all versions of an identify scenario. ```APIDOC ## GET /api/account/identify-scenarios/{scenario}/versions ### Description List Identify scenario Versions. ### Method GET ### Endpoint /api/account/identify-scenarios/{scenario}/versions ``` -------------------------------- ### MyAccounts - Create Source: https://api.digisign.org/api/docs Creates a new account for the user. ```APIDOC ## POST /api/my/accounts ### Description Create new Account ### Method POST ### Endpoint /api/my/accounts ``` -------------------------------- ### AccountIdentifyScenario - List Identify Scenarios Source: https://api.digisign.org/api/docs Lists all identify scenarios. ```APIDOC ## GET /api/account/identify-scenarios ### Description List Identify scenarios. ### Method GET ### Endpoint /api/account/identify-scenarios ``` -------------------------------- ### User - Invite User Source: https://api.digisign.org/api/docs Invites a new user to the account. ```APIDOC ## POST /api/account/users/invite ### Description Invite User. ### Method POST ### Endpoint /api/account/users/invite ``` -------------------------------- ### AccountSignatureScenario - List Signature Scenarios Source: https://api.digisign.org/api/docs Lists all signature scenarios. ```APIDOC ## GET /api/account/signature-scenarios ### Description List Signature scenarios. ### Method GET ### Endpoint /api/account/signature-scenarios ``` -------------------------------- ### MyAccount - Switch Source: https://api.digisign.org/api/docs Switches the current context to a different account. ```APIDOC ## POST /api/my/accounts/{account}/switch ### Description Switch to My Account ### Method POST ### Endpoint /api/my/accounts/{account}/switch ``` -------------------------------- ### Me - Configure 2FA Source: https://api.digisign.org/api/docs Configures two-factor authentication for the current user. ```APIDOC ## POST /api/account/me/2fa ### Description Configure 2FA. ### Method POST ### Endpoint /api/account/me/2fa ``` -------------------------------- ### Create Envelope Tags by Placeholder Source: https://api.digisign.org/api/docs Creates envelope tags based on a placeholder. ```APIDOC ## POST /api/envelopes/{envelope}/tags/by-placeholder ### Description Create Envelope Tags by placeholder ### Method POST ### Endpoint /api/envelopes/{envelope}/tags/by-placeholder ``` -------------------------------- ### AccountIdentifyScenario - Create Identify Scenario Version Source: https://api.digisign.org/api/docs Creates a new version for an identify scenario. ```APIDOC ## POST /api/account/identify-scenarios/{scenario}/versions ### Description Create Identify scenario Version. ### Method POST ### Endpoint /api/account/identify-scenarios/{scenario}/versions ``` -------------------------------- ### Create EnvelopeTemplate Source: https://api.digisign.org/api/docs Creates a new envelope template. ```APIDOC ## POST /api/envelope-templates ### Description Create EnvelopeTemplate ### Method POST ### Endpoint /api/envelope-templates ``` -------------------------------- ### AccountBranding - Create Account Branding Source: https://api.digisign.org/api/docs Creates a new account branding. ```APIDOC ## POST /api/account/brandings ### Description Create Account Branding. ### Method POST ### Endpoint /api/account/brandings ``` -------------------------------- ### ApiKey - Create ApiKey Source: https://api.digisign.org/api/docs Creates a new API key. ```APIDOC ## POST /api/account/api-keys ### Description Create ApiKey. ### Method POST ### Endpoint /api/account/api-keys ``` -------------------------------- ### Get Envelope Recipient Source: https://api.digisign.org/api/docs Retrieves details of a specific envelope recipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient} ### Description Get Envelope Recipient ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient} ``` -------------------------------- ### Use EnvelopeTemplate Source: https://api.digisign.org/api/docs Uses an envelope template, likely to initiate a new envelope. ```APIDOC ## POST /api/envelope-templates/{template}/use ### Description Use EnvelopeTemplate ### Method POST ### Endpoint /api/envelope-templates/{template}/use ``` -------------------------------- ### AccountIdentifyScenario - Create Identify Scenario Source: https://api.digisign.org/api/docs Creates a new identify scenario. ```APIDOC ## POST /api/account/identify-scenarios ### Description Create Identify scenario. ### Method POST ### Endpoint /api/account/identify-scenarios ``` -------------------------------- ### AccountBranding - List Account Brandings Source: https://api.digisign.org/api/docs Lists all account brandings. ```APIDOC ## GET /api/account/brandings ### Description List Account Brandings. ### Method GET ### Endpoint /api/account/brandings ``` -------------------------------- ### Create Batch Sending Source: https://api.digisign.org/api/docs Initiates batch sending for an envelope template. ```APIDOC ## POST /api/envelope-templates/{template}/batch-sending ### Description Create batch sending ### Method POST ### Endpoint /api/envelope-templates/{template}/batch-sending ``` -------------------------------- ### Account - Create Account Billing Default Subscription Source: https://api.digisign.org/api/docs Creates the default subscription for account billing. ```APIDOC ## POST /api/account/billing/default-subscription ### Description Create Account Billing Default Subscription. ### Method POST ### Endpoint /api/account/billing/default-subscription ``` -------------------------------- ### ApiKey - List ApiKeys Source: https://api.digisign.org/api/docs Lists all API keys associated with the account. ```APIDOC ## GET /api/account/api-keys ### Description List ApiKeys. ### Method GET ### Endpoint /api/account/api-keys ``` -------------------------------- ### Get Envelope Recipient Block Source: https://api.digisign.org/api/docs Retrieves information about an Envelope Recipient Block. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/block ### Description Get Envelope Recipient Block ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/block ``` -------------------------------- ### Auth - Authorize Source: https://api.digisign.org/api/docs Authorize the user. ```APIDOC ## POST /api/auth-token ### Description Authorize the user. ### Method POST ### Endpoint /api/auth-token ``` -------------------------------- ### AccountSignatureScenario - Create Signature Scenario Version Source: https://api.digisign.org/api/docs Creates a new version for a signature scenario. ```APIDOC ## POST /api/account/signature-scenarios/{scenario}/versions ### Description Create Signature scenario Version. ### Method POST ### Endpoint /api/account/signature-scenarios/{scenario}/versions ``` -------------------------------- ### AccountSettings - Update Account Settings Source: https://api.digisign.org/api/docs Updates the account settings. ```APIDOC ## PUT /api/account/settings ### Description Update Account Settings. ### Method PUT ### Endpoint /api/account/settings ``` -------------------------------- ### Account Email Sender Source: https://api.digisign.org/api/docs List available email sender configurations for the account. ```APIDOC ## GET /api/account/email-senders ### Description List all configured email senders for the account. ### Method GET ### Endpoint /api/account/email-senders ``` -------------------------------- ### User - Configure 2FA for User Source: https://api.digisign.org/api/docs Configures two-factor authentication for a specific user. ```APIDOC ## POST /api/account/users/{user}/2fa ### Description Configure 2FA for User in a current organisation. ### Method POST ### Endpoint /api/account/users/{user}/2fa ``` -------------------------------- ### AccountSmsSender - Get SMS Sender Source: https://api.digisign.org/api/docs Retrieves a specific SMS sender by its ID. ```APIDOC ## GET /api/account/sms-senders/{sender} ### Description Get SMS sender. ### Method GET ### Endpoint /api/account/sms-senders/{sender} ``` -------------------------------- ### AccountSmsSender - Get Email Sender Source: https://api.digisign.org/api/docs Retrieves a specific email sender by its ID. ```APIDOC ## GET /api/account/email-senders/{sender} ### Description Get Email sender. ### Method GET ### Endpoint /api/account/email-senders/{sender} ``` -------------------------------- ### Me - List Active Sessions Source: https://api.digisign.org/api/docs Lists all active sessions for the current user. ```APIDOC ## GET /api/account/me/sessions ### Description List active Sessions. ### Method GET ### Endpoint /api/account/me/sessions ``` -------------------------------- ### Download EnvelopeRecipientAttachment File Source: https://api.digisign.org/api/docs Downloads the file associated with an EnvelopeRecipientAttachment. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/attachments/{attachment}/download ### Description Download EnvelopeRecipientAttachment file ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/attachments/{attachment}/download ``` -------------------------------- ### User - Activate User Source: https://api.digisign.org/api/docs Activates a specific user. ```APIDOC ## POST /api/account/users/{user}/activate ### Description Activate User. ### Method POST ### Endpoint /api/account/users/{user}/activate ``` -------------------------------- ### AccountSignatureScenario - Create Signature Scenario Source: https://api.digisign.org/api/docs Creates a new signature scenario. ```APIDOC ## POST /api/account/signature-scenarios ### Description Create Signature scenario. ### Method POST ### Endpoint /api/account/signature-scenarios ``` -------------------------------- ### Get Sign Info about Envelope Recipient Source: https://api.digisign.org/api/docs Retrieves signing information for an Envelope Recipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/sign-info ### Description Get Sign info about Envelope Recipient ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/sign-info ``` -------------------------------- ### Me - Verify My Password Source: https://api.digisign.org/api/docs Verifies the current user's password. ```APIDOC ## POST /api/account/me/verify-password ### Description Verify my password. ### Method POST ### Endpoint /api/account/me/verify-password ``` -------------------------------- ### ApiKey - Activate ApiKey Source: https://api.digisign.org/api/docs Activates a specific API key. ```APIDOC ## POST /api/account/api-keys/{apiKey}/activate ### Description Activate ApiKey. ### Method POST ### Endpoint /api/account/api-keys/{apiKey}/activate ``` -------------------------------- ### MyAccounts - Accept Invitation Source: https://api.digisign.org/api/docs Accepts an account invitation for a specific account. ```APIDOC ## POST /api/my/accounts/{account}/accept ### Description Accept Account invitation ### Method POST ### Endpoint /api/my/accounts/{account}/accept ``` -------------------------------- ### List EnvelopeTemplates Source: https://api.digisign.org/api/docs Retrieves a list of all available envelope templates. ```APIDOC ## GET /api/envelope-templates ### Description List EnvelopeTemplates ### Method GET ### Endpoint /api/envelope-templates ``` -------------------------------- ### AccountRequest - List Account Requests Source: https://api.digisign.org/api/docs Lists all account requests. ```APIDOC ## GET /api/account/requests ### Description List Account Requests. ### Method GET ### Endpoint /api/account/requests ``` -------------------------------- ### Create EnvelopeTemplateDocument Source: https://api.digisign.org/api/docs Creates a new document for an envelope template. ```APIDOC ## POST /api/envelope-templates/{template}/documents ### Description Create EnvelopeTemplateDocument ### Method POST ### Endpoint /api/envelope-templates/{template}/documents ``` -------------------------------- ### User - List Users Source: https://api.digisign.org/api/docs Lists all users associated with the account. ```APIDOC ## GET /api/account/users ### Description List Users. ### Method GET ### Endpoint /api/account/users ``` -------------------------------- ### MyBulkSign - List Envelopes Source: https://api.digisign.org/api/docs Lists recipients for My Bulk Sign envelopes. ```APIDOC ## GET /api/my/bulk-sign/envelopes ### Description List My Bulk Sign Envelope Recipients ### Method GET ### Endpoint /api/my/bulk-sign/envelopes ``` -------------------------------- ### Create Envelope Tag Source: https://api.digisign.org/api/docs Creates a new tag for an envelope. ```APIDOC ## POST /api/envelopes/{envelope}/tags ### Description Create Envelope Tag ### Method POST ### Endpoint /api/envelopes/{envelope}/tags ``` -------------------------------- ### My Bulk Signatures Source: https://api.digisign.org/api/docs Retrieve a list of bulk signatures assigned to the current user for signing. ```APIDOC ## GET /api/my/bulk-signatures/to-sign ### Description List all bulk signatures that require the current user's signature. ### Method GET ### Endpoint /api/my/bulk-signatures/to-sign ``` -------------------------------- ### Download EnvelopeTemplateDocument File Source: https://api.digisign.org/api/docs Downloads the file associated with an envelope template document. ```APIDOC ## GET /api/envelope-templates/{template}/documents/{document}/download ### Description Download EnvelopeTemplateDocument file ### Method GET ### Endpoint /api/envelope-templates/{template}/documents/{document}/download ``` -------------------------------- ### Auth - Logout Source: https://api.digisign.org/api/docs Handles Keycloak back-channel logout. ```APIDOC ## POST /api/auth-token/logout ### Description Handle Keycloak back-channel logout. ### Method POST ### Endpoint /api/auth-token/logout ``` -------------------------------- ### My Profile Operations Source: https://api.digisign.org/api/docs Operations for managing the current user's profile, including updating personal information, preferences, and device registration. ```APIDOC ## PUT /api/me ### Description Update the current user's profile information. ### Method PUT ### Endpoint /api/me ``` ```APIDOC ## GET /api/my/dashboard ### Description Retrieve data for the user's dashboard. ### Method GET ### Endpoint /api/my/dashboard ``` ```APIDOC ## POST /api/my/device ### Description Register a device for the current user. ### Method POST ### Endpoint /api/my/device ``` ```APIDOC ## DELETE /api/my/device ### Description Unregister a device for the current user. ### Method DELETE ### Endpoint /api/my/device ``` ```APIDOC ## GET /api/my/info ### Description Retrieve general information about the current user. ### Method GET ### Endpoint /api/my/info ``` ```APIDOC ## PUT /api/my/preferences ### Description Update the current user's preferences. ### Method PUT ### Endpoint /api/my/preferences ``` -------------------------------- ### Clone EnvelopeTemplate Source: https://api.digisign.org/api/docs Creates a clone of an existing envelope template. ```APIDOC ## POST /api/envelope-templates/{template}/clone ### Description Clone EnvelopeTemplate ### Method POST ### Endpoint /api/envelope-templates/{template}/clone ``` -------------------------------- ### List EnvelopeTemplateNotifications Source: https://api.digisign.org/api/docs Lists all notifications configured for an envelope template. ```APIDOC ## GET /api/envelope-templates/{template}/notifications ### Description List EnvelopeTemplateNotifications ### Method GET ### Endpoint /api/envelope-templates/{template}/notifications ``` -------------------------------- ### AccountBranding - Update Account Branding Source: https://api.digisign.org/api/docs Updates an existing account branding. ```APIDOC ## PUT /api/account/brandings/{branding} ### Description Update Account Branding. ### Method PUT ### Endpoint /api/account/brandings/{branding} ``` -------------------------------- ### Account - Manage Billing Source: https://api.digisign.org/api/docs Manages the account billing settings. ```APIDOC ## POST /api/account/manage-billing ### Description Manage Billing. ### Method POST ### Endpoint /api/account/manage-billing ``` -------------------------------- ### MyBulkSignature - Embed Source: https://api.digisign.org/api/docs Embeds a specific bulk signature for integration. ```APIDOC ## POST /api/my/bulk-signatures/{bulkSignature}/embed ### Description Embed My BulkSignature ### Method POST ### Endpoint /api/my/bulk-signatures/{bulkSignature}/embed ``` -------------------------------- ### Certificate Management Source: https://api.digisign.org/api/docs APIs for managing digital certificates, including listing, creating, retrieving, deleting, disabling, enabling, and reloading certificates. ```APIDOC ## List ApiKeys ### Description Lists available API keys. ### Method GET ### Endpoint /api/account/certificates ``` ```APIDOC ## Create Certificate ### Description Creates a new digital certificate. ### Method POST ### Endpoint /api/account/certificates ``` ```APIDOC ## Get Certificate ### Description Retrieves details of a specific certificate. ### Method GET ### Endpoint /api/account/certificates/{certificate} ``` ```APIDOC ## Delete Certificate ### Description Deletes a specific certificate. ### Method DELETE ### Endpoint /api/account/certificates/{certificate} ``` ```APIDOC ## Disable Certificate ### Description Disables a specific certificate. ### Method POST ### Endpoint /api/account/certificates/{certificate}/disable ``` ```APIDOC ## Enable Certificate ### Description Enables a specific certificate. ### Method POST ### Endpoint /api/account/certificates/{certificate}/enable ``` ```APIDOC ## Reload Certificate ### Description Reloads a specific certificate. ### Method POST ### Endpoint /api/account/certificates/{certificate}/reload ``` -------------------------------- ### AccountSecurity - Update Account Security Source: https://api.digisign.org/api/docs Updates the account security settings. ```APIDOC ## PUT /api/account/security ### Description Update Account Security. ### Method PUT ### Endpoint /api/account/security ``` -------------------------------- ### Create EnvelopeTemplateNotification Source: https://api.digisign.org/api/docs Creates a new notification for an envelope template. ```APIDOC ## POST /api/envelope-templates/{template}/notifications ### Description Create EnvelopeTemplateNotification ### Method POST ### Endpoint /api/envelope-templates/{template}/notifications ``` -------------------------------- ### All Envelope Labels Source: https://api.digisign.org/api/docs Retrieves all labels associated with an envelope. ```APIDOC ## GET /api/envelopes/{envelope}/labels ### Description All Envelope Labels ### Method GET ### Endpoint /api/envelopes/{envelope}/labels ``` -------------------------------- ### My Contacts Source: https://api.digisign.org/api/docs Operations for managing contacts, including suggesting, listing, creating, retrieving, updating, and deleting them. ```APIDOC ## GET /api/my/contacts/suggest ### Description Suggest contacts based on user activity or system data. ### Method GET ### Endpoint /api/my/contacts/suggest ``` ```APIDOC ## GET /api/my/contacts ### Description List all contacts associated with the current user. ### Method GET ### Endpoint /api/my/contacts ``` ```APIDOC ## POST /api/my/contacts ### Description Create a new contact for the current user. ### Method POST ### Endpoint /api/my/contacts ``` ```APIDOC ## GET /api/my/contacts/{contact} ### Description Retrieve details of a specific contact. ### Method GET ### Endpoint /api/my/contacts/{contact} ``` ```APIDOC ## PUT /api/my/contacts/{contact} ### Description Update an existing contact. ### Method PUT ### Endpoint /api/my/contacts/{contact} ``` ```APIDOC ## DELETE /api/my/contacts/{contact} ### Description Delete a specific contact. ### Method DELETE ### Endpoint /api/my/contacts/{contact} ``` -------------------------------- ### AccountEnvelopeTemplate - Update Default Account Envelope Template Source: https://api.digisign.org/api/docs Updates the default account envelope template. ```APIDOC ## PUT /api/account/envelope-template ### Description Update default Account EnvelopeTemplate. ### Method PUT ### Endpoint /api/account/envelope-template ``` -------------------------------- ### File Operations Source: https://api.digisign.org/api/docs Endpoints for managing files, including retrieval, content retrieval, listing, and uploading. ```APIDOC ## GET /api/files/{file} ### Description Get File. ### Method GET ### Endpoint /api/files/{file} ``` ```APIDOC ## GET /api/files/{file}/content ### Description Get File content. ### Method GET ### Endpoint /api/files/{file}/content ``` ```APIDOC ## GET /api/files ### Description List Files. ### Method GET ### Endpoint /api/files ``` ```APIDOC ## POST /api/files ### Description Upload File. ### Method POST ### Endpoint /api/files ``` -------------------------------- ### Bulk Signature Operations Source: https://api.digisign.org/api/docs Operations for managing bulk signatures, including listing, creating, embedding, retrieving, updating, and sending them. ```APIDOC ## GET /api/bulk-signatures ### Description List all bulk signatures. ### Method GET ### Endpoint /api/bulk-signatures ``` ```APIDOC ## POST /api/bulk-signatures ### Description Create new bulk signatures. ### Method POST ### Endpoint /api/bulk-signatures ``` ```APIDOC ## POST /api/bulk-signatures/{bulkSignature}/embed ### Description Embed a bulk signature. ### Method POST ### Endpoint /api/bulk-signatures/{bulkSignature}/embed ``` ```APIDOC ## GET /api/bulk-signatures/{bulkSignature} ### Description Retrieve details of a specific bulk signature. ### Method GET ### Endpoint /api/bulk-signatures/{bulkSignature} ``` ```APIDOC ## PUT /api/bulk-signatures/{bulkSignature} ### Description Update an existing bulk signature. ### Method PUT ### Endpoint /api/bulk-signatures/{bulkSignature} ``` ```APIDOC ## POST /api/bulk-signatures/{bulkSignature}/send ### Description Send a bulk signature. ### Method POST ### Endpoint /api/bulk-signatures/{bulkSignature}/send ``` -------------------------------- ### Me - Update Me Source: https://api.digisign.org/api/docs Updates the current user's information. ```APIDOC ## PUT /api/account/me ### Description Update Me. ### Method PUT ### Endpoint /api/account/me ``` -------------------------------- ### Envelope Management Source: https://api.digisign.org/api/docs APIs for managing envelopes, including creation, retrieval, updates, deletion, and various state transitions and operations. ```APIDOC ## Cancel Envelope ### Description Cancels a specific envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/cancel ``` ```APIDOC ## Clone Envelope ### Description Clones a specific envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/clone ``` ```APIDOC ## Get Envelopes count by status ### Description Retrieves the count of envelopes filtered by status. ### Method GET ### Endpoint /api/envelopes/count ``` ```APIDOC ## Get envelope counts by queries ### Description Retrieves envelope counts based on specified query parameters. ### Method POST ### Endpoint /api/envelopes/count ``` ```APIDOC ## List Envelopes ### Description Lists all envelopes. ### Method GET ### Endpoint /api/envelopes ``` ```APIDOC ## Create Envelope ### Description Creates a new envelope. ### Method POST ### Endpoint /api/envelopes ``` ```APIDOC ## Get Envelope ### Description Retrieves details of a specific envelope. ### Method GET ### Endpoint /api/envelopes/{envelope} ``` ```APIDOC ## Update Envelope ### Description Updates an existing envelope. ### Method PUT ### Endpoint /api/envelopes/{envelope} ``` ```APIDOC ## Delete Envelope ### Description Deletes a specific envelope. ### Method DELETE ### Endpoint /api/envelopes/{envelope} ``` ```APIDOC ## Discard Envelope ### Description Discards a specific envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/discard ``` ```APIDOC ## Download Envelope Documents files ### Description Downloads all documents associated with an envelope. ### Method GET ### Endpoint /api/envelopes/{envelope}/download ``` ```APIDOC ## Embed Envelope ### Description Embeds an envelope for viewing or signing. ### Method POST ### Endpoint /api/envelopes/{envelope}/embed ``` ```APIDOC ## Embed Envelope ### Description Embeds an envelope for editing purposes. ### Method POST ### Endpoint /api/envelopes/{envelope}/embed/edit ``` ```APIDOC ## Extend Envelope validity ### Description Extends the validity period of an envelope. ### Method PUT ### Endpoint /api/envelopes/{envelope}/extend ``` ```APIDOC ## Finish Envelope correction ### Description Completes the correction process for an envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/finish-correction ``` ```APIDOC ## Get Envelope Download URL ### Description Retrieves the download URL for an envelope. ### Method GET ### Endpoint /api/envelopes/{envelope}/download-url ``` ```APIDOC ## Resend Envelope to all recipients ### Description Resends an envelope to all its recipients. ### Method POST ### Endpoint /api/envelopes/{envelope}/resend ``` ```APIDOC ## Restore Envelope ### Description Restores a deleted or discarded envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/restore ``` ```APIDOC ## Send Envelope ### Description Sends an envelope to its recipients. ### Method POST ### Endpoint /api/envelopes/{envelope}/send ``` ```APIDOC ## Start Envelope correction ### Description Initiates the correction process for an envelope. ### Method POST ### Endpoint /api/envelopes/{envelope}/start-correction ``` ```APIDOC ## Get Envelope Template ### Description Retrieves the template associated with an envelope. ### Method GET ### Endpoint /api/envelopes/{envelope}/template ``` ```APIDOC ## Validate Envelope for sending ### Description Validates an envelope before it can be sent. ### Method GET ### Endpoint /api/envelopes/{envelope}/validate ``` ```APIDOC ## Anonymize Envelope ### Description Anonymizes an envelope's content. ### Method POST ### Endpoint /api/envelopes/{envelope}/anonymize ``` ```APIDOC ## Embed Envelope signing ### Description Embeds an envelope for the signing process. ### Method POST ### Endpoint /api/envelopes/{envelope}/embed/signing ``` -------------------------------- ### Enum Operations Source: https://api.digisign.org/api/docs Operations for retrieving enum values and listing all available enums. ```APIDOC ## GET /api/enums/{enum} ### Description Get the possible values for a specific enum. ### Method GET ### Endpoint /api/enums/{enum} ``` ```APIDOC ## GET /api/enums ### Description List all available enums. ### Method GET ### Endpoint /api/enums ``` -------------------------------- ### Set Envelope Labels Source: https://api.digisign.org/api/docs Sets or updates the labels for an envelope. ```APIDOC ## PUT /api/envelopes/{envelope}/labels ### Description Set Envelope Labels ### Method PUT ### Endpoint /api/envelopes/{envelope}/labels ``` -------------------------------- ### List EnvelopeTemplateDocuments Source: https://api.digisign.org/api/docs Lists all documents associated with an envelope template. ```APIDOC ## GET /api/envelope-templates/{template}/documents ### Description List EnvelopeTemplateDocuments ### Method GET ### Endpoint /api/envelope-templates/{template}/documents ``` -------------------------------- ### List Envelope Tags Source: https://api.digisign.org/api/docs Retrieves a list of all tags associated with an envelope. ```APIDOC ## GET /api/envelopes/{envelope}/tags ### Description List Envelope Tags ### Method GET ### Endpoint /api/envelopes/{envelope}/tags ``` -------------------------------- ### AccountIdentifyScenario - Update Identify Scenario Source: https://api.digisign.org/api/docs Updates an existing identify scenario. ```APIDOC ## PUT /api/account/identify-scenarios/{scenario} ### Description Update Identify scenario. ### Method PUT ### Endpoint /api/account/identify-scenarios/{scenario} ``` -------------------------------- ### Batch Sending Item Operations Source: https://api.digisign.org/api/docs Operations for managing individual items within a batch sending job, including listing, creating, updating, deleting, and importing items. ```APIDOC ## GET /api/batch-sendings/{batchSending}/items ### Description List all items within a specific batch sending job. ### Method GET ### Endpoint /api/batch-sendings/{batchSending}/items ``` ```APIDOC ## PUT /api/batch-sendings/{batchSending}/items ### Description Create or overwrite batch sending items. ### Method PUT ### Endpoint /api/batch-sendings/{batchSending}/items ``` ```APIDOC ## GET /api/batch-sendings/{batchSending}/items/{batchSendingItem} ### Description Retrieve details of a specific batch sending item. ### Method GET ### Endpoint /api/batch-sendings/{batchSending}/items/{batchSendingItem} ``` ```APIDOC ## PUT /api/batch-sendings/{batchSending}/items/{batchSendingItem} ### Description Update a specific batch sending item. ### Method PUT ### Endpoint /api/batch-sendings/{batchSending}/items/{batchSendingItem} ``` ```APIDOC ## DELETE /api/batch-sendings/{batchSending}/items/{batchSendingItem} ### Description Delete a specific batch sending item. ### Method DELETE ### Endpoint /api/batch-sendings/{batchSending}/items/{batchSendingItem} ``` ```APIDOC ## POST /api/batch-sendings/{batchSending}/items/import ### Description Import batch sending items using a CSV file. ### Method POST ### Endpoint /api/batch-sendings/{batchSending}/items/import ``` -------------------------------- ### User - Update User Source: https://api.digisign.org/api/docs Updates an existing user. ```APIDOC ## PUT /api/account/users/{user} ### Description Update User. ### Method PUT ### Endpoint /api/account/users/{user} ``` -------------------------------- ### Add Envelope Label Source: https://api.digisign.org/api/docs Adds a label to a specific envelope. ```APIDOC ## PUT /api/envelopes/{envelope}/labels/{label} ### Description Add Envelope Label ### Method PUT ### Endpoint /api/envelopes/{envelope}/labels/{label} ``` -------------------------------- ### Me - Change My Password Source: https://api.digisign.org/api/docs Changes the password for the current user. ```APIDOC ## POST /api/account/me/change-password ### Description Change my Password. ### Method POST ### Endpoint /api/account/me/change-password ``` -------------------------------- ### List EnvelopeRecipientAttachments Source: https://api.digisign.org/api/docs Lists all attachments for a specific Envelope Recipient. ```APIDOC ## GET /api/envelopes/{envelope}/recipients/{recipient}/attachments ### Description List EnvelopeRecipientAttachments ### Method GET ### Endpoint /api/envelopes/{envelope}/recipients/{recipient}/attachments ``` -------------------------------- ### My Envelopes Source: https://api.digisign.org/api/docs Operations for managing envelopes associated with the current user, including listing, embedding, and retrieving details. ```APIDOC ## GET /api/my/envelopes/to-sign ### Description List all envelopes that require the current user's signature. ### Method GET ### Endpoint /api/my/envelopes/to-sign ``` ```APIDOC ## GET /api/my/envelopes/waiting-for-others ### Description List all envelopes where the current user is a sender and waiting for others to sign. ### Method GET ### Endpoint /api/my/envelopes/waiting-for-others ``` ```APIDOC ## POST /api/my/envelopes/{envelope}/embed/signing ### Description Embed the signing process for a specific envelope. ### Method POST ### Endpoint /api/my/envelopes/{envelope}/embed/signing ``` ```APIDOC ## GET /api/my/envelopes/{envelope}/info ### Description Retrieve summary information for a specific envelope. ### Method GET ### Endpoint /api/my/envelopes/{envelope}/info ``` ```APIDOC ## GET /api/my/envelopes/{envelope} ### Description Retrieve detailed information for a specific envelope. ### Method GET ### Endpoint /api/my/envelopes/{envelope} ``` ```APIDOC ## GET /api/my/envelopes ### Description List all envelopes associated with the current user. ### Method GET ### Endpoint /api/my/envelopes ``` ```APIDOC ## POST /api/my/envelopes/bulk-sign ### Description Create bulk signature envelopes for the current user. ### Method POST ### Endpoint /api/my/envelopes/bulk-sign ``` ```APIDOC ## POST /api/my/envelopes/{envelope}/recipients/{recipient}/embed ### Description Embed a specific recipient for an envelope. ### Method POST ### Endpoint /api/my/envelopes/{envelope}/recipients/{recipient}/embed ``` -------------------------------- ### Me - Disable 2FA Source: https://api.digisign.org/api/docs Disables two-factor authentication for the current user. ```APIDOC ## DELETE /api/account/me/2fa ### Description Disable 2FA. ### Method DELETE ### Endpoint /api/account/me/2fa ``` -------------------------------- ### Replace File on EnvelopeTemplateDocument Source: https://api.digisign.org/api/docs Replaces the file for a specific document within an envelope template. ```APIDOC ## POST /api/envelope-templates/{template}/documents/{document}/replace-file ### Description Replace File on EnvelopeTemplateDocument ### Method POST ### Endpoint /api/envelope-templates/{template}/documents/{document}/replace-file ``` -------------------------------- ### AccountSmsSender - List Account SMS Senders Source: https://api.digisign.org/api/docs Lists all account SMS senders. ```APIDOC ## GET /api/account/sms-senders ### Description List AccountSmsSenders. ### Method GET ### Endpoint /api/account/sms-senders ``` -------------------------------- ### User - Reset 2FA for User Source: https://api.digisign.org/api/docs Resets two-factor authentication for a specific user. ```APIDOC ## POST /api/account/users/{user}/2fa/reset ### Description Reset 2FA for User in a current organisation. ### Method POST ### Endpoint /api/account/users/{user}/2fa/reset ``` -------------------------------- ### Label Operations Source: https://api.digisign.org/api/docs Endpoints for managing labels, including listing, creating, retrieving, updating, and deleting. ```APIDOC ## GET /api/labels ### Description List Labels. ### Method GET ### Endpoint /api/labels ``` ```APIDOC ## POST /api/labels ### Description Create Label. ### Method POST ### Endpoint /api/labels ``` ```APIDOC ## GET /api/labels/{label} ### Description Get label. ### Method GET ### Endpoint /api/labels/{label} ``` ```APIDOC ## PUT /api/labels/{label} ### Description Update label. ### Method PUT ### Endpoint /api/labels/{label} ``` ```APIDOC ## DELETE /api/labels/{label} ### Description Delete label. ### Method DELETE ### Endpoint /api/labels/{label} ```