# Zyphe Developer Documentation > Technical documentation for integrating Zyphe APIs, SDKs, and webhooks. This file contains links to documentation sections following the llmstxt.org standard. ## Table of Contents - [Quickstart](https://docs.zyphe.com/docs/quickstart/quickstart.md): This is the shortest path from zero to a **reviewed verification result**. Follow the seven steps - [@zyphe-sdk/browser](https://docs.zyphe.com/docs/guides/sdk/browser.md): Install the package: - [Get Next Step](https://docs.zyphe.com/docs/guides/sdk/get-next-step.md): The Get Next Step endpoint allows integrators to programmatically determine the current progress of a verification flow and identify the next actio... - [SDK Integration](https://docs.zyphe.com/docs/guides/sdk/index.md): Zyphe exposes an HTTP **SDK API** under `https://api.zyphe.com/sdk/...`. You can call it with any HTTP client ([Backend API integration](/docs/guid... - [@zyphe-sdk/node](https://docs.zyphe.com/docs/guides/sdk/node.md): Install the package: - [React Native](https://docs.zyphe.com/docs/guides/sdk/react-native.md): This guide shows you how to integrate Zyphe verification into a React Native application using Expo or bare React Native. - [API Keys Management](https://docs.zyphe.com/guides/api-keys.md): API keys authenticate requests to the Zyphe **API** (`https://api.zyphe.com`). They are not used against the documentation site. See [Environment s... - [Backend API integration (without the npm SDK)](https://docs.zyphe.com/guides/backend-api-integration.md): This is the **end-to-end recipe** for integrating Zyphe from your backend using the HTTP **SDK API** (`https://api.zyphe.com/sdk/...`) directly—no ... - [Environment setup](https://docs.zyphe.com/guides/environment-setup.md): Use this page as the **single source of truth** for hosts, environment variables, and which URL does what. Most failed first integrations come from... - [Export API](https://docs.zyphe.com/guides/export-api.md): Use the Export API when your backend needs **full result details and media** after a verification completes. Webhooks carry statuses, scores, ident... - [Hosted UI vs direct API](https://docs.zyphe.com/guides/hosted-vs-direct-api.md): Zyphe supports two ways to collect document and biometric evidence: - [Integration](https://docs.zyphe.com/guides/integration.md): This section is the **operator path for connecting your product to Zyphe**: hosts, keys, sandbox, HTTP session creation, mobile WebView, and media ... - [Mobile integration](https://docs.zyphe.com/guides/mobile-integration.md): Integrate Zyphe on mobile by loading the hosted verification flow in a **WebView**: - [Sandbox and go-live](https://docs.zyphe.com/guides/sandbox-and-go-live.md): Use this checklist after you complete the [Quickstart](/docs/quickstart). Work entirely in **sandbox** until every item passes, then switch environ... - [Sandbox mode](https://docs.zyphe.com/guides/sandbox-mode.md): Sandbox lets you create flows, run verifications, and receive webhooks against **synthetic / non-production** data. Production uses the same API an... - [Backwards Compatibility](https://docs.zyphe.com/docs/guides/webhook/backwards-compatibility.md): Two independent things are called "legacy" around webhooks. Do not confuse them: - [Custom Fields](https://docs.zyphe.com/docs/guides/webhook/custom-fields.md): Custom fields let you correlate a Zyphe result with records in your system without encoding business context into the webhook URL itself. - [Webhook Endpoints](https://docs.zyphe.com/docs/guides/webhook/endpoints.md): Webhook destinations are configured **on the organization**, not on the flow. An organization owns a registry of endpoints; each endpoint has its o... - [Failure and Review Events](https://docs.zyphe.com/docs/guides/webhook/failure-payload.md): This page documents failure semantics. It intentionally shows only the fields relevant to handling failures; the complete field list for each resul... - [Webhook Integration](https://docs.zyphe.com/docs/guides/webhook/index.md): Webhooks notify your backend when verification results or lifecycle events change. Zyphe sends an HTTPS `POST` to each **webhook endpoint** your or... - [Payload Versions](https://docs.zyphe.com/docs/guides/webhook/payload-versions.md): Every endpoint declares which payload shape it receives. There are two, and they are stable contracts, not a rolling format: - [Session Webhooks](https://docs.zyphe.com/docs/guides/webhook/session-webhooks.md): When you create a verification request from your backend, you can attach a callback that belongs to **that verification run only**. It is delivered... - [Webhook Payload](https://docs.zyphe.com/docs/guides/webhook/webhook-payload.md): This page documents the objects carried by standard result webhooks and lifecycle notifications. The outer HTTP and envelope contract is defined on... - [Webhook Signature](https://docs.zyphe.com/docs/guides/webhook/webhook-signature.md): Zyphe signs webhook requests with HMAC-SHA256 when a signing secret is in force for the destination. Verify the signature before parsing or process... - [Receiving Webhooks](https://docs.zyphe.com/docs/guides/webhook/webhook-structure.md): This page defines the HTTP delivery contract and the payload shapes your handler will see. Where deliveries come from is covered in [Webhook Endpoi... - [Document Selection](https://docs.zyphe.com/docs/guides/create-a-flow/document-selection.md): The Document Selection step allows users to choose the specific type of identity document they wish to use for verification. This step acts as a ro... - [Document Verification](https://docs.zyphe.com/docs/guides/create-a-flow/document-verification.md): Short product explainer: [How document verification works](/docs/how-it-works/document-verification). - [Form](https://docs.zyphe.com/docs/guides/create-a-flow/form.md): In order to create a "Form" Flow Step, you first need to create a Form. - [Geolocation Verification](https://docs.zyphe.com/docs/guides/create-a-flow/geolocation.md): The Geolocation Verification step allows organizations to verify the physical location of a user during the verification flow. This process cross-r... - [KYC Overview](https://docs.zyphe.com/docs/guides/create-a-flow/index.md): KYC verifies the identity of an **individual**. A KYC flow can combine identity-document checks, liveness detection, proof of address, phone verifi... - [Liveness Verification](https://docs.zyphe.com/docs/guides/create-a-flow/liveness.md): The Liveness Verification step ensures that the person completing the verification is a real human and matches the portrait in their identity docum... - [Phone Verification](https://docs.zyphe.com/docs/guides/create-a-flow/phone-verification.md): The Phone Verification step allows you to verify users' phone numbers through an SMS-based OTP (One-Time Password) authentication flow. - [Proof of Address](https://docs.zyphe.com/docs/guides/create-a-flow/proof-of-address.md): Short product explainer: [How proof of address works](/docs/how-it-works/proof-of-address). - [Sharing](https://docs.zyphe.com/docs/guides/create-a-flow/sharing.md): The Sharing step enables the secure transfer of verified identity data between different organizations or flows. This feature supports the concept ... - [SPID / CIE](https://docs.zyphe.com/docs/guides/create-a-flow/spid-cie.md): The Zyphe platform supports the Italian Identity providers SPID and CIE (Electronic ID Card) as an identity verification method. - [Wallet Verification](https://docs.zyphe.com/docs/guides/create-a-flow/wallet.md): The Wallet Verification step allows users to prove ownership of their cryptocurrency wallet addresses by connecting their wallet and signing a cryp... - [Billing](https://docs.zyphe.com/guides/billing.md): Use the Billing page to activate a plan, buy credit top-ups, choose how the organization is funded, manage billing details, set trial reminders, an... - [Dashboard](https://docs.zyphe.com/docs/guides/dashboard/index.md): The Zyphe Dashboard is a business-to-business (B2B) plug-and-play solution that facilitates the verification of custom... - [Manage Users](https://docs.zyphe.com/guides/manage-users.md): Use the Users and Invites pages to add teammates to your organization, assign roles, and manage flow access for partner users. - [Passkey Authentication](https://docs.zyphe.com/guides/passkey-authentication.md): Zyphe provides full FIDO2/WebAuthn support for passwordless authentication, allowing users to register and authenticate using biometric sensors, se... - [Theming](https://docs.zyphe.com/guides/theming.md): You can match the verification flow to your brand. There are two layers, and they compose: - [KYB Agentic Review Engine](https://docs.zyphe.com/docs/guides/kyb/agentic-review-engine.md): The KYB agent that moderates business-information results runs on a **multi-role agentic review engine**. Rather than a single AI loop that both re... - [KYB Overview](https://docs.zyphe.com/docs/guides/kyb/index.md): KYB verifies **businesses**, where KYC verifies individuals. A KYB flow collects a company's business information and incorporation documents, capt... - [Ownership discovery](https://docs.zyphe.com/docs/guides/kyb/ownership-discovery.md): A KYB step can discover a company's beneficial owners **automatically**, instead of asking the - [KYB steps and configuration](https://docs.zyphe.com/docs/guides/kyb/steps-and-configuration.md): A KYB flow is no longer a single step. It is an **anchor** step that collects business - [Accepting Partner Invitations](https://docs.zyphe.com/docs/guides/kyc-passport/accepting-invitations.md): If your organization has been invited to access KYC verification results from a partner organization through KYC Passport, this guide will help you... - [Frequently Asked Questions](https://docs.zyphe.com/docs/guides/kyc-passport/faq.md): Common questions about KYC Passport, partner invitations, user consent, and data access. - [KYC Passport](https://docs.zyphe.com/docs/guides/kyc-passport/index.md): The KYC Passport feature enables you to share verified KYC data with partner organizations, creating a trusted ecosystem where users verify once an... - [Inviting Partner Organizations](https://docs.zyphe.com/docs/guides/kyc-passport/inviting-partners.md): This guide walks you through the process of inviting partner organizations to access KYC verification results from your flow. - [Managing Partner Invitations](https://docs.zyphe.com/docs/guides/kyc-passport/managing-invitations.md): After sending invitations to partner organizations, you can track their status, resend invitations, and revoke access when needed. - [User Consent and Privacy](https://docs.zyphe.com/docs/guides/kyc-passport/user-consent.md): User consent is central to the KYC Passport functionality. This guide explains how user consent works, what users see, and important compliance con... - [Manual Review](https://docs.zyphe.com/docs/guides/manual-review.md): Manual review lets authorized organization users resolve a document verification (DV) result that automated checks could not finalize. Keep the ver... - [Model Context Protocol (MCP)](https://docs.zyphe.com/docs/guides/model-context-protocol-mcp.md): Zyphe ships a built-in [Model Context Protocol](https://modelcontextprotocol.io) server that lets AI agents and MCP-compatible clients (Claude Desk... - [How Scores Are Computed](https://docs.zyphe.com/docs/guides/scoring/how-scores-are-computed.md): Every enabled score definition produces one outcome per flow result. The computation runs when the flow completes and again on every re‑evaluation,... - [Scoring](https://docs.zyphe.com/docs/guides/scoring/index.md): Zyphe includes a generalized scoring engine that turns the signals collected during a verification flow into one or more normalized **scores**. Eve... - [Reviewing Scores](https://docs.zyphe.com/docs/guides/scoring/reviewing-scores.md): Computed scores are surfaced on the flow result detail page in the Zyphe Dashboard, in a dedicated **Scores** tab th... - [Score Definitions](https://docs.zyphe.com/docs/guides/scoring/score-definitions.md): A **score definition** describes one score your organization computes for each flow result: its name, the strategy used to calculate it, and the se... - [Tags](https://docs.zyphe.com/docs/guides/scoring/tags.md): A **tag** is a weighted label. When it is present on a flow result, its weight pushes the score - [Condition fields](https://docs.zyphe.com/docs/guides/transaction-monitoring/condition-fields.md): Every Transaction Monitoring rule is a condition over a **namespaced field**. The builder - [Transaction Monitoring](https://docs.zyphe.com/docs/guides/transaction-monitoring/index.md): Zyphe's Transaction Monitoring watches payment activity in real time. Your integration reports each payment event (deposit, withdrawal, or transfer... - [Lists](https://docs.zyphe.com/docs/guides/transaction-monitoring/lists.md): **Transaction Monitoring → Lists** holds the managed lists your rules reference: country-risk sets, keyword packs, and counterparty block/allow lis... - [Rules and Templates](https://docs.zyphe.com/docs/guides/transaction-monitoring/rules-and-templates.md): **Transaction Monitoring → Rules** holds the rules evaluated on every ingested transaction. Each fired rule contributes a probability, and the nois... - [Settings and Alerts](https://docs.zyphe.com/docs/guides/transaction-monitoring/settings-and-alerts.md): **Transaction Monitoring → Settings** holds the organization-wide values every rule uses: how the combined `P(risk)` turns into a decision, which t... - [Transactions](https://docs.zyphe.com/docs/guides/transaction-monitoring/transactions.md): **Transaction Monitoring → Transactions** lists every payment event streamed by your integration, each with the synchronous Allow / Review / Block ... - [Antifraud controls](https://docs.zyphe.com/docs/how-it-works/antifraud-controls.md): Zyphe runs a set of complementary fraud and financial-crime checks across onboarding (KYC, KYB) - [Document verification](https://docs.zyphe.com/docs/how-it-works/document-verification.md): Document verification confirms that a government-issued identity document is authentic, readable, and acceptable for your flow, and extracts the fi... - [How it works](https://docs.zyphe.com/docs/how-it-works/index.md): Short product explainers: what each capability does, where it sits in a flow, and where to configure it. For architecture and data movement, use [V... - [Business verification (KYB)](https://docs.zyphe.com/docs/how-it-works/kyb.md): KYB verifies a **company** rather than an individual: registry data, ownership (UBOs), directors, documents, and screening, with an optional agenti... - [Liveness](https://docs.zyphe.com/docs/how-it-works/liveness.md): Liveness confirms that a **real person** is present and that their face matches the portrait from [document verification](/docs/how-it-works/docume... - [Proof of address](https://docs.zyphe.com/docs/how-it-works/proof-of-address.md): Proof of address (PoA) verifies that a user can present acceptable evidence of residency (utility bills, bank statements, and similar documents), w... - [Statuses and codes](https://docs.zyphe.com/docs/reference/statuses-and-codes.md): This page is the **authoritative vocabulary** for statuses, webhook events, and structured reasons you will see in the dashboard, webhooks, and API... - [Advanced topics](https://docs.zyphe.com/docs/advanced-topics/index.md): Advanced topics - [Proof of KYC](https://docs.zyphe.com/docs/advanced-topics/on-chain-verifiable-proof-of-kyc.md): This document is a technical guide for implementing **verifiable Proof of KYC** (Know Your Customer), usable both **on-chain** by smart contracts a... - [AML Agentic Review Engine](https://docs.zyphe.com/docs/aml/agentic-review-engine.md): The AML agent that moderates sanctions, PEP, and adverse-media screenings runs on a **multi-role agentic review engine**. Rather than a single AI l... - [Overview](https://docs.zyphe.com/docs/aml/index.md): Anti-Money Laundering (AML) screening verifies people and organizations against sanctions, PEP, watchlists, and adverse media to prevent the use of... - [When screening runs](https://docs.zyphe.com/docs/aml/monitoring.md): - Onboarding (KYC/KYB) - [Risk Scoring](https://docs.zyphe.com/docs/aml/risk-scoring.md): For each subject screened against sanctions, PEP, and adverse media lists, Zyphe consolidates the matched signals into a single, normalized **risk ... - [Choosing an integration method](https://docs.zyphe.com/docs/choosing-an-integration-method.md): Zyphe supports three main ways to put verification in front of a user. All of them share the same **flows**, **results**, and **webhooks**: you cho... - [Authority Check](https://docs.zyphe.com/docs/data-flows/authority-check.md): ```mermaid - [Creation of the User Vault](https://docs.zyphe.com/docs/data-flows/creation-of-the-user-vault.md): ```mermaid - [Data Deletion](https://docs.zyphe.com/docs/data-flows/data-deletion.md): ```mermaid - [Data Flows](https://docs.zyphe.com/docs/data-flows/index.md): This section explains how Zyphe creates, verifies, shares, accesses, and deletes identity data. Each page documents one flow, including the actors ... - [KYC Passport](https://docs.zyphe.com/docs/data-flows/kyc-passport.md): The KYC Passport lets an organization securely share verified KYC data with partner organizations, - [Organization Data Access Flow](https://docs.zyphe.com/docs/data-flows/organization-data-access.md): This is the architectural sequence by which an organization reads user data it has been granted - [User Verification Flow](https://docs.zyphe.com/docs/data-flows/user-verification-flow.md): ```mermaid - [Data Sharing and Encryption](https://docs.zyphe.com/docs/decentralized-identity/data-sharing-and-encryption.md): Zyphe shares data between users and organizations using **Proxy Re-Encryption (PRE)**. The user always encrypts data with their own key. When they ... - [Definitions](https://docs.zyphe.com/docs/decentralized-identity/definitions.md): A User Vault is where personal information is securely stored. It contains the user’s verified and encrypted data, such as documents collected duri... - [What is Decentralization for Zyphe](https://docs.zyphe.com/docs/decentralized-identity/how-we-are-decentralized.md): Zyphe applies decentralization as a core business principle, it’s not just a technical feature. By removing single points of failure and control, w... - [Decentralized Identity](https://docs.zyphe.com/docs/decentralized-identity/index.md): Zyphe's is dedicated to revolutionizing how personal identity is handled in the digital space, ensuring that control, privacy, and autonomy remain ... - [Types of Storages](https://docs.zyphe.com/docs/decentralized-identity/types-of-storages.md): - [Why Decentralized PII Storage](https://docs.zyphe.com/docs/decentralized-identity/why-decentralized-pii-storage.md): In handling sensitive personal identifiable information (PII), **decentralization** offers a fundamentally safer and more privacy-preserving approa... - [Frequently Asked Questions](https://docs.zyphe.com/docs/frequently-asked-questions/index.md): A **User Vault** is a secure, personal space for verified and encrypted information, such as identity documents and biometrics collected during ver... - [Introduction](https://docs.zyphe.com/docs/index.md): Zyphe is identity infrastructure built so organizations can **verify, reuse, and monitor** trust, without treating personal data as a free-for-all. - [Integrations](https://docs.zyphe.com/docs/integrations/index.md): This section covers third-party systems and protocols that Zyphe interoperates with. - [Italian Digital Identity Ecosystem: SPID and CIE](https://docs.zyphe.com/docs/integrations/italian-digital-identity-ecosystem-spid-and-cie.md): SPID (Sistema Pubblico di Identità Digitale) and CIE (Carta d'Identità Elettronica) are two key components of the Italian digital identity ecosyste... - [PII Access Control](https://docs.zyphe.com/docs/pii-access-control.md): Zyphe applies role-based access control (RBAC) to Personally Identifiable Information (PII) so that - [Reusable Credentials](https://docs.zyphe.com/docs/reusable-credentials-one-click-kyc/index.md): Zyphe's decentralized KYC (Know Your Customer) is an innovative approach to the traditional KYC process, which involves collecting and verifying cu... - [Africa](https://docs.zyphe.com/docs/supported-documents/africa.md): The following table lists supported identification documents for Africa, organized by country. - [Asia](https://docs.zyphe.com/docs/supported-documents/asia.md): The following tables list supported identification documents for Asia, organized by country. The tables for India and the Philippines are further d... - [Caribbean](https://docs.zyphe.com/docs/supported-documents/caribbean.md): The following tables list supported identification documents for the Caribbean, organized by country. - [Central America](https://docs.zyphe.com/docs/supported-documents/central-america.md): The following tables list supported identification documents for Central America, organized by country. - [Europe](https://docs.zyphe.com/docs/supported-documents/europe.md): The following tables list supported identification documents for Europe, organized by country. The table for the United Kingdom is further divided ... - [Supported KYC documents](https://docs.zyphe.com/docs/supported-documents/index.md): Supported documents are the identification documents that document verification can correctly classify and extract information from. This section l... - [North America](https://docs.zyphe.com/docs/supported-documents/north-america.md): The following tables list supported identification documents for North America, organized by country, then state. - [Oceania](https://docs.zyphe.com/docs/supported-documents/oceania.md): The following tables list supported identification documents for Oceania, organized by country. The table for Australia is further divided by state. - [South America](https://docs.zyphe.com/docs/supported-documents/south-america.md): The following tables list supported identification documents for South America, organized by country. The tables for Argentina, Brazil, and Peru ar... - [Transaction Monitoring](https://docs.zyphe.com/docs/transaction-monitoring/index.md): Transaction Monitoring is Zyphe's real-time payment-screening capability. Where KYC and KYB verify - [Verification Process](https://docs.zyphe.com/docs/verification-process/index.md): The onboarding flow can be composed by a single step or multiple steps. Any onboarding flow contains at least one **Identity Verification** step (*...