{"id":20393354,"url":"https://github.com/foxitsoftware/foxit-esign-api-for-customization-and-branding","last_synced_at":"2026-02-23T04:09:08.190Z","repository":{"id":261816342,"uuid":"884464330","full_name":"foxitsoftware/foxit-esign-api-for-customization-and-branding","owner":"foxitsoftware","description":"Customization and Branding features in Foxit eSign APIs","archived":false,"fork":false,"pushed_at":"2024-11-08T15:14:28.000Z","size":303,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-13T18:48:51.300Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foxitsoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-06T19:52:52.000Z","updated_at":"2024-11-08T15:14:31.000Z","dependencies_parsed_at":"2024-11-08T16:24:32.218Z","dependency_job_id":"8c6f7b8b-a4c6-48ff-934e-a055a5ce11ca","html_url":"https://github.com/foxitsoftware/foxit-esign-api-for-customization-and-branding","commit_stats":null,"previous_names":["foxitsoftware/foxit-esign-api-for-customization-and-branding"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/foxitsoftware/foxit-esign-api-for-customization-and-branding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxitsoftware%2Ffoxit-esign-api-for-customization-and-branding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxitsoftware%2Ffoxit-esign-api-for-customization-and-branding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxitsoftware%2Ffoxit-esign-api-for-customization-and-branding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxitsoftware%2Ffoxit-esign-api-for-customization-and-branding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foxitsoftware","download_url":"https://codeload.github.com/foxitsoftware/foxit-esign-api-for-customization-and-branding/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxitsoftware%2Ffoxit-esign-api-for-customization-and-branding/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269654977,"owners_count":24454351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-09T02:00:10.424Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T03:48:20.900Z","updated_at":"2025-10-18T22:45:37.488Z","avatar_url":"https://github.com/foxitsoftware.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Customization and Branding with Foxit eSign APIs\n\nFoxit eSign provides a range of customization and branding options through its APIs, enabling seamless integration into your applications. These APIs include a set of common parameters that can be easily added to API requests for customization, allowing you to tailor the user experience to match your application’s theme, workflow, and feature requirements.\n\n## Embed Foxit eSign in Your Application or Website\n\nFoxit eSign's Envelope and Template endpoints offer parameters that generate embeddable URLs. These URLs can be embedded within web applications using an iFrame or accessed directly via a browser, depending on how document sending or signing is integrated within your application.\n\nThere are two embeddable views available for integration:\n1. **Embedded Signing View**\n2. **Embedded Sending View**\n\n### Embedded Signing View\n\nThe **Embedded Signing View** allows you to embed the document signing experience directly within your application or website. This view enables users to sign documents without leaving the platform, providing a seamless experience.\n\nYou can generate an embeddable URL for the signing view using the following endpoints:\n\n#### **Envelope Endpoints:**\n- `/folders/createfolder`\n- `/folders/sendDraftFolder`\n- `/folders/modifySharedFolder`\n\n#### **Template Endpoints:**\n- `/templates/createFolder`\n\n**Parameters to Generate Embedded Signing View URL:**\n\nTo generate the Embedded Signing View URL, include the following parameters in your API request:\n1. `createEmbeddedSigningSession`\n2. `createEmbeddedSigningSessionForAllParties`\n\nSet both parameters to *true* to receive the Embedded Signing View URL in the API response. The resulting URL will resemble this format:\n\n\n```\nhttps://{{HOST_NAME}}/embedded/embeddedsign?eetid={URL-ENCODED EMBEDDED-TOKEN}\n```\n\n\n**iFrame Example:** You can embed the Foxit eSign signing view within your application using an iFrame like this:\n```html\n\u003cdiv style=\"height: 100%; width: 100%; overflow: auto;\" data-role=\"content\"\u003e\n  \u003ciframe id=\"esignIframe\" src=\"[EMBED_SESSION_URL]\" style=\"width: 99% !important; height: 99% !important; position: absolute;\" frameborder=\"0\"\u003e\u003c/iframe\u003e\n\u003c/div\u003e\n```\n\n### Embedded Sending View \nThe **Embedded Sending View** offers a document preparation interface that allows users to add fields to a document, manage signers, and send documents directly from within your application. This view is perfect for applications where users need to prepare documents for signature before sending.\nGenerate an embeddable URL for the sending view using the following endpoints: \u003cbr\u003e\n#### **Envelope Endpoints:**\n- `/folders/createfolder`\n- `/folders/modifySharedFolder`\n\n#### **Template Endpoints:**\n- `/templates/createFolder`\n\n**Parameters to generate Embedded Sending View URL**\u003cbr\u003e\nTo generate the Embedded Sending View URL, include the following parameter in your API request:\u003cbr\u003e\n - `createEmbeddedSendingSession`\n\n\nSet this parameter to true to receive the Embedded Sending View URL in the API response. The resulting URL will resemble this format:\n```\n https://{{HOST_NAME}}/embedded/embeddedsend?eetid={URL-ENCODED-EMBEDDED-TOKEN}\n ```\n\n **iFrame Sample**: Embed Foxit eSign in your application using iFrame like:\n ```html\n \u003cdiv style=\"height: 100%; width: 100%; overflow: auto;\" data-role=\"content\"\u003e\n\u003ciframe src=\"[EMBED_SESSION_URL]\" style=\"width: 99% !important;height: 99% !important;position: absolute;\" frameborder=\"0\"\u003e\u003c/iframe\u003e\n\u003c/div\u003e\n```\n\n## Email Templates for Personalized Email Notifications\nSignificantly improve the signer experience with Email Personalization. Select an Email Template for recipients with customized contents. These email templates can be sent to a specific recipient or group of recipients as invitaion notification utilizing Foxit eSign's API. \n\n\nThe email templates can be customized at the account level from settings under \"Email templates\" tab.\n\n\u003cimg src=\"email templates tab.png\"\u003e\n\nWe provide customization of email content, logo, button color and email footer.\n\n\u003cimg src=\"email customization features.png\"\u003e\n\n### Email Temaplate Id\nEach email template created will have a unique Email Template id which will be used in the API request to add the email template.\n\u003cimg src=\"email template id.png\"\u003e\n\u003cbr\u003e\u003cbr\u003e\nThe endpoints which can access this feature are:\n\n#### **Envelope Endpoints:**\n- `/folders/createfolder`\n- `/folders/sendDraftFolder`\n- `/folders/modifySharedFolder`\n\n#### **Template Endpoints:**\n- `/templates/createFolder`\n\n**Parameter to add Email template for personalized experience**\u003cbr\u003e\nSend a document with personalized email content using template email id by including the following parameter in your API request:\u003cbr\u003e\n - `emailTemplateId`\n\nPass the particular email template id to use the email template other than the default email.\u003cbr\u003e\nBelow is the sample of the personalized email sent to recipient:\u003cbr\u003e\n\u003cimg src=\"email personalization.png\"\u003e\n\n## Redirect Signers and Users to Custom Pages\n\nFoxit eSign APIs offer the flexibility to redirect signers and users to custom pages at various stages of the document signing process. This feature allows companies to provide a seamless, tailored experience that aligns with their application’s theme and user journey.\n\n### Redirect Signers to Custom Pages\n\nFoxit eSign provides several API parameters to control the redirection of signers based on their actions in the embedded signing view. \n\n![Redirecting signers options](redirecting%20signers%20options.png)\n\nIn the embedded signing view, a signer can either eSign the document or choose other actions via the **\"More Actions\"** dropdown, which includes options like **Decline to Sign** or **Sign Later**. Based on the signer's selection, you can redirect them to custom pages:\n\n1. **Redirect signers upon successfully signing the document.**\n2. **Redirect signers when they select the *Decline to Sign* option from the *More Actions* dropdown.**\n3. **Redirect signers when they choose the *Sign Later* option from the *More Actions* dropdown.**\n\nThis gives a full control over the post-signing user experience, ensuring a smooth and branded journey for customers/signers.\n\nThe endpoints which can access this feature are:\n\n#### **Envelope Endpoints:**\n- `/folders/createfolder`\n- `/folders/sendDraftFolder`\n- `/folders/modifySharedFolder`\n\n#### **Template Endpoints:**\n- `/templates/createFolder`\n\n**Parameters to Redirect Signers**\u003cbr\u003e\nSend a document including the following parameters in your API request to redirect users in different scenarios:\u003cbr\u003e\n - `signSuccessUrl` - Add the absolute URL for the custom landing page of a website/application, which the signer will be redirected to after **successfully signing** the folder in the embedded signing view.\n - `signDeclineUrl` - Add the absolute URL for the custom landing page of a website/application, which the signer will be redirected to if **declines** to sign the folder in the embedded signing view.\n - `signLaterUrl` - Add the absolute URL for the custom landing page of a website/application, which the signer will be redirected to if **chooses** to sign the folder later in the embedded signing view.\n - `signErrorUrl` - Add the absolute URL for the custom landing page of a website/application, which the user will be redirected to if **error** comes during signing the folder in the embedded signing view.\n\n **JSON Sample**: Please find the sample of `/folders/createfolder` endpoint. \n ```JSON\n {\n  \"folderName\": \"Foxit eSign Contract.pdf\",\n  \"fileNames\": [\n    \"Foxit eSign Contract.pdf\"\n  ],\n    \"parties\": [\n    {\n      \"firstName\": \"M\",\n      \"lastName\": \"H\",\n      \"emailId\": \"spider.man@marvel.com\",\n      \"permission\": \"FILL_FIELDS_AND_SIGN\",\n      \"sequence\": 1,\n      \"workflowSequence\": 1,\n      \"allowNameChange\": true\n    }\n  ],\n  \"processTextTags\": true,\n  \"processAcroFields\": true,\n  \"signSuccessUrl\": \"www.redirect-custom-success.com\",\n  \"signDeclineUrl\": \"www.redirect-custom-decline.com\",\n  \"signLaterUrl\": \"www.redirect-custom-later.com\",\n  \"signErrorUrl\": \"www.redirect-custom-error.com\"\n}\n```\n\nFor any queries and support, please contact:\n\n[![Foxit eSign](/foxitsign_newlogo.png)](https://www.foxit.com/esign-pdf/api/)\n\nEmail us at support@foxitsoftware.com\n\n \u003ccenter\u003e2024 © Foxit Software Incorporated. All rights reserved.\u003ccenter\u003e\n\n[Terms of Use](https://www.foxit.com/product/terms-of-service.html) | [Privacy Policy](https://www.foxit.com/company/privacy-policy.html) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxitsoftware%2Ffoxit-esign-api-for-customization-and-branding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoxitsoftware%2Ffoxit-esign-api-for-customization-and-branding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxitsoftware%2Ffoxit-esign-api-for-customization-and-branding/lists"}