docuseal-code

How References Are Organised

references/

• references/embed/

  — Embed UI components (signing forms, template builder). Each file is self-contained — load only the ones matching the user's stack.

• references/api/

  — REST API endpoints and webhooks. One file per endpoint/webhook with parameters, schemas, code examples, and response samples.

Embed UI Components

<docuseal-form>

<docuseal-builder>

Signing Form (

<docuseal-form>

)

• JavaScript / HTML → references/embed/signing-form-js.md
• React → references/embed/signing-form-react.md
• Vue → references/embed/signing-form-vue.md
• Angular → references/embed/signing-form-angular.md
• Mobile (Android/iOS/React Native/Flutter via WebView) → references/embed/signing-form-mobile-integration.md

Form Builder (

<docuseal-builder>

)

• JavaScript / HTML → references/embed/form-builder-js.md
• React → references/embed/form-builder-react.md
• Vue → references/embed/form-builder-vue.md
• Angular → references/embed/form-builder-angular.md

## Guides

Cross-cutting

• JWT token generation — Form Builder (Node/TypeScript/Ruby/Python/PHP/Java/C#/Go) → references/embed/form-builder-jwt-token.md
• JWT token generation — Signing Form completed/preview mode → references/embed/signing-form-completed-preview-jwt-token.md
• EU Cloud / self-hosted

  host

  configuration — Signing Form → references/embed/signing-form-hosts.md
• EU Cloud / self-hosted

  host

  configuration — Form Builder → references/embed/form-builder-hosts.md
• Custom CSS theming — Signing Form (dark theme reference) → references/embed/signing-form-custom-css.md
• Custom CSS theming — Form Builder (dark theme reference) → references/embed/form-builder-custom-css.md

Packages

https://cdn.docuseal.com/js/form.js

https://cdn.docuseal.com/js/builder.js

@docuseal/react

@docuseal/vue

@docuseal/angular

react-native-webview

webview_flutter

Common Embed Mistakes

data-token

data-token

host

data-host

data-host="cdn.docuseal.eu"

/d/{slug}

/s/{slug}

/d/{slug}

/s/{slug}

/submissions

data-src

/submissions

/d/{slug}

data-*

customCss

customCss

data-custom-css

REST API

Authentication

X-Auth-Token

X-Auth-Token: YOUR_API_KEY

Base URLs

https://api.docuseal.com

https://api.docuseal.eu

https://docuseal.yourdomain.com/api

API Client SDKs

@docuseal/api

npm install @docuseal/api

docuseal

pip install docuseal

docuseal

gem install docuseal

docusealco/docuseal

composer require docusealco/docuseal

Endpoints

• GET /templates

  — List all templates

• GET /templates/{id}

  — Get a template

• DELETE /templates/{id}

  — Archive a template

• PUT /templates/{id}

  — Update a template

• PUT /templates/{id}/documents

  — Update template documents

• POST /templates/{id}/clone

  — Clone a template

• POST /templates/html

  — Create a template from HTML

• POST /templates/docx

  — Create a template from Word DOCX

• POST /templates/pdf

  — Create a template from PDF

• POST /templates/merge

  — Merge templates

• GET /submissions

  — List all submissions

• GET /submissions/{id}

  — Get a submission

• GET /submissions/{id}/documents

  — Get submission documents

• DELETE /submissions/{id}

  — Archive a submission

• POST /submissions/emails

  — Create submissions from emails

• POST /submissions/pdf

  — Create a submission from PDF

• POST /submissions/docx

  — Create a submission from DOCX

• POST /submissions/html

  — Create a submission from HTML

• POST /submissions

  — Create a submission

• GET /submitters/{id}

  — Get a submitter

• PUT /submitters/{id}

  — Update a submitter

• GET /submitters

  — List all submitters

Webhooks

• Form Webhook
• Submission Webhook
• Template Webhook

Common API Patterns

1. Send a document for signing: create a template (or use existing) →

   POST /submissions

   with submitter emails → submitters receive signing links
2. Embed signing in your app: create submission with

   send_email: false

   → use returned

   slug

   with

   <docuseal-form>

   (see Embed UI Components above)
3. Pre-fill and auto-sign:

   POST /submissions

   with

   fields[].default_value

   and

   completed: true

4. Track completion: poll

   GET /submissions/{id}

   or configure webhooks for

   form.completed

5. Download signed documents:

   GET /submissions/{id}/documents

   returns PDF URLs

Quick Decision Flow

1. Embedding a component? → Signing Form or Form Builder → load from

   references/embed/

   .
2. Making API calls? → Check if the user's language has an SDK (JS/TS, Python, Ruby, PHP) and prefer it over raw HTTP. Load the matching endpoint from

   references/api/

   .
3. How-to question about embed? Follow links from the component reference's

   ## Guides

   section.
4. Mobile? Load references/embed/signing-form-mobile-integration.md.
5. JWT needed? Always for Form Builder — load references/embed/form-builder-jwt-token.md. For Signing Form only when using

   data-token

   (preview/completed mode) — load references/embed/signing-form-completed-preview-jwt-token.md.
6. Not on

   docuseal.com

   ? Load references/embed/signing-form-hosts.md or references/embed/form-builder-hosts.md depending on the component.
7. Custom theme? Load references/embed/signing-form-custom-css.md or references/embed/form-builder-custom-css.md depending on the component.
8. CLI commands? Load the sibling

   docuseal-cli

   skill from this same repo.