> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/didit.md).

# Didit

Create hosted KYC and KYB sessions, read verification decisions, screen AML, and apply session status updates from Didit webhooks.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Didit     | API Key        |

#### Didit

Connect with a Didit application API key to create hosted verification sessions, read decisions, screen AML, and receive session webhooks.

**Set up in Didit**

1. Prepare the Didit account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Application API key from the Didit Business Console. Session creation and every verification call use this key server-side only.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Didit**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                          |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Application API key from the Didit Business Console. Session creation and every verification call use this key server-side only. [Provider instructions](https://docs.didit.me/integration/programmatic-registration). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Didit** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create session

Create a hosted Didit verification session and return the URL for the end user.

**Inputs**

| Field                        | Type            | Required | Description                                                                                                     |
| ---------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Workflow                     | select (string) | Yes      | Didit workflow that defines which verification steps run. Options load from the selected connection.            |
| Internal user or business ID | string          | Yes      | Your internal user or business ID. Didit links the session to this entity.                                      |
| Callback URL                 | string          | No       | HTTPS URL Didit redirects the user to after verification.                                                       |
| Callback method              | select (string) | No       | Which side of a cross-device flow receives the callback redirect. Available values: Initiator, Completer, Both. |
| Language                     | string          | No       | ISO 639-1 language that locks the hosted verification UI.                                                       |
| Metadata JSON                | textarea        | No       | Optional JSON object echoed on every webhook for this session.                                                  |
| Contact email                | string          | No       | Prefills email verification and can receive the hosted-flow link.                                               |
| Email the verification link  | boolean         | No       | Ask Didit to email the hosted verification URL to the contact email. Default: false.                            |
| Contact phone                | string          | No       | E.164 phone number used to prefill phone verification. Ignored for KYB.                                         |
| Expected first name          | string          | No       | Name already known to your app, used to warn on document mismatches.                                            |
| Expected last name           | string          | No       | Last name already known to your app.                                                                            |
| Expected date of birth       | string          | No       | Date of birth in YYYY-MM-DD used to warn on document mismatches.                                                |
| Expected nationality         | string          | No       | ISO country code already known to your app.                                                                     |
| Company name                 | string          | No       | Prefills the hosted KYB company search. Ignored for KYC workflows.                                              |
| Registry country             | string          | No       | XX or XX-YY registry country that locks the KYB company search.                                                 |
| Registration number          | string          | No       | Company registration number used to prefill KYB search.                                                         |
| Sandbox scenario             | string          | No       | Sandbox-only outcome such as approve or decline\_aml\_hit.                                                      |

**Outputs**

| Field            | Type   | Description                                                                        |
| ---------------- | ------ | ---------------------------------------------------------------------------------- |
| Session ID       | string | Didit session UUID used to fetch the decision later.                               |
| Session number   | number | Human-friendly sequential session number.                                          |
| Verification URL | string | Hosted Didit URL to open for the end user. Do not send the API key to the browser. |
| Session token    | string | 12-character token embedded in the URL. Treat it as a secret.                      |
| Status           | string | Current session status. Newly created sessions return Not Started.                 |
| Internal ID      | string | The vendor\_data echoed back by Didit.                                             |
| Workflow ID      | string | Stable workflow ID the session is pinned to.                                       |
| Workflow version | number | Published workflow version pinned at session creation.                             |
| Callback URL     | string | Redirect URL stored on the session.                                                |

#### Get session decision

Read the full Didit decision, including per-feature verification arrays.

**Inputs**

| Field      | Type   | Required | Description                                               |
| ---------- | ------ | -------- | --------------------------------------------------------- |
| Session ID | string | Yes      | Didit session UUID returned when the session was created. |

**Outputs**

| Field                   | Type          | Description                                                   |
| ----------------------- | ------------- | ------------------------------------------------------------- |
| Session ID              | string        | Didit session UUID.                                           |
| Session kind            | string        | user for KYC or business for KYB.                             |
| Status                  | string        | Exact session status string. Compare case-sensitively.        |
| Environment             | string        | live or sandbox. Check this before mutating production state. |
| Internal ID             | string        | Your internal user or business ID stored on the session.      |
| Workflow ID             | string        | Workflow the session ran.                                     |
| NFC skip reason         | string        | Why NFC did not run, or empty when NFC completed.             |
| ID verifications        | object\_array | OCR results, one item per workflow node.                      |
| NFC verifications       | object\_array | NFC chip-read results.                                        |
| Liveness checks         | object\_array | Face liveness results.                                        |
| Face matches            | object\_array | 1:1 face-match results.                                       |
| Phone verifications     | object\_array | Phone verification results.                                   |
| Email verifications     | object\_array | Email verification results.                                   |
| Proof of address        | object\_array | Proof-of-address results.                                     |
| AML screenings          | object\_array | AML hits and scores.                                          |
| IP analyses             | object\_array | Device and IP risk signals.                                   |
| Database validations    | object\_array | Government-registry validation results.                       |
| Questionnaire responses | object\_array | Custom questionnaire submissions.                             |

#### List sessions

Search and list Didit verification sessions.

**Inputs**

| Field        | Type            | Required | Description                                                                                               |
| ------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| Session kind | select (string) | No       | List KYC users, KYB businesses, or both. Available values: KYC users, KYB businesses, All. Default: user. |
| Status       | string          | No       | Comma-separated exact status strings, for example Approved,In Review.                                     |
| Internal ID  | string          | No       | Exact match on the vendor\_data stored at session creation.                                               |
| Workflow ID  | string          | No       | Limit results to one workflow.                                                                            |
| Search       | string          | No       | Free-text search across names, emails, document numbers, and IDs.                                         |
| Page size    | integer         | No       | Number of sessions to return. Default: 50.                                                                |
| Offset       | integer         | No       | Number of rows to skip. Default: 0.                                                                       |

**Outputs**

| Field     | Type          | Description                                      |
| --------- | ------------- | ------------------------------------------------ |
| Count     | number        | Reported result count for this query.            |
| Sessions  | object\_array | Matching sessions, newest first.                 |
| Next page | string        | URL of the next page, or empty on the last page. |

#### Update session status

Manually approve, decline, or request resubmission for a Didit session.

**Inputs**

| Field      | Type            | Required | Description                                                                                                           |
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Session ID | string          | Yes      | Didit session UUID to update.                                                                                         |
| New status | select (string) | Yes      | Approved, Declined, or Resubmitted. Compare these strings exactly. Available values: Approved, Declined, Resubmitted. |
| Comment    | textarea        | No       | Reason stored on the session review trail.                                                                            |

**Outputs**

| Field      | Type   | Description                       |
| ---------- | ------ | --------------------------------- |
| Session ID | string | Updated session UUID.             |
| Status     | string | Status after the manual decision. |

#### Generate session PDF

Download a compliance PDF report for a finished Didit session.

**Inputs**

| Field      | Type   | Required | Description                                                            |
| ---------- | ------ | -------- | ---------------------------------------------------------------------- |
| Session ID | string | Yes      | Finished Didit session UUID. The session must already have a decision. |

**Outputs**

| Field        | Type   | Description                                |
| ------------ | ------ | ------------------------------------------ |
| Filename     | string | Suggested PDF filename.                    |
| PDF (base64) | string | Rendered compliance PDF encoded as base64. |
| Size (bytes) | number | PDF size in bytes.                         |

#### List workflows

List Didit verification workflows and their published versions.

**Inputs**

| Field     | Type    | Required | Description                                 |
| --------- | ------- | -------- | ------------------------------------------- |
| Page size | integer | No       | Number of workflows to return. Default: 50. |
| Offset    | integer | No       | Number of rows to skip. Default: 0.         |

**Outputs**

| Field     | Type          | Description                                                       |
| --------- | ------------- | ----------------------------------------------------------------- |
| Count     | number        | Total workflow versions for the application.                      |
| Workflows | object\_array | Workflows, newest first. Use workflow\_id when creating sessions. |

#### Create workflow

Create a Didit workflow that defines which KYC or KYB modules run.

**Inputs**

| Field           | Type                      | Required | Description                                                                                                                                                                                                                                                                                                                     |
| --------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workflow label  | string                    | Yes      | Name shown in the Didit console and workflow dropdown.                                                                                                                                                                                                                                                                          |
| Features        | multiple\_select (string) | Yes      | Verification modules to run, in execution order. KYB features make the workflow KYB. Available values: OCR, NFC, LIVENESS, FACE\_MATCH, AGE\_ESTIMATION, PHONE\_VERIFICATION, EMAIL\_VERIFICATION, DATABASE\_VALIDATION, AML, IP\_ANALYSIS, PROOF\_OF\_ADDRESS, QUESTIONNAIRE, KYB\_REGISTRY, KYB\_DOCUMENTS, KYB\_KEY\_PEOPLE. |
| Liveness method | select (string)           | No       | Liveness capture method used when LIVENESS is selected. Available values: Passive, Active 3D, Flashing. Default: PASSIVE.                                                                                                                                                                                                       |

**Outputs**

| Field          | Type   | Description                                            |
| -------------- | ------ | ------------------------------------------------------ |
| Workflow ID    | string | Stable ID to pass when creating sessions.              |
| Workflow label | string | Label stored on the workflow.                          |
| Workflow type  | string | kyc or kyb, inferred from the selected features.       |
| Status         | string | Usually published for a newly created simple workflow. |
| Features       | string | Feature list as returned by Didit.                     |

#### Screen AML

Screen a person or company against PEP, sanctions, and watchlist datasets.

**Inputs**

| Field                 | Type            | Required | Description                                                                       |
| --------------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Full name             | string          | Yes      | Full name of the person or company to screen.                                     |
| Entity type           | select (string) | No       | Screen a person or a company. Available values: Person, Company. Default: person. |
| Date of birth         | string          | No       | YYYY-MM-DD date of birth or incorporation date.                                   |
| Nationality           | string          | No       | ISO 3166-1 alpha-2 country code.                                                  |
| Document number       | string          | No       | Identity document number used as a golden-key match.                              |
| Internal ID           | string          | No       | Your identifier for the screened entity.                                          |
| Include adverse media | boolean         | No       | Also search news media. Adds up to about 30 seconds of latency. Default: false.   |
| Ongoing monitoring    | boolean         | No       | Keep re-screening this profile and push later hits by webhook. Default: false.    |
| Metadata JSON         | textarea        | No       | Optional JSON object stored with the screening.                                   |

**Outputs**

| Field       | Type   | Description                                                    |
| ----------- | ------ | -------------------------------------------------------------- |
| Request ID  | string | Session or correlation ID for this screening.                  |
| Status      | string | Approved, Declined, or In Review.                              |
| Risk score  | number | Highest risk score among hits that passed the match threshold. |
| Total hits  | number | Number of AML hits returned.                                   |
| Entity type | string | person or company.                                             |
| AML result  | object | Full AML payload including hits.                               |

#### Get billing balance

Read the current Didit prepaid credit balance.

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field                 | Type    | Description                                                 |
| --------------------- | ------- | ----------------------------------------------------------- |
| Balance               | string  | Current prepaid credit balance in USD, as a decimal string. |
| Auto-refill enabled   | boolean | Whether Didit will automatically top up credits.            |
| Auto-refill amount    | string  | USD amount charged on each auto-refill, when configured.    |
| Auto-refill threshold | string  | Balance that triggers an auto-refill, when configured.      |

#### List users

List Didit users assembled from KYC sessions that share the same internal ID.

**Inputs**

| Field     | Type    | Required | Description                             |
| --------- | ------- | -------- | --------------------------------------- |
| Page size | integer | No       | Number of users to return. Default: 50. |
| Offset    | integer | No       | Number of rows to skip. Default: 0.     |

**Outputs**

| Field | Type          | Description                              |
| ----- | ------------- | ---------------------------------------- |
| Count | number        | Reported user count for this page query. |
| Users | object\_array | Vendor users keyed by vendor\_data.      |

#### Get user

Read a Didit user by the internal ID you stored as vendor\_data.

**Inputs**

| Field            | Type   | Required | Description                                             |
| ---------------- | ------ | -------- | ------------------------------------------------------- |
| Internal user ID | string | Yes      | The vendor\_data you stored on the user's KYC sessions. |

**Outputs**

| Field            | Type   | Description                                  |
| ---------------- | ------ | -------------------------------------------- |
| Internal user ID | string | The user's integrator-owned identifier.      |
| Status           | string | Rolled-up verification status for this user. |
| First name       | string | Extracted first name, when available.        |
| Last name        | string | Extracted last name, when available.         |
| User             | object | Full vendor-user record.                     |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### On session updated

Trigger when a Didit verification session status or data changes.

**Event inputs**

| Field        | Type   | Required | Description                                                           |
| ------------ | ------ | -------- | --------------------------------------------------------------------- |
| Event ID     | string | Yes      | Stable Didit event id. Deduplicate retries on this value. Default: .  |
| Webhook type | string | Yes      | status.updated or data.updated. Default: status.updated.              |
| Session ID   | string | Yes      | Didit session UUID. Default: .                                        |
| Status       | string | Yes      | Exact session status. Compare case-sensitively. Default: Not Started. |
| Internal ID  | string | No       | Your internal user or business ID.                                    |
| Workflow ID  | string | No       | Workflow that produced the session.                                   |
| Environment  | string | No       | live or sandbox.                                                      |
| Session kind | string | No       | user for KYC or business for KYB.                                     |

**Outputs**

| Field        | Type   | Description                                                       |
| ------------ | ------ | ----------------------------------------------------------------- |
| Event ID     | string | Stable event id for idempotent handling.                          |
| Webhook type | string | status.updated or data.updated.                                   |
| Session ID   | string | Didit session UUID. Use Get session decision for the full report. |
| Status       | string | Exact Didit session status.                                       |
| Internal ID  | string | Your internal user or business ID.                                |
| Workflow ID  | string | Workflow that produced the session.                               |
| Environment  | string | live or sandbox.                                                  |
| Session kind | string | user for KYC or business for KYB.                                 |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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.stackai.com/integrations/catalog/didit.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.
