---
canonical_url: "https://docs.composio.dev/toolkits/didit"
markdown_url: "https://docs.composio.dev/toolkits/didit.md"
product: "platform"
version: null
last_updated: null
---

# Didit

Didit provides identity verification, KYC, KYB, AML, fraud prevention, and compliance APIs for onboarding and ongoing risk operations.

- **Category:** security & identity tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `DIDIT`
- **Version:** 00000000_00

## Tools

### Create Verification Session

**Slug:** `DIDIT_CREATE_VERIFICATION_SESSION`

Create a hosted KYC or KYB verification session from a published workflow and return the URL to give the end user. This may consume Didit credits and sends an invitation email only when explicitly requested.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string ("en" | "ar" | "bg" | "bn" | "bs" | "ca" | "cnr" | "cs" | "da" | "de" | "el" | "es" | "et" | "fa" | "fi" | "fr" | "he" | "hi" | "hr" | "hu" | "hy" | "id" | "it" | "ja" | "ka" | "kk" | "ko" | "ky" | "lt" | "lv" | "mk" | "mn" | "ms" | "nl" | "no" | "pl" | "pt-BR" | "pt" | "ro" | "ru" | "sk" | "sl" | "so" | "sq" | "sr" | "sv" | "th" | "tr" | "uk" | "uz" | "vi" | "zh-CN" | "zh-TW" | "zh") | No | Supported Didit interface language code. Omit for browser language detection. |
| `metadata` | string | No | Private JSON correlation or business context stored with the session and echoed in decisions and webhooks. |
| `vendor_data` | string | No | Your stable user or business identifier; strongly recommended for grouping, duplicate suppression, and unfinished-session reuse. |
| `workflow_id` | string | Yes | Stable ID of the published workflow to run; obtain it from DIDIT_LIST_WORKFLOWS. |
| `callback_url` | string | No | Redirect URL after verification. Didit appends the session ID and status; omit to use the workflow default. |
| `callback_method` | string ("initiator" | "completer" | "both") | No | Device allowed to perform the final redirect: initiator, completer, or both. |
| `contact_details` | object | No | Optional contact prefill. Notification emails remain disabled unless explicitly enabled. |
| `expected_details` | object | No | Expected person or company details for cross-validation or KYB registry prefilling. |
| `sandbox_scenario` | string | No | Sandbox-only scenario slug. Live applications reject this field. |
| `portrait_image_base64` | string | No | Base64 portrait up to 2 MB for biometric-authentication or pre-OCR face-match workflows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Billing Balance

**Slug:** `DIDIT_GET_BILLING_BALANCE`

Read the organization's prepaid Didit credit balance and auto-refill settings before starting billable verification work.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Business

**Slug:** `DIDIT_GET_BUSINESS`

Fetch one aggregated KYB business profile by its exact vendor_data identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_data` | string | Yes | Your exact free-form business identifier. This is not a UUID unless your own identifier happens to be one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `DIDIT_GET_USER`

Fetch one aggregated KYC user profile by its exact vendor_data identifier. Returns the complete provider record, including identity summary, session aggregation, metadata, tags, and comments or activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_data` | string | Yes | Your exact free-form user identifier. This is not a UUID unless your own identifier happens to be one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Verification Decision

**Slug:** `DIDIT_GET_VERIFICATION_DECISION`

Retrieve the complete current KYC or KYB decision and all feature reports for one verification session. Feature report arrays and unknown provider fields are preserved; media URLs in the result are short-lived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Session UUID returned by session creation, listing, or a Didit webhook. |
| `include_events` | boolean | No | For KYC only, include the event timeline, review activity, blocklist flags, cost breakdown, and expanded workflow metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `DIDIT_GET_WORKFLOW`

Fetch the full configuration and pricing of one workflow version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_version_id` | string | Yes | Per-version UUID from the uuid field returned by DIDIT_LIST_WORKFLOWS, not the stable workflow_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Businesses

**Slug:** `DIDIT_LIST_BUSINESSES`

List business profiles aggregated from KYB sessions, including status, session counts, registry identifiers, and verification summaries. Didit does not support filters or search on this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum businesses to return in this page, at least 1. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `DIDIT_LIST_USERS`

List user profiles aggregated from KYC sessions, including status, session counts, and feature summaries. Didit does not support filters on this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum users to return in this page, at least 1. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Verification Sessions

**Slug:** `DIDIT_LIST_VERIFICATION_SESSIONS`

List and filter KYC, KYB, or standalone verification sessions. Returns one bounded page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum verification sessions to return in this page, at least 1. |
| `search` | string | No | Smart search across session IDs, numbers, names, contact data, document data, and vendor_data. |
| `date_to` | string | No | Latest creation date in UTC, YYYY-MM-DD; KYB uses a midnight boundary. |
| `statuses` | array | No | Case-sensitive session statuses to include, such as Approved or In Review. |
| `date_from` | string | No | Earliest creation date in UTC, YYYY-MM-DD. |
| `api_service` | string ("ID_VERIFICATION" | "FACE_MATCH" | "AGE_ESTIMATION" | "FACE_SEARCH" | "POA" | "AML" | "KYB_REGISTRY" | "PASSIVE_LIVENESS" | "DATABASE_VALIDATION" | "PHONE_VERIFICATION" | "EMAIL_VERIFICATION") | No | Restrict standalone API sessions to one documented Didit service. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `vendor_data` | string | No | Exact match on your user or business identifier. |
| `session_kind` | string ("user" | "business") | No | List KYC users or KYB businesses. Call each kind separately when both are needed because Didit cannot paginate mixed results reliably. |
| `workflow_ids` | array | No | Restrict results to these workflow UUIDs. |
| `country_codes` | array | No | KYC document-issuing or KYB registry country codes. |
| `warning_codes` | array | No | Return sessions containing any of these Didit warning risk codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `DIDIT_LIST_WORKFLOWS`

List configured verification workflow versions, their publication status, feature summary, and expected per-run pricing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum workflow versions to return in this page, at least 1. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |