> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# SDKs e Integrações: Web, Mobile e Zapier

> Integre a Didit KYC em apps web, mobile e backend: SDKs web e nativos, SDKs de servidor (Python, Node.js, Go, Java, PHP, Ruby, .NET) e plugins.

> [!NOTE]
>
> Para o início de sessão dos utilizadores finais, consulte [Autenticação](https://docs.didit.me/pt/authentication/overview.md). Para combinar verificação, monitorização e início de sessão, use o [prompt de integração partilhado](https://docs.didit.me/pt/integration/integration-prompt.md). A disponibilidade do SDK de autenticação é independente das versões do SDK de verificação indicadas abaixo.

AI Agent Integration Prompt
        Copiar o prompt para a área de transferência



      
      

\<pre>

\``I want to integrate Didit identity verification into my application. Analyze my project and recommend the best integration approach.

\## My Project Context
\[Describe your stack: framework, language, web vs mobile, etc.]

\## Two Integration Approaches

Didit offers two main integration approaches. Choose based on your use case:

\### Approach 1: SDK Integration via Sessions (RECOMMENDED)
Best for: User-facing verification flows (KYC onboarding, age verification, identity checks).
How it works: Your backend creates a session, your frontend presents a verification UI using an SDK, the user completes verification, and your backend receives results via webhook.
Why recommended: Didit-hosted verification flows are A/B tested and optimized for the highest completion rates, fastest speed, and best security. The SDKs handle camera permissions, NFC, liveness detection, document capture, and all edge cases out of the box.

\### Approach 2: Standalone API (Direct REST Calls)
Best for: Server-to-server operations, batch processing, custom verification pipelines, or when you want full control over the verification UI.
How it works: Your backend calls Didit APIs directly for individual checks (ID verification, AML screening, liveness, face matching, age estimation, phone/email verification, proof of address, etc.).
When to use: When you already have your own capture UI, when you're doing backend-only batch processing, or when you need to compose individual verification steps into a custom pipeline.
Docs: Each standalone API has its own documentation under [Standalone APIs](https://docs.didit.me/standalone-apis/id-verification.md).

\## SDK Availability — All SDKs Are Available

\### For Web Apps
1\. **JavaScript SDK** (@didit-protocol/sdk-web) — RECOMMENDED for web. Works with React, Vue, Angular, Next.js, Nuxt, Svelte, and vanilla JS. Modal and inline/embedded modes. Full TypeScript support. Install: npm install @didit-protocol/sdk-web
2\. InContext Iframe — Embed verification in your page with <iframe>. Simplest setup, no npm needed. Good for quick prototypes.
3\. Redirect — Redirect user to Didit-hosted page, they return via callback URL. Best for cross-device flows or when iframe camera access is problematic.
4\. WordPress/WooCommerce Plugin — For WordPress sites. No-code setup.
5\. Shopify Plugin — For Shopify stores. No-code setup.
6\. Salesforce — Salesforce-side integration. See /integration/web-sdks/salesforce.

\### For Mobile Apps (ALWAYS prefer native SDKs over WebView)
1\. **iOS Native SDK** — RECOMMENDED for iOS. Swift/SwiftUI/UIKit. iOS 13.0+ (NFC requires iOS 15.0+). Best UX, NFC passport/ID reading, optimized camera, 54 languages. SPM: https://github.com/didit-protocol/sdk-ios. CocoaPods: pod 'DiditSDK'
2\. **Android Native SDK** — RECOMMENDED for Android. Kotlin/Jetpack Compose. minSdk 23 (Android 6.0+); ML auto-detection on API 24+. Best UX, NFC, optimized camera, 54 languages. Maven: me.didit:didit-sdk (via https://raw.githubusercontent.com/didit-protocol/sdk-android/main/repository)
3\. **React Native SDK** — RECOMMENDED for React Native. RN 0.76+ (New Architecture), iOS 13.0+ / Android API 24+. Cross-platform TypeScript API wrapping native iOS and Android SDKs. NFC support, Expo config plugin (development build required). Install: npm install @didit-protocol/sdk-react-native
4\. **Flutter SDK** — RECOMMENDED for Flutter. Flutter 3.3+, Dart 3.11+, iOS 13.0+ / Android API 23+. Cross-platform Dart API wrapping native iOS and Android SDKs. NFC support. pub.dev: didit_sdk
5\. WebView (FALLBACK ONLY) — Only use if no native SDK is available for your platform. Loses NFC, camera optimization, and biometric integration.

\### For Backend/Server
1\. **Server SDKs** — RECOMMENDED for backend code. Official typed libraries for the Didit server APIs, with webhook signature verification built in. Python: pip install didit-sdk. Node.js/TypeScript: npm install @didit-protocol/sdk-node. Go: go get github.com/didit-protocol/sdk-go. Java/Kotlin: me.didit:didit-java. PHP: composer require didit-protocol/sdk-php guzzlehttp/guzzle. Ruby: gem install didit-sdk. .NET: dotnet add package Didit. Each reads DIDIT_API_KEY. Docs: https://docs.didit.me/integration/server-sdks/overview
2\. REST API — Server-to-server, for languages without a server SDK. Create sessions, retrieve results, manage users, call standalone APIs.
3\. Webhooks — Receive real-time verification results asynchronously.
4\. Zapier — No-code automation for verification workflows.

\## SDK Session Integration Architecture (Recommended Flow)

\### Step 1: Backend creates a session
With a server SDK: client.sessions.create(workflow_id=..., vendor_data=..., callback=...) (same method in every language, in its own case). The raw request:
POST https://verification.didit.me/v3/session/
Headers: { "x-api-key": DIDIT_API_KEY, "Content-Type": "application/json" }
Body: {
"workflow_id": DIDIT_WORKFLOW_ID,
"callback": "https://myapp.com/done",
"vendor_data": "internal-user-id"
}
Response: {
"session_id": "uuid",
"session_token": "jwt",
"verification_url": "https://verify.didit.me/...",
"status": "Not Started"
}

\### Step 2: Present verification to user (choose one)
\- Web JS SDK: DiditSdk.shared.startVerification({ url: verification_url })
\- Iframe: embed verification_url in <iframe>
\- Redirect: window.location.href = verification_url
\- iOS/Android/RN/Flutter native SDK: DiditSdk.startVerification(token: session_token)

\### Step 3: Receive results via webhook
Your backend receives POST with:
\{
"session_id": "uuid",
"status": "Approved" | "Declined" | "In Review" | "In Progress" | "Abandoned",
"vendor_data": "internal-user-id",
"decision": { ... }
}
With a server SDK, webhooks.verify(raw_body, headers, WEBHOOK_SECRET) does all of the checks below and returns a typed event. Without one, verify the webhook signature (HMAC-SHA256, lowercase hex). Pick one header:
\- X-Signature-V2 = HMAC(WEBHOOK_SECRET, canonical_json) — recommended; canonical_json is the body re-serialized with sorted keys, compact separators, and unescaped Unicode (survives middleware re-encoding).
\- X-Signature = HMAC(WEBHOOK_SECRET, raw_body) — simplest, but only if you read the exact raw bytes before any parser touches them.
Also reject if abs(now - X-Timestamp) > 300 and use a constant-time compare. Full scheme: /integration/webhooks

\### Step 4: Update your database
\- "Approved" → user.verified = true, store decision data
\- "Declined" → user.verification_status = "declined", log warnings
\- "In Review" → user.verification_status = "pending_review"
\- "Abandoned" → send reminder to user
\- "Expired" → create new session

\## Decision Data Model (from webhook or GET /v3/session/{id}/decision/)
Every per-feature result is a PLURAL ARRAY (one entry per workflow node). Never code against a singular key like `nfc` or `id_verification`.
\{
"session_id": "uuid",
"session_kind": "KYC",
"status": "Approved",
"id_verifications":    [{ "node_id": "feature_ocr", "status": "Approved", "first_name": "John", "last_name": "Doe", "document_type": "Passport" }],
"nfc_verifications":   [{ "node_id": "feature_nfc", "status": "Approved" }],
"liveness_checks":     [{ "node_id": "feature_liveness", "status": "Approved", "score": 0.99, "method": "passive" }],
"face_matches":        [{ "node_id": "feature_face_match", "status": "Approved", "score": 95 }],
"aml_screenings":      [{ "node_id": "feature_aml", "status": "Approved", "total_hits": 0, "hits": [] }],
"phone_verifications": [{ "node_id": "feature_phone", "status": "Approved", "full_number": "+14155552671", "is_disposable": false }],
"email_verifications": [{ "node_id": "feature_email", "status": "Approved", "email": "alex.sample@example.com", "is_breached": false }],
"ip_analyses":         [{ "node_id": "feature_ip",    "status": "Approved" }]
}

\## Choosing the Right Approach

\| Question | → Use SDK Sessions | → Use Standalone API |
\|----------|-------------------|---------------------|
\| User-facing verification? | ✅ Yes | For custom capture UI only |
\| Need highest completion rate? | ✅ Yes (A/B tested flows) | You manage UX yourself |
\| Need NFC passport reading? | ✅ Yes (native SDKs) | Not available |
\| Batch/backend processing? | Not ideal | ✅ Yes |
\| Custom verification pipeline? | Limited to workflows | ✅ Full flexibility |
\| Fastest integration? | ✅ Minutes with UniLink | Requires more setup |

\## Rate Limits
\- POST /v3/session/: 600 session creations per minute per application (scope: session-v2-create). Applies to every application — there is no separate free-tier limit on V3 today.
\- GET endpoints: 300 requests per minute per application (generic-get).
\- Write endpoints (POST/PATCH/DELETE): 300 per minute per application (generic-write).
\- Transaction creates and event ingestion (POST /v3/transactions/, POST /v3/events/, POST /v3/events/batch/): 600 per minute per application (ingest-write), instead of the generic write budget.
\- 429 responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (epoch seconds), and Retry-After. See /integration/rate-limiting.

\## Environment Variables Needed
\- DIDIT_API_KEY — from Didit Console > API & Webhooks
\- DIDIT_WEBHOOK_SECRET — from Didit Console > API & Webhooks
\- DIDIT_WORKFLOW_ID — from Didit Console > Workflows

\## AI Agent Skills (for Cursor, Claude Code, etc.)
Install pre-built skills: npx clawhub@latest install didit-sessions
GitHub: https://github.com/didit-protocol/skills

\## Docs
\- Quick Start: https://docs.didit.me/getting-started/quick-start
\- API Full Flow: https://docs.didit.me/integration/api-full-flow
\- Webhooks: https://docs.didit.me/integration/webhooks
\- Standalone APIs: https://docs.didit.me/standalone-apis/
\- API Reference: https://docs.didit.me/api-reference/overview

Based on my project, please:
1\. Recommend the best integration approach (SDK sessions vs standalone API) and the best method for my platform
2\. Create the backend endpoint to create sessions (or standalone API calls)
3\. Create the frontend component/view to present verification (if SDK approach)
4\. Create the webhook endpoint to receive results
5\. Add database schema updates to track verification status``

\</pre>



      
      

Colar em

Escolha como pretende integrar a Didit, de acordo com a sua plataforma e o seu caso de utilização.> [!NOTE]
>
> ### Recomendado: integração por SDK através de sessões
>
> Para a verificação voltada para o utilizador final (onboarding KYC, verificação de idade, verificações de identidade), recomendamos a **integração por SDK através de sessões alojadas**. Os fluxos de verificação são testados em A/B e otimizados para as taxas de conclusão mais elevadas, a maior rapidez e a melhor segurança. Todos os SDKs (web, iOS, Android, React Native e Flutter) estão **disponíveis agora**.
>
> A partir do seu backend, use um [SDK de servidor](https://docs.didit.me/pt/integration/server-sdks/overview.md) para Python, Node.js, Go, Java, PHP, Ruby ou .NET para criar essas sessões, ler decisões e verificar webhooks. Para operações servidor a servidor (processamento em lote, pipelines personalizados), chame as **APIs autónomas** através dos mesmos SDKs. Consulte a [documentação das APIs autónomas](https://docs.didit.me/pt/standalone-apis/id-verification.md) para os endpoints de verificação individuais.> [!WARNING]
>
> Se iniciar uma sessão Didit a partir do seu próprio produto, continua a ser responsável pela camada de informação e consentimento do lado do responsável pelo tratamento. Antes de o utilizador iniciar a verificação, informe que o fluxo é fornecido pela Didit, inclua uma ligação para o seu próprio aviso de privacidade e recolha consentimento explícito sempre que for exigido para a captura de documento, selfie, prova de vida ou biometria. Consulte [Segurança e conformidade](https://docs.didit.me/pt/getting-started/security-compliance.md), [Marca branca](https://docs.didit.me/pt/console/white-label.md) e [Criar sessão](https://docs.didit.me/pt/sessions-api/create-session.md).Esta lição da Didit Academy configura uma integração completa de uma só vez: o SDK, as chaves de API por ambiente, a chamada de criação de sessão e um processador de webhook que verifica o segredo de assinatura.[Guia completo de integração — Didit Academy](https://www.youtube.com/embed/fX03-WEu_EI?rel=0\&playsinline=1)***## WebIntegre a verificação na sua aplicação web com JavaScript, iframe ou redirecionamento.> [card] [SDKs Web](https://docs.didit.me/pt/integration/web-sdks/overview.md)
>
> SDK JavaScript, incorporação por iframe ou redirecionamento. React, Vue, Angular, JavaScript puro.> [card] [SDK JavaScript](https://docs.didit.me/pt/integration/web-sdks/javascript-sdk.md)
>
> Controlo programático completo com callbacks de eventos e TypeScript.> [card] [Iframe InContext](https://docs.didit.me/pt/integration/web-sdks/incontext-iframe.md)
>
> Incorpore a verificação na sua página. Não é necessário backend com UniLink.> [card] [Redirecionamento](https://docs.didit.me/pt/integration/web-sdks/web-redirect.md)
>
> Redirecione para o fluxo alojado pela Didit. Suporte entre dispositivos.***## MobileSDKs nativos para proporcionar a melhor experiência de utilização da câmara, do NFC e da prova de vida no dispositivo.> [card] [SDKs nativos](https://docs.didit.me/pt/integration/native-sdks/overview.md)
>
> iOS, Android, React Native, Flutter. Suporte completo a NFC e biometria.> [card] [SDK iOS](https://docs.didit.me/pt/integration/native-sdks/ios-sdk.md)
>
> SwiftUI e UIKit. Leitura de passaportes por NFC. Disponível agora.> [card] [SDK Android](https://docs.didit.me/pt/integration/native-sdks/android-sdk.md)
>
> Kotlin e Jetpack Compose. Suporte a NFC. Disponível agora.> [card] [React Native](https://docs.didit.me/pt/integration/native-sdks/react-native-sdk.md)
>
> API TypeScript multiplataforma que envolve os SDKs nativos de iOS e Android. Suporte a NFC. Disponível agora.> [card] [Flutter](https://docs.didit.me/pt/integration/native-sdks/flutter-sdk.md)
>
> API Dart multiplataforma que envolve os SDKs nativos de iOS e Android. Suporte a NFC. Disponível agora.> [card] [Alternativa WebView](https://docs.didit.me/pt/integration/web-sdks/webview-in-ios-android.md)
>
> Alternativa para plataformas sem SDK nativo. Prefira os SDK nativos quando estiverem disponíveis.***## ServidorBibliotecas oficiais para o seu backend: chamadas tipadas às APIs de servidor da Didit, verificação de webhooks e validação de tokens de autenticação.> [card] [SDKs de servidor](https://docs.didit.me/pt/integration/server-sdks/overview.md)
>
> Matriz de instalação, configuração, erros e controlo de versões.> [card] [Python](https://docs.didit.me/pt/integration/server-sdks/python.md)
>
> Clientes síncronos e assíncronos. Python 3.10+.> [card] [Node.js](https://docs.didit.me/pt/integration/server-sdks/node.md)
>
> Tipos TypeScript, ESM e CommonJS. Node.js 18+.> [card] [Go](https://docs.didit.me/pt/integration/server-sdks/go.md)
>
> Apenas biblioteca padrão. Go 1.22+.> [card] [Java](https://docs.didit.me/pt/integration/server-sdks/java.md)
>
> Java e Kotlin, síncronos e assíncronos. Java 11+.> [card] [PHP](https://docs.didit.me/pt/integration/server-sdks/php.md)
>
> Qualquer cliente HTTP PSR-18. PHP 8.1+.> [card] [Ruby](https://docs.didit.me/pt/integration/server-sdks/ruby.md)
>
> Compatível com Rails, construído sobre net/http. Ruby 3.1+.> [card] [.NET](https://docs.didit.me/pt/integration/server-sdks/dotnet.md)
>
> C#, assíncrono, injeção de dependências. .NET 8 e .NET Standard 2.0.***## IntegraçõesPlug-ins e ferramentas sem código para plataformas populares.> [card] [Zapier](https://docs.didit.me/pt/integration/engines/zapier.md)
>
> Automatize a verificação com acionadores e ações sem código.> [card] [WordPress & WooCommerce](https://docs.didit.me/pt/integration/web-sdks/wordpress-woocommerce.md)
>
> Plug-in para sites WordPress e WooCommerce.> [card] [Shopify](https://docs.didit.me/pt/integration/web-sdks/shopify.md)
>
> Verifique compradores e restrinja a venda de produtos com limite de idade na Shopify.> [card] [Salesforce](https://docs.didit.me/pt/integration/web-sdks/salesforce.md)
>
> Acione verificações da Didit a partir de fluxos e registos do Salesforce.***## Comparação rápida| Plataforma | Método | Estado | NFC | Câmara | Ideal para |
| - | - | - | :-: | - | - |
| Web | SDK JavaScript | ✅ Disponível | — | Navegador | Controlo total, React / Vue / Angular |
| Web | Iframe InContext | ✅ Disponível | — | Navegador | Integração rápida, sem necessidade de backend |
| Web | Redirecionamento | ✅ Disponível | — | Navegador | Multidispositivo, configuração simples |
| iOS | SDK nativo | ✅ Disponível | ✅ | Otimizada | Melhor UX, leitura do chip NFC |
| Android | SDK nativo | ✅ Disponível | ✅ | Otimizada | Melhor UX, leitura do chip NFC |
| React Native | SDK nativo | ✅ Disponível | ✅ | Otimizada | Melhor UX, leitura do chip NFC |
| Flutter | SDK nativo | ✅ Disponível | ✅ | Otimizada | Melhor UX, leitura do chip NFC |
| Backend | SDKs de servidor (Python, Node.js, Go, Java, PHP, Ruby, .NET) | ✅ Disponível | — | — | Sessões, decisões, APIs independentes, webhooks |
| Sem código | Zapier | ✅ Disponível | — | — | Fluxos automatizados |
| CMS | WordPress | ✅ Disponível | — | — | Sites WP / WooCommerce |
| Comércio | Shopify | ✅ Disponível | — | — | Lojas Shopify |
| CRM | Salesforce | ✅ Disponível | — | — | Fluxos e registos do Salesforce |## Próximos passos> [card] [API de fluxo completo](https://docs.didit.me/pt/integration/api-full-flow.md)
>
> Integração de sessões de ponta a ponta: criar sessões, webhooks e resultados.> [card] [Webhooks](https://docs.didit.me/pt/integration/webhooks.md)
>
> Receba atualizações em tempo real do estado da verificação.***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.