> For the complete documentation index, see [llms.txt](https://docs.complycube.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows.md).

# Workflows

Build KYC and KYB onboarding workflows with integrated AML screening. Combine identity verification, customer questionnaires, compliance policies, and follow-up actions in one verification journey.

### Workflows Overview

ComplyCube Workflows let you design and manage **customer verification journeys** in the Portal. Choose the checks and information you need, configure how results are evaluated, and decide what happens when a session is **Clear**, needs **Attention**, or is **Rejected**.

A workflow can combine [Document Check](https://docs.complycube.com/documentation/product-guides/identity-verification/document-check.md), [biometric liveness verification](https://docs.complycube.com/documentation/product-guides/identity-verification/document-check.md), [AML Screening](https://docs.complycube.com/documentation/product-guides/watchlist-pep-and-adverse-media/aml-screening-check.md), and other services. Add [Smart Forms](https://docs.complycube.com/documentation/product-guides/compliance-studio/smart-forms.md) to collect customer information and declarations, [eSignatures](https://docs.complycube.com/documentation/product-guides/compliance-studio/e-signatures.md) to capture signed agreements, and [Compliance Policies](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md) to evaluate defined requirements.

The workflow defines the journey. A **workflow session** records one customer's progress, evidence, results, and activity as they complete it.

| Part of the journey     | What you configure                                                         |
| ----------------------- | -------------------------------------------------------------------------- |
| **Entry controls**      | Access restrictions, contact verification, document autofill, and consent. |
| **Verification**        | Checks, questionnaires, and customer-facing capture settings.              |
| **Outcome and actions** | Session decision rules, client stage updates, and review cases.            |
| **Ongoing follow-up**   | Lifecycle triggers associated with the workflow, such as periodic reviews. |

{% hint style="info" %}
Use **Workflows** when you need a complete verification journey with multiple steps, session tracking, and decision rules. **Direct Checks** let you run individual checks without the workflow layer. Workflows are **recommended** for most regulated onboarding use cases.

Learn more about [Workflows and Direct Checks](https://docs.complycube.com/spaces/sw26JqCBnT6AEIbxAYyk/pages/-M7DZURzLR4QSX40QG7b#id-2.-verification-modes).
{% endhint %}

{% hint style="info" %}
If you're on a **legacy plan**, you may need to contact your Account Manager or [support](https://www.complycube.com/sales) to enable Workflows.
{% endhint %}

### Interactive guide

{% @arcade/embed flowId="PgbOrYRYtYkXwDj2pau7" url="<https://app.arcade.software/share/PgbOrYRYtYkXwDj2pau7>" %}

### Benefits

Workflows simplify **KYC and KYB onboarding**, combining verification, compliance decisions, and follow-up in one journey.

* **Faster setup**: Launch with ready-made templates tailored to your use case.
* **Low and no-code integration**: Integrate through the Hosted Solution, SDKs, or API, then manage workflow changes centrally.
* **Flexible onboarding journeys**: Combine verification checks with [dynamic questionnaires](https://docs.complycube.com/documentation/product-guides/compliance-studio/smart-forms.md) and [electronic signing](https://docs.complycube.com/documentation/product-guides/compliance-studio/e-signatures.md).
* **Policy-driven compliance**: Apply [regulatory and custom policies](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md) to support consistent KYC and AML decisions (e.g., UK DIATF Right to Work, Singapore MAS, Germany BaFin, FATF).
* **Automated follow-up**: Configure outcome rules, update client stages, and open review cases.
* **Adaptable verification**: Add checks or update policies without rebuilding your integration.
* **Data protection by design**: Collect relevant information to support data minimization.
* **Oversight and auditability**: Track customer journeys, decisions, and workflows from one place.

### Creating workflows

Open [workflows page](https://portal.complycube.com/workflowTemplates) in the Portal and **create a new workflow**. The template picker lets you start with predefined steps and, where included, compliance policies.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FBgtKDVA5dB7AV6F5Pz7I%2Fworkflows_template_selection.png?alt=media&amp;token=78977dd0-5c8c-440c-8b31-13fdea31f32e" alt=""><figcaption><p>Workflows - The template selection wizard.</p></figcaption></figure>

**Recommended** templates appear first, based on your industry and country. Templates are grouped by region, with your country's region expanded first. Filter by **check**, **policy**, or **country** to narrow the list. When you apply several filters, a template must match all of them.

Select a template to review its steps and policies, then choose **Use this template**. You can also create a **blank workflow** or **import** an exported configuration.&#x20;

A template is a **starting configuration**. Review its steps, policies, and settings against your requirements before activating it.

### Designing workflows

The **workflow designer** displays your journey from top to bottom. The **Library** on the left contains the checks and forms you can add. The **canvas** shows the journey, and the **settings panel** on the right displays the selected item's configuration.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2Ff2oVt4Ge1mJMMo2q1lar%2Fworkflows_designer.png?alt=media&amp;token=77f6bf03-1760-46e8-ad8d-0ad7b9e0cfe5" alt=""><figcaption><p>Workflows - Preview of the workflow designer.</p></figcaption></figure>

The top bar shows the workflow's **name**, **version**, and **status**. Use **Flow / Lifecycle** to switch views, **Undo / Redo** to reverse or restore changes, and **Preview** to open the customer-facing web journey. **More (…)** contains advanced settings and import and export options.

#### Adding and arranging steps <a href="#toc_7" id="toc_7"></a>

1. Find a check or Smart Form in the **Library**. You can search by name or browse the categories.
2. Drag the item onto the canvas.
3. Select the step to configure it in the **settings panel**.
4. Drag steps to change their order, or use **Move up / Move down** from a step's "**…**" menu.
5. To remove a step, drag it back to the Library or select **Remove**. Use **Undo** to restore it if needed.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FhtvT6SaqbmkmFqsmUKpR%2Fworkflows_drag.jpg?alt=media&amp;token=28454ca1-708f-4a49-aa37-fa6386854511" alt=""><figcaption><p>Workflows - Add verification steps where they belong in the customer journey.</p></figcaption></figure>

The Library shows services outside your plan, but they cannot be added. Some check types have **placement or quantity restrictions**.

#### Configuring steps <a href="#toc_8" id="toc_8"></a>

A step can have up to three settings tabs:

| Tab            | What it controls                                                                                                              |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| **Basic**      | The step name, its ID, and a link to the service's documentation. For a Smart Form, open the form designer here.              |
| **Capture**    | The customer-facing experience, such as accepted document types, capture attempts, live capture, NFC, or available countries. |
| **Processing** | How results are evaluated, including supported thresholds, minimum age, monitoring, and data validation settings.             |

<div><figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2Fiz5pa3JlTyPD0CGUG7UF%2Fworkflows_settings_basic.png?alt=media&amp;token=f14b5c39-67eb-411d-bc7d-7259a997703d" alt="" width="368"><figcaption></figcaption></figure> <figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FJ8mwA3SU5WEN4DZ3H6Pk%2Fworkflows_settings_capture.png?alt=media&amp;token=b82eb8a3-b11d-43f7-bbe8-a90772f693e9" alt="" width="368"><figcaption></figcaption></figure> <figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FMJhgAV00jrMiBCXcl14N%2Fworkflows_settings_processing.png?alt=media&amp;token=dd597dd8-3da5-458e-a0d9-dbfe5120912a" alt="" width="368"><figcaption></figcaption></figure></div>

ComplyCube automatically assembles the **customer-facing capture screens** needed for the selected checks, showing only relevant screens and minimizing data collection through **privacy by design**.&#x20;

Configure each check's capture and processing settings within the workflow to control the journey and its evaluation.

#### Workflow details <a href="#toc_9" id="toc_9"></a>

Select an empty area of the canvas to open the workflow's **details panel**. Here you can review its name, ID, description, last update, and associated lifecycle triggers.

The panel also contains [Compliance Policies](#toc_13), including their revisions and an option to update to a newer revision.

### Entry controls <a href="#toc_10" id="toc_10"></a>

Configure entry controls to determine who can begin a session and what happens before verification.

#### Access restrictions <a href="#toc_11" id="toc_11"></a>

This allows you to control who can access verification workflows using rules based on country, IP address, email address, or domain.

Above **Start flow**, select **Restrict** beside **Anyone can start** to choose an **access restriction list**. The list is evaluated when a session is created, before verification steps run.

The access panel shows the selected list's scope. You can manage lists in the [access restrictions list](https://portal.complycube.com/accessRestrictionLists) page.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FTtxESNZmiltfOVKUoBRo%2Fworkflows_access_restrictions.png?alt=media&amp;token=4858a750-f494-4a5e-bd3a-cacfb3eb0f1d" alt=""><figcaption><p>Workflows - Apply an access restriction list before a verification session starts.</p></figcaption></figure>

#### OTP verification and document autofill <a href="#toc_12" id="toc_12"></a>

Select **Start flow** to configure:

* **OTP verification**: Verify the customer's email address, mobile number, or both with a one-time passcode.
* **Document autofill**: Populate customer details from their identity document during the journey.

When a [Lifecycle Trigger](https://docs.complycube.com/documentation/product-guides/compliance-studio/lifecycle-triggers.md) sends the workflow, entry indicators above **Start flow** show **Manual or API** alongside the associated triggers and their timing.

### Compliance policies <a href="#toc_13" id="toc_13"></a>

[Compliance Policies](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md) evaluate verification evidence against **regulatory frameworks**, **industry requirements**, or **internal controls**. Attach policies from the workflow details panel using **Add policy**. Not every workflow template includes policies.

{% columns %}
{% column width="50%" valign="middle" %}

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FtRbROh93Pj6377uftydD%2Fworkflows_compliance_policies.png?alt=media&amp;token=9717e880-eedc-40e2-97ab-bb743e435364" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column width="50%" valign="middle" %}
Each policy shows its **revision**. When a newer revision is available, review it and update the attached policy from the details panel.

After a session completes, policy evaluation results appear under **Policy Assurance**. See [Regulatory coverage](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md#supported-regulatory-and-industry-frameworks) for supported frameworks and jurisdictions.
{% endcolumn %}
{% endcolumns %}

### Outcome rules and actions <a href="#toc_14" id="toc_14"></a>

Below **Complete flow**, choose how verification results translate into decisions and follow-up actions.

* Use **Outcome rules** to evaluate check results and client attributes, then set the session outcome to **Clear**, **Attention**, or **Rejected**.
* Add actions to the **result lanes** to update the client’s stage or open a review case for each outcome.
* Configure **Alert cases** when a specific check result needs review, even if the overall session is **Clear**.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FElQcGp7fRsjrCnp8i7wX%2Fworkflows_outcome_rules.png?alt=media&amp;token=ccea81cf-1f3d-408f-8248-fed71a8bc635" alt=""><figcaption><p>Workflows - Configure session decisions and follow-up actions after verification.</p></figcaption></figure>

If no outcome rule matches, ComplyCube uses its **default session result**. Compliance policies are evaluated after outcome rules and can raise **Attention**. A team member's direct session outcome override takes precedence over automated outcomes.

See [Outcome rules and actions](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/outcome-rules-and-actions.md) for rule conditions, evaluation order, result lanes, and case settings.

### Ongoing reviews and lifecycle triggers <a href="#toc_15" id="toc_15"></a>

[Lifecycle Triggers](https://docs.complycube.com/documentation/product-guides/compliance-studio/lifecycle-triggers.md) connect workflows to **ongoing customer due diligence**. For example, a trigger can send a review workflow when a periodic review is due or an identity document approaches expiration.

View associated lifecycle triggers at the top of the workflow designer, or in the right-hand workflow details panel. Select a trigger to review its configuration, or open **Lifecycle Triggers** to manage events, client filters, actions, and approval requirements.

### Lifecycle view <a href="#toc_16" id="toc_16"></a>

Select **Lifecycle** in the top bar to review or edit the journey in four columns:

| Column                | What it shows                                               |
| --------------------- | ----------------------------------------------------------- |
| **Who can start**     | Access restrictions and Start flow settings.                |
| **Verification**      | The ordered verification steps.                             |
| **Outcome**           | Result actions and alert cases.                             |
| **What happens next** | Associated lifecycle triggers and their events and actions. |

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FADFTR2L6shgAMJVK8P58%2Fworkflows_lifecycle.png?alt=media&amp;token=4a37a8e0-ca8d-4531-8651-4e2fe828e9bd" alt=""><figcaption><p>Workflows (Lifecycle View) - Review entry controls, verification, decisions, and follow-up in one view.</p></figcaption></figure>

Select a card to open its settings on the right. You can also **add**, **reorder**, or **remove** verification steps from this view.

### Advanced settings <a href="#toc_17" id="toc_17"></a>

Open **More (…) > Advanced settings** to configure **Client consent**. This displays a consent screen asking the customer to agree to personal data processing before checks run.

### Workflow versions

A workflow’s first version is created automatically. As you make changes in the workflow designer, select **Save as draft** to continue editing or **Save new version** to publish an updated configuration.

Each published version preserves its configuration and **cannot be edited**, giving you a clear version history and audit trail.

New published versions start **Inactive**, so you can review and test changes before activating them. Only one version can be **Active** at a time, and existing sessions remain on the version they started with.

<figure><img src="https://1615271746-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKyFKMqftsmT6qln9zo5y%2Fuploads%2FapMeLMNZcDUziznpGxXD%2Fworkflows_versions.png?alt=media&amp;token=b2968725-0ab3-4bc8-aac7-f988b1ebb0e4" alt=""><figcaption><p>Workflows - View all versions of your workflow template.</p></figcaption></figure>

The editor checks configuration as you work. Save is **disabled** while validation errors remain, such as a missing country selection, a case without a template, or a rule referring to a removed step.

#### Workflow statuses <a href="#toc_19" id="toc_19"></a>

<table><thead><tr><th width="194.9765625">Status</th><th>Description</th></tr></thead><tbody><tr><td><strong>Draft</strong></td><td>A configuration being created or edited before publication.</td></tr><tr><td><strong>Inactive</strong></td><td>A published version that is disabled or superseded.</td></tr><tr><td><strong>Active</strong></td><td>The published version available for use.</td></tr></tbody></table>

You control activation manually. Existing sessions remain on the **version they started with**.

{% hint style="info" %}
A workflow used by a **lifecycle trigger** cannot be deactivated until it is removed from that trigger.
{% endhint %}

#### Import and export <a href="#toc_20" id="toc_20"></a>

Use **More (…) > Export workflow** to download a workflow configuration. Use **Import workflow** to load an exported configuration, including when copying a workflow between accounts or environments. Review the imported configuration and resolve validation issues before saving.

### Workflow session <a href="#toc_21" id="toc_21"></a>

A **workflow session** records one customer's verification journey, including progress, captured information, check results, and the audit trail. Sessions can be started through the Portal, supported integrations, or Lifecycle Triggers.

See [Workflow sessions and results](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/workflow-sessions-and-results.md) for ways to start sessions, review evidence, and access results.

#### Session tracking <a href="#toc_22" id="toc_22"></a>

Review **customer progress**, **verification checks**, and the **activity timeline** in the Portal. The **Flow setup** tab shows the workflow version used by the session.

See [Session tracking](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/workflow-sessions-and-results.md#toc_4) for details.

#### Session lifecycle <a href="#toc_23" id="toc_23"></a>

Sessions move through **Started**, **Processing**, **Complete**, **Abandoned**, or **Cancelled** states. The state describes progress through verification; it is separate from the session's decision outcome.

See [Session lifecycle](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/workflow-sessions-and-results.md#toc_6) for state definitions and when customers can resume a session.

#### Session results <a href="#toc_24" id="toc_24"></a>

Review **Clear**, **Attention**, or **Rejected** outcomes alongside the supporting check and policy results. Results are available in the **Portal**and through the **API**, with **webhooks** for session notifications.

See [Session results](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/workflow-sessions-and-results.md#toc_7) for default decision behavior, outcome rules, and manual overrides.

### Dynamic workflows

Dynamic workflows let you build **adaptive KYC onboarding** and **identity verification** journeys. Combine **Smart Forms**, check configuration, and **verification processing rules** to tailor verification to each customer.

Collect relevant information, run appropriate checks, and support complex compliance requirements without rebuilding the entire journey.

Common use cases include:

* **Rule-based customer routing**: Direct customers to different workflows based on their responses and your business or compliance rules.
* **Conditional data capture**: Show additional questions, declarations, or document requests when configured conditions are met.
* **Enhanced due diligence**: Route higher-risk customers to workflows with additional checks and jurisdiction-specific requirements.
* **Advanced post-processing**: Apply custom processing logic to individual check results before workflow outcome rules determine the session outcome.

{% hint style="info" %}
Contact your **Account Manager** to enable advanced post-processing or dynamic workflow rules.
{% endhint %}

### Monitoring performance <a href="#toc_26" id="toc_26"></a>

Use workflow analytics to review **completion**, **abandonment**, **failure rates**, and **average verification time**, then identify where to improve the customer journey.

See [Monitoring performance](https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows/workflow-sessions-and-results.md#toc_12) for guidance.

### Best practices

Build verification journeys that are consistent, efficient, and easy to maintain:

* **Start with a template**: Use a predefined workflow as your foundation, then review its checks and policies against your requirements.
* **Keep flows simple**: Include only relevant checks and information requests to reduce customer effort and onboarding friction.
* **Test before publishing**: Preview and test workflows end-to-end to confirm the customer experience, policy alignment, and data capture settings are correct.
* **Review decision logic**: Check rule order and fallback behavior so automated outcomes reflect your intended decisions.
* **Manage versions carefully**: Review and test each new version before activating it. Existing sessions retain the version they started with.
* **Connect results to operations**: Use webhooks for downstream actions, cases for manual review, and Lifecycle Triggers for ongoing customer due diligence.

### Frequently asked questions

<details>

<summary>When should I use Workflows instead of Direct Checks?</summary>

Use Workflows when you need a complete onboarding journey rather than a single standalone verification.

They are usually the better fit for regulated onboarding, multi-step KYC flows, and cases where you need policy-driven decisioning.

Use Direct Checks when you only need to run one check without the wider workflow layer.

</details>

<details>

<summary>What verification checks can I include in a workflow?</summary>

You can include any ComplyCube verification checks in a workflow.

Common examples include [Document Check](https://docs.complycube.com/documentation/product-guides/identity-verification/document-check.md), [Identity Check](https://docs.complycube.com/documentation/product-guides/biometric-and-liveness-verification/identity-check.md), [AML Screening Check](https://docs.complycube.com/documentation/product-guides/watchlist-pep-and-adverse-media/aml-screening-check.md), [Smart Forms](https://docs.complycube.com/documentation/product-guides/compliance-studio/smart-forms.md), and [Compliance Policies](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md).

</details>

<details>

<summary>Can I build KYC workflows without writing code?</summary>

Yes.

Start with a **workflow template** or build your own, then [send customers a verification link](https://docs.complycube.com/documentation/quick-guides/web-portal-quick-guide/send-verification-link-workflows.md) from the Portal or integrate the workflow into your application.

</details>

<details>

<summary>Can I customize a workflow for different countries or risk levels?</summary>

Yes.

You can create multiple workflows to fit different use cases, countries, or risk levels.

For more complex requirements, you can use **dynamic workflows**, conditional rules, and policy logic to route customers into different verification paths based on jurisdiction, risk profile, or use case.

</details>

<details>

<summary>How do workflow sessions work?</summary>

A workflow session is created each time a customer starts a workflow journey.

It tracks customer progress, captured data, verification results, and the audit trail for that journey.

</details>

<details>

<summary>Can customers resume an incomplete workflow?</summary>

Yes, while the session is still active.

A customer can resume a **started** session from where they left off.

Once a session becomes **abandoned** or **cancelled**, it cannot be resumed and must be restarted.

</details>

<details>

<summary>How are workflow results and decisions returned?</summary>

Workflow results are available in the **Portal**, through the **API**, and through **webhooks**.

This supports both manual review and real-time downstream decisioning.

</details>

<details>

<summary>Can I add compliance policies and questionnaires to a workflow?</summary>

Yes.

You can add [Smart Forms](https://docs.complycube.com/documentation/product-guides/compliance-studio/smart-forms.md) to collect extra customer data and declarations, and [Compliance Policies](https://docs.complycube.com/documentation/product-guides/compliance-studio/policies.md) to apply rule-based evaluation inside the same journey.

</details>

<details>

<summary>Can workflows open cases and update client stages automatically?</summary>

Yes.

Configure result lane actions for Clear, Attention, and Rejected outcomes. Use **alert cases** for selected check findings regardless of the overall session outcome.

</details>

### Related topics

* [Smart Forms](https://docs.complycube.com/documentation/product-guides/compliance-studio/smart-forms.md) to collect customer information, declarations, and evidence.
* [Compliance Policies](#toc_13) to evaluate regulatory and internal requirements.
* [Lifecycle Triggers](https://docs.complycube.com/documentation/product-guides/compliance-studio/lifecycle-triggers.md) to automate ongoing reviews and re-verification.
* [Advanced Case Management](https://docs.complycube.com/documentation/product-guides/compliance-studio/advanced-case-management.md) to coordinate review tasks and investigations.
* [eSignatures](https://docs.complycube.com/documentation/product-guides/compliance-studio/e-signatures.md) to add electronic signing to verification journeys.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.complycube.com/documentation/product-guides/compliance-studio/workflows.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
