# Bynn Documentation Documentation > You've just stepped into the engine room of Bynn Intelligence—the AI-first identity verification and compliance platform that powers millions of KYC, KYB, AML, and fraud detection processes daily. If you're here, you're about to integrate the most advanced, AI-driven identity verification system into your application. Whether you're a fintech disruptor, a blockchain innovator, or an enterprise security architect, Bynn has the tools to help you verify smarter and trust faster. Append .md to any documentation page URL to get its markdown version. ## Guides - [Bynn Platform Overview](https://docs.bynn.com/docs/bynn-platform-overview.md): Welcome to Bynn, the comprehensive document forensics, identity verification and KYC/KYB platform designed for modern businesses. Our platform provides a complete suite of tools for verifying identities, detecting fraud, conducting background checks, and ensuring regulatory compliance across multiple industries. - [Bynn Onboarding Process (KYC)](https://docs.bynn.com/docs/bynn-onboarding-process.md): The Bynn onboarding process provides a comprehensive identity verification solution that combines advanced AI, document forensics, and real-time decision making to verify users quickly and securely. - [Document Fraud Detection](https://docs.bynn.com/docs/document-fraud-detection.md): Bynn's Document Fraud Detector employs advanced forensic analysis to identify fraudulent documents and sophisticated forgeries. This multi-layered detection system combines AI-powered analysis, metadata examination, and database verification to ensure document authenticity. - [Bynn Face Authentication](https://docs.bynn.com/docs/bynn-face-authentication.md): Bynn Face Authentication provides secure, frictionless user authentication using advanced facial biometric technology. This system enables users to access applications and authorize transactions using only their face, eliminating the need for passwords or additional authentication factors. - [Government Registry Verification (Goverlink™)](https://docs.bynn.com/docs/government-registry-verification.md): Goverlink™ represents Bynn's most advanced identity verification technology, providing direct validation against official government databases and registries. This system delivers the highest level of identity assurance by cross-referencing user data with authoritative sources maintained by national governments. - [United States](https://docs.bynn.com/docs/government-registry-verification-united-states.md): The United States offers comprehensive government verification through Bynn's Goverlink™ technology, with integration to multiple federal and state databases. This multi-layered approach provides real-time verification against official government records maintained by various authorities across the United States. As of 2024, Bynn's US integration covers verification against federal databases, state motor vehicle departments, and other government registries, serving over 330 million US residents and citizens. - [India](https://docs.bynn.com/docs/government-registry-verification-india.md): India is one of the most advanced countries for government verification through Bynn's Goverlink™ technology. With direct integration to the Unique Identification Authority of India (UIDAI), Bynn can verify identities against the Aadhaar database - the world's largest biometric identity system. - [Argentina](https://docs.bynn.com/docs/government-registry-verification-argentina.md): Argentina offers advanced government verification through Bynn's Goverlink™ technology, with direct integration to RENAPER (Registro Nacional de las Personas), the national civil registry authority. This integration provides real-time identity verification against Argentina's official identity database. - [Brazil](https://docs.bynn.com/docs/government-registry-verification-brazil.md): Brazil offers comprehensive government verification through Bynn's Goverlink™ technology, with direct integration to SERPRO (Serviço Federal de Processamento de Dados), Brazil's federal data processing service. This integration provides real-time identity verification against Brazil's official CPF database and federal registries. - [Chile](https://docs.bynn.com/docs/government-registry-verification-chile.md): Chile offers specialized identity verification through Bynn's Goverlink™ technology, with integration to Sinacofi (Sistema Nacional de Compensaciones), Chile's national financial compensation system. This integration provides real-time identity verification against Chile's comprehensive financial and credit databases. - [Colombia](https://docs.bynn.com/docs/government-registry-verification-colombia.md): Colombia offers comprehensive government verification through Bynn's Goverlink™ technology, with direct integration to the Registraduría Nacional del Estado Civil, Colombia's national civil registry authority. This integration provides real-time identity verification against Colombia's official civil registration database. - [Mexico](https://docs.bynn.com/docs/government-registry-verification-mexico.md): Mexico offers advanced government verification through Bynn's Goverlink™ technology, with direct integration to the Instituto Nacional Electoral (INE), Mexico's national electoral institute. This integration provides real-time identity verification against Mexico's official voter registration database and civil registry records. - [Peru](https://docs.bynn.com/docs/government-registry-verification-peru.md): Peru offers comprehensive government verification through Bynn's Goverlink™ technology, with direct integration to RENIEC (Registro Nacional de Identificación y Estado Civil), Peru's national registry of identification and civil status. This integration provides real-time identity verification against Peru's official civil registry and identification database. - [Australia](https://docs.bynn.com/docs/government-registry-verification-australia.md): Australia offers comprehensive government verification through Bynn's Goverlink™ technology, with integration to Australia's Document Verification Service (DVS) and state government databases. This integration provides real-time identity verification against official Australian government records and document databases. - [Sweden](https://docs.bynn.com/docs/government-registry-verification-sweden.md): Sweden offers advanced government verification through Bynn's Goverlink™ technology, with direct integration to SPAR (Statens Personadressregister) and the Swedish Police Authority's passport verification system. This integration provides real-time identity verification against Sweden's official population registry and passport databases. - [Spain](https://docs.bynn.com/docs/government-registry-verification-spain.md): Spain offers comprehensive government verification through Bynn's Goverlink™ technology, with integration to Spain's Ministry of Interior databases and civil registry systems. This integration provides real-time identity verification against Spain's official DNI (Documento Nacional de Identidad) and NIE (Número de Identidad de Extranjero) databases. - [Customer Consent for PII](https://docs.bynn.com/docs/customer-consent-for-personal-data-pii.md): Customer consent is a fundamental requirement for identity verification services. Bynn provides comprehensive tools to collect, manage, and track customer consent in compliance with global data protection regulations. - [Accessibility Manifest](https://docs.bynn.com/docs/accessibility-manifest.md): Bynn is committed to delivering identity verification products that provide equal access to all users, regardless of their abilities or the assistive technologies they use. Our accessibility commitment ensures that identity verification services remain inclusive and accessible to everyone. - [Supported ID Documents](https://docs.bynn.com/docs/supported-id-documents.md): Bynn maintains an extensive database of supported identity documents from countries and jurisdictions worldwide. Our document support includes passports, national identity cards, driver's licenses, and other government-issued identification documents that can be verified through our identity verification platform. - [Data Localization](https://docs.bynn.com/docs/data-localization-1.md): Bynn provides comprehensive data localization capabilities to ensure compliance with regional data protection regulations and sovereignty requirements. Organizations can specify where their data is stored and processed, enabling adherence to local laws while maintaining optimal performance and security standards. - [Bynn Intelligence Certificate Authority (Root CA)](https://docs.bynn.com/docs/bynn-intelligence-certificate-authority-root-ca.md) - [1. Get Started - Overview](https://docs.bynn.com/docs/getting-started.md) - [2. Verify your account](https://docs.bynn.com/docs/verify-your-account.md): To get started with Bynn, you’ll need to **verify your account** by linking your mobile phone. This ensures security and provides you with access to all features. - [Team & Roles](https://docs.bynn.com/docs/team.md) - [OpenID Single Sign-On (SSO)](https://docs.bynn.com/docs/single-sign-on-sso.md) - [Passkey & Two-factor authentication](https://docs.bynn.com/docs/passkey-two-factor-authentication.md): Passkeys represent the next generation of secure logins, building on open standards like **FIDO2** and **WebAuthn**. Instead of typing a password and then confirming your identity with an SMS code or a separate authenticator app, passkeys offer a seamless, phishing-resistant, and device-based method to prove who you are. By tying authentication to public-key cryptography, passkeys let you securely verify your identity with a private key stored on your device (for example, within a secure hardware chip). This private key never leaves your device, drastically reducing the risk of credential theft or interception. - [Branding](https://docs.bynn.com/docs/branding.md) - [Document Collection – Overview](https://docs.bynn.com/docs/document-collection-overview.md) - [Quickstart Guide](https://docs.bynn.com/docs/quickstart-guide.md): This guide shows the fastest way to create your first working document collection flow and review a submission result. - [Document Collections](https://docs.bynn.com/docs/document-collections.md) - [Create a collection](https://docs.bynn.com/docs/create-a-collection.md): Use the Collections section to create a new document request template that can later be used inside one or more workflows. - [Collection settings](https://docs.bynn.com/docs/collection-settings.md): The collection settings section contains the top-level fields for the collection itself. These settings define how the collection appears in the Collections list and how it is identified when selected in a workflow. Collection settings are separate from document-level settings. They describe the collection as a whole, while document settings apply to each individual document inside it. - [Configure documents](https://docs.bynn.com/docs/configure-documents.md): The document section is where the requested documents are added to the collection. Each document added here becomes an individual document request inside the collection. A collection can contain both required and optional documents, and there is no limit to how many documents can be added. - [Advanced document options and rules](https://docs.bynn.com/docs/advanced-document-options-and-rules.md): These settings control how the document can be submitted and what additional checks are applied after upload. Changes made here do not take effect until the collection is saved. - [Bynn AI Agent Validation](https://docs.bynn.com/docs/bynn-ai-agent-validation.md) - [Document Data Extraction](https://docs.bynn.com/docs/document-data-extraction.md) - [Workflows – Overview](https://docs.bynn.com/docs/workflows-overview.md) - [Workflow Builder](https://docs.bynn.com/docs/workflow-builder.md) - [Workflow Runtime and Launch](https://docs.bynn.com/docs/workflow-runtime-and-launch.md) - [Workflow End-User Experience](https://docs.bynn.com/docs/end-user-workflow-experience.md) - [Workflow Submissions](https://docs.bynn.com/docs/workflow-results-and-submissions.md) - [Workflow Nodes ](https://docs.bynn.com/docs/workflow-nodes-overview.md) - [Trigger Nodes](https://docs.bynn.com/docs/trigger-nodes.md) - [AI Set Variables](https://docs.bynn.com/docs/ai-set-variables.md) - [AI Decision](https://docs.bynn.com/docs/ai-decision.md) - [Identity Verification](https://docs.bynn.com/docs/identity-verification.md) - [Fraud Detection](https://docs.bynn.com/docs/fraud-detection.md) - [AML Check](https://docs.bynn.com/docs/aml-check.md) - [Document Collection](https://docs.bynn.com/docs/document-collection.md) - [Form Input](https://docs.bynn.com/docs/form-input.md) - [Consent Node](https://docs.bynn.com/docs/consent-node.md) - [Send Email](https://docs.bynn.com/docs/send-email.md) - [Send SMS](https://docs.bynn.com/docs/send-sms.md) - [Slack Webhook](https://docs.bynn.com/docs/slack-webhook.md) - [Display Screen](https://docs.bynn.com/docs/display-screen.md) - [Redirect](https://docs.bynn.com/docs/redirect.md) - [Map Selection](https://docs.bynn.com/docs/map-selection.md) - [HTTP Request](https://docs.bynn.com/docs/http-request.md) - [Decision Nodes](https://docs.bynn.com/docs/decision-nodes.md) - [Overview](https://docs.bynn.com/docs/overview.md) - [Quickstart Guide](https://docs.bynn.com/docs/quickstart-guide-1.md) - [How Agentic Fraud Reasoning works](https://docs.bynn.com/docs/how-agentic-fraud-reasoning-works.md) - [Orchestrator Agent](https://docs.bynn.com/docs/orchestrator-agent.md) - [Fraud Analysis Agents](https://docs.bynn.com/docs/fraud-analysis-agents.md) - [Running Agentic Fraud Reasoning](https://docs.bynn.com/docs/running-agentic-fraud-reasoning.md) - [Understanding Fraud Resoning Results](https://docs.bynn.com/docs/understanding-fraud-resoning-results.md) - [MANUAL (NO CODE)](https://docs.bynn.com/docs/no-code.md) - [VERIFICATION LINK (NO CODE)](https://docs.bynn.com/docs/verification-link.md) - [BYNN.JS (WEB SDK)](https://docs.bynn.com/docs/web-sdk-js.md) - [MOBILE SDK](https://docs.bynn.com/docs/mobile-sdk.md) - [iOS SDK (Swift)](https://docs.bynn.com/docs/ios-sdk-swift.md) - [Android SDK (Kotlin)](https://docs.bynn.com/docs/android-sdk-kotlin.md) - [Bynn CLI](https://docs.bynn.com/docs/bynn-cli.md): Command-line interface for the [BYNN Intelligence](https://bynn.com) API — identity verification, age verification, AutoDoc, document fraud analysis, NFC, content moderation, and face collections. - [Bynn MCP](https://docs.bynn.com/docs/bynn-mcp.md): Connect any MCP-compatible AI client to Bynn: identity verification (KYC), document fraud detection, age verification, content moderation, face search, AutoDoc workflows, fraud reasoning agents, and account management. 143 tools over the Bynn API, one connection. Works in Claude (claude.ai, Desktop, Claude Code), ChatGPT, Cursor, VS Code, Windsurf, and Zed. - [KYC Workflow](https://docs.bynn.com/docs/kyc-workflow.md): In Bynn’s system, you can configure KYC (Know Your Customer) levels to match your business needs. Choose from default presets or fine-tune settings with customizable parameters to balance security, compliance, and user experience. Adjust key factors such as FRR (False Rejection Rate) and FAR (False Acceptance Rate) to optimize throughput while minimizing fraud risk. Whether you prioritize maximum security or seamless onboarding, Bynn gives you full control to fine-tune identity verification based on your industry, region, and risk tolerance. - [Screening topics](https://docs.bynn.com/docs/screening-topics.md): In managing risk, people, companies, vessels, and securities are often associated with various forms of business risk. These entities could appear on sanctions lists, be linked to criminal activities, or warrant enhanced scrutiny due to holding public office. To assess the nature of risk associated with an entity, our system utilizes a variety of tags that detail the reasons for an entity’s inclusion in the database. This page explains how to interpret these tags, understand the associated risks, and locate the information you need. - [Address Validation](https://docs.bynn.com/docs/address-validation.md): Bynn's Address Validation service provides comprehensive address verification capabilities that enhance identity verification workflows by confirming the accuracy and deliverability of customer addresses across 37 global regions. This sophisticated validation system leverages enterprise-grade infrastructure to standardize address formats, validate postal deliverability, and ensure compliance with regional addressing standards while maintaining the speed and reliability that characterizes Bynn's identity verification platform. - [Bynn Webhooks](https://docs.bynn.com/docs/bynn-webhooks.md): Bynn's webhook system provides real-time notifications about verification events, enabling organizations to respond immediately to verification status changes and integrate seamlessly into their existing workflows. Webhooks eliminate the need for continuous polling and ensure that your systems receive instant updates when verification processes complete, encounter issues, or require additional attention through our enterprise-grade delivery infrastructure. - [Webhook Environments](https://docs.bynn.com/docs/webhook-environments.md) - [Webhook Security](https://docs.bynn.com/docs/webhook-security.md) - [Webhook Events Reference](https://docs.bynn.com/docs/webhook-events.md): Bynn provides a comprehensive set of webhook events that enable organizations to receive real-time notifications about every aspect of the identity verification process. This reference guide details all 43 subscribable webhook events available in the Bynn platform, organized by functional category to support efficient event selection and integration planning. - [Webhook Troubleshooting and Diagnostic Tools](https://docs.bynn.com/docs/webhook-diagnostics.md): Bynn provides extensive logging and monitoring capabilities that enable organizations to diagnose webhook delivery issues, optimize performance, and maintain reliable webhook processing infrastructure. The logging system captures detailed information about every webhook delivery attempt including request headers, payload data, response codes, timing information, and error details. - [Identity Verification (KYC)](https://docs.bynn.com/docs/identity-verification-kyc.md): Webhook Examples for Identity Verification (KYC) - [Document Fraud Detection](https://docs.bynn.com/docs/document-fraud-detection-1.md): Webhook Examples for Document Fraud Detection - [How do you allow our service to use your camera?](https://docs.bynn.com/docs/how-do-you-allow-our-service-to-use-your-camera.md): This quick guide shows visitors how to let kyc.bynn.com use their camera when visiting from iOS or Android devices. ## API Reference - [Getting Started](https://docs.bynn.com/reference/getting-started.md): Set up the welcome page for your API to help users make their first call. - [My Requests](https://docs.bynn.com/reference/my-requests.md): Set up the welcome page for your API to help users make their first call. - [Create a dossier](https://docs.bynn.com/reference/postdossiers.md): Creates a new KYC or KYB dossier (a verification case) under one of your verification levels, provisions the applicant and a hosted verification session, and returns the dossier token together with the verification URL (and, optionally, a QR code). Choose the product with the `type` parameter (`kyc` or `kyb`). The level you reference must belong to the same product family. ### Sending the invite Set `send_sms` and/or `send_email` (with a `phone_number` / `email_address`) to have Bynn deliver the verification link to the applicant for you. Otherwise the returned `verification_url` (and optional `qr_base64_png`) is yours to deliver. ### Retrieving results later After the applicant completes the session (see the `session.completed` webhook, which returns this `dossier_id`), call `GET /dossiers/:id` to fetch the full result including the liveness selfie and ID-document images. ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - `402 payment_required` — the request could not be completed for this account. - `404 validation_error` — no matching level for the requested `type`. - [List and search dossiers](https://docs.bynn.com/reference/getdossiers.md): Returns a paginated list of the organization's dossiers (KYC, KYB and doc), most recent first, with optional search and filtering. Each row is a lightweight summary — call `GET /dossiers/:id` for the full detail of a single dossier (media, applicants, identity documents, liveness images). ### Query parameters - `search` — optional, case-insensitive match on the dossier name, humanized token, or your customer reference (`customer_identification`). - `status` — optional business status filter (`open`, `approved`, `rejected`, …). - `type` — optional dossier type filter (`kyc`, `kyb`, `doc`). - `date_from` / `date_to` — optional ISO 8601 created-at range. - `page` — optional, 1-based page number (default 1, max 1000). - `per_page` — optional, items per page (default 50, max 100). ### Response ``` { "dossiers": [ { "id": "dossier_xxx", "token": "U45XZQE9N", "type": "kyc", "status": "approved", "name": "Jane Doe", "reference": "user-123", "risk_score": 4, "is_test": false, "download_status": "not_downloaded", "documents_count": 2, "created_at": "2025-01-20T10:30:00Z", "updated_at": "2025-01-20T10:35:00Z", "completed_at": "2025-01-20T10:34:00Z" } ], "page": 1, "per_page": 50, "total": 128, "total_pages": 3 } ``` ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - [Retrieve a dossier](https://docs.bynn.com/reference/getdossiersid.md): Retrieves a single dossier (a KYC/KYB case) with the full detail rendered in the Bynn dashboard: dossier fields, **all dossier media**, and every applicant (entity) with their personal information, identity documents, captured media and **all liveness selfie frames** — each media asset tagged with its type and a download URL. ### Getting the dossier id The `:id` accepts the prefixed dossier token (`dossier_xxx`) or the humanized token (e.g. `U45XZQE9N`). You receive `dossier_id` in the `session.completed`, `identity_document.*` and `decision.*` webhook events, and as `rel.url` on the dossier webhook payload. This endpoint is the supported way to fetch an applicant's liveness selfie and ID-document (front/back) images after a session completes. ### ⚠️ Media URLs are short-lived — download immediately Every `url` in the response (`media[].url`, `entities[].media[].url`, `entities[].identity_documents[].images[].url`, `entities[].liveness_images[].url`) is a **presigned, short-lived link** — it typically expires within **~5 minutes**. Download and persist the files on your side **immediately** upon receiving the response. Do **not** store or cache the URLs themselves; request a fresh dossier to mint new URLs when needed. ### Response See `DossierEntity`. Notable fields: - `id` — prefixed `dossier_` - `type` — `kyc`, `kyb`, `doc` - `status` — business status (`open`, `approved`, `rejected`, …) - `media[]` — every dossier-level asset (`{ type, name, page, url, created_at }`) - `entities[]` — applicants, each with `identity_documents[]`, `media[]` and `liveness_images[]` ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - `404 not_found` — no dossier with the given identifier exists in this organization. - [Retrieve an applicant (entity)](https://docs.bynn.com/reference/getdossiersentityid.md): Returns the applicant payload delivered by `entity.*` webhooks (personal info + address). - [Retrieve an identity document](https://docs.bynn.com/reference/getdossiersidentitydocumentid.md): Returns the identity-document payload delivered by `identity_document.*` webhooks (document fields, MRZ flags) for the `id_doc_xxx` id, plus an `images` array with the captured front/back (and cropped) images. The image `url`s are short-lived presigned links (~5 minutes) — download immediately, do not cache the URLs. - [Retrieve a decision](https://docs.bynn.com/reference/getdossiersdecisionid.md): Returns the decision payload delivered by `decision.*` webhooks (status, embedded dossier / entity / identity_document, risk tags). - [Retrieve a proof of address](https://docs.bynn.com/reference/getdossiersaddressproofid.md): Returns the address-proof payload delivered by `address_proof.*` webhooks. - [Retrieve a proof of funds](https://docs.bynn.com/reference/getdossiersfundsproofid.md): Returns the funds-proof payload delivered by `funds_proof.*` webhooks. - [Retrieve an AML activity / match](https://docs.bynn.com/reference/getamlactivityid.md): Returns the AML-activity payload delivered by `aml_activity.*` webhooks (the individual screening match). - [Retrieve an AML entity](https://docs.bynn.com/reference/getamlentityid.md): Returns the AML-entity payload delivered by `aml_entity.*` webhooks (screening status). - [Get the organization public API key](https://docs.bynn.com/reference/getapikeyspublic.md): Returns the PUBLIC API key for the organization identified by the PRIVATE API key used to authenticate this request. This lets a server-side integration that holds only the private key obtain the matching public key — which is required to create client-side verification sessions (e.g. `POST /v1/sessions`) — without logging in to the dashboard. The returned public key matches the mode (test vs live) of the private key used to authenticate: a test private key returns the test public key, a live private key returns the live public key. ### Response - `public_key` — the organization's public API key string (e.g. `public_...`) - `is_test` — whether this is a test-mode key ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - `404 not_found` — the organization has no public key of the matching mode. - [List supported invitation locales](https://docs.bynn.com/reference/getautodocinvitationslocales.md): Returns the list of IETF language tags supported as the `locale` parameter on POST /v1/autodoc/invitations. Each entry has a `code` (the value to send) and a `name` (a human-readable label rendered in the requesting user's locale where available, falling back to the uppercased code). - [List AutoDoc invitations](https://docs.bynn.com/reference/getautodocinvitations.md): Returns a paginated list of AutoDoc invitations belonging to the authenticated organization. Results are ordered by creation date, newest first. **Filtering.** All filter parameters are optional and combine with AND semantics. Use `reference` to look up invitations you previously created with a specific customer-defined identifier (e.g. your CRM customer ID). Use `search` for partial matches on the recipient email or phone (case-insensitive). Use `workflow_token`, `status`, or `channel` to narrow the result set. Use `date_from` / `date_to` to constrain creation time. **Pagination.** Default page size is 20, maximum 100. Use `page` (1-indexed) and `per_page` to navigate. Response includes a `pagination` object with `total`, `totalPages`, `page`, and `perPage`. - [Send an AutoDoc invitation](https://docs.bynn.com/reference/postautodocinvitations.md): Sends an invitation to a recipient (by email or SMS) to start a specific AutoDoc workflow. The recipient receives a link that opens the AutoDoc visitor app and begins the workflow with their identity already attached to the resulting dossier. **Lifecycle.** A new invitation is created with `status: pending`. A background delivery job is enqueued immediately; once the channel provider has accepted the message, status flips to `sent` and `sentAt` is populated. Subsequent provider-side events advance status through `delivered`, `opened`, and `started`. If delivery fails permanently the invitation is marked `failed` and `errorMessage` is populated. **Link expiration.** Invitation links are valid for 30 days from creation. After expiration the link returns an error to the recipient. There is no automatic resend — create a new invitation if needed. **Channel-specific behavior.** - `email`: a branded HTML email is sent to `recipient`. Use a valid email address. Emails are sent from `@auto-doc.ai` with your organization name as the display name (e.g. `Acme Corp `). - `sms`: a short message containing the start URL is sent to `recipient`. Use E.164 (`+15551234567`) or international format. Loose validation accepts most readable phone formats. **Idempotency.** This endpoint is **not** idempotent — repeated calls create new invitations. If you need de-duplication, send a unique `reference` and check `GET /v1/autodoc/invitations?reference=...` before retrying. **Recipient URL shape.** The link delivered to the recipient is: `https://start.auto-doc.ai/?invitation_token=` The invitation token in the query string lets the visitor app correlate the resulting dossier with this invitation. **Localization.** Set `locale` to one of the supported language codes to send the email or SMS in that language. Supported codes are returned by `GET /v1/autodoc/invitations/locales`. Defaults to the organization's default locale or English. - [Get an AutoDoc invitation](https://docs.bynn.com/reference/getautodocinvitationstoken.md): Returns a single invitation by its token. Use this endpoint to poll the lifecycle status of an invitation you previously created — `status` advances through `pending` → `sent` → `delivered` → `opened` → `started` as the recipient interacts with the link. **Lookup.** The `:token` segment accepts either the prefixed form (`adi_xxx`) or the raw token. The endpoint returns 404 if the invitation does not exist or belongs to a different organization (no existence leak across tenants). - [Resend an invitation](https://docs.bynn.com/reference/postautodocinvitationstokenresend.md): Re-dispatches the email or SMS for an invitation that was previously sent. Use this when the recipient never received the original (filtered, deleted, or wrong inbox) and asks for a copy. **What resend does.** Flips the invitation status from `sent` back to `pending`, clears `sentAt`, and enqueues a fresh delivery via the same job pipeline that handled the original send. Status will move `pending` → `sent` again as soon as the channel provider accepts the message. If the linked dossier already exists (recipient had partially started before), the link is preserved — only the delivery layer is re-fired. **Eligibility.** Only invitations in `sent` status can be resent. Other statuses are rejected: - `pending`: original delivery is still in flight; wait for it to settle. - `delivered`, `opened`, `started`, `completed`, `rejected`: the recipient has already engaged; resending would create confusion. - `failed`: handled by the delivery job's automatic retry — see invitation lifecycle. **Expiration.** Expired invitations cannot be resent. Create a new invitation instead. **Per-invitation limits.** - **Maximum 10 send attempts** per invitation (initial send + each successful resend). Once `deliveryAttempts` reaches 10, this endpoint returns 422 `max_attempts_reached`. Create a new invitation to continue contacting the recipient. - **3-minute cooldown** between sends. Resending within 3 minutes of `sentAt` returns 429 `cooldown_active` with a `remaining_seconds` hint in the error message. **Billing.** Resends are billed at the same rate as the original send (`send.email` for email, `send.sms` for SMS). Test private keys (the test counterpart of a live key) are not billed. **Authentication.** Both `JwtAuth` and `PrivateKey` are accepted. Per-IP throttle: 30 requests per minute. Per-organization throttle: 20 resends per minute (separate bucket from invitation creation). - [Sessions](https://docs.bynn.com/reference/sessions.md) - [Create a new identity verification session](https://docs.bynn.com/reference/post-sessions.md): Creates a new identity verification session using the provided applicant information. Returns the session token, URL, and optionally a QR code image as a base64 encoded PNG. - [Cancel / Abort a session](https://docs.bynn.com/reference/deletesessionssessionid.md): Cancels an active session identified by the session token. Returns a status message indicating if the cancellation was successful. Call this endpoint if applicant choose to abort or cancel the verification flow or if consent in rejected. - [Update an existing session](https://docs.bynn.com/reference/postsessionssessionid.md): Updates the session details using the provided parameters. Supports updating personal and contact information. Returns a status message if the update is successful. - [Show session information](https://docs.bynn.com/reference/getsessionssessionid.md): Shows session information. - [Send SMS (device switch)](https://docs.bynn.com/reference/postsessionssessionidsendsms.md): Sends an SMS to the specified phone number for the session identified by :session_id. The SMS includes a mobile code link so that the user can continue on their mobile phone. - [Get next verification step](https://docs.bynn.com/reference/getsessionssessionidpreflight.md): Checks next step for session in verification flow, this shall be polled after each completed action to check next step. - [Consent](https://docs.bynn.com/reference/patchsessionssessionidconsent.md) - [Start a liveness capture](https://docs.bynn.com/reference/postsessionssessionidlivenessstart.md): Start a liveness capture for the session identified by :session_id. Run this to get the credentials for the liveness capture SDK. - [Complete a liveness capture](https://docs.bynn.com/reference/postsessionssessionidlivenesscomplete.md): Complete a liveness capture for the session identified by :session_id. Run this after the liveness capture SDK is finnished to see if it was successful or need to be re-run. - [Upload media](https://docs.bynn.com/reference/postsessionssessionidmedia.md): Upload media (jpg, jpeg, png, mov, mp4, pdf, webm) (id document images, proof of address document, etc) to a current open session. - [Upload address verification](https://docs.bynn.com/reference/postsessionssessionidaddressverification.md): Upload an address verification document to an active session. This endpoint accepts images (jpg, jpeg, png) or PDF documents that serve as proof of address.The combination of document scanning, GPS location, and cellular network data provides a multi-layered approach to address verification, helping ensure the authenticity of the submitted location. - [Upload funds verification](https://docs.bynn.com/reference/postsessionssessionidfundsverification.md): Upload an funds verification document to an active session. This endpoint accepts images (jpg, jpeg, png) or PDF documents that serve as proof of funds. - [Phone verification (Initiate)](https://docs.bynn.com/reference/postsessionssessionidphoneverification.md): Start phone verification - [Phone verification (Complete)](https://docs.bynn.com/reference/patchsessionssessionidphoneverification.md): Complete phone verification - [Email verification (Initiate)](https://docs.bynn.com/reference/postsessionssessionidemailverification.md): Start email verification - [Email verification (Complete)](https://docs.bynn.com/reference/patchsessionssessionidemailverification.md): Complete email verification - [Create - Age Verification with Liveness](https://docs.bynn.com/reference/postageverificationliveness.md): Age Verification with Liveness ensures the user is physically present in front of the camera by requiring real-time facial movement detection. This method prevents spoofing, deepfakes, and injection attacks by verifying biometric liveness before estimating age. It provides a significantly higher level of security compared to static selfie-based verification, making it the preferred choice for fraud prevention and regulatory compliance. - [Finnish - Get Age Verification Liveness Result](https://docs.bynn.com/reference/getageverificationlivenessageverificationid.md): Get the result of an Age Verification Liveness session - [Start - Age Verification with Liveness](https://docs.bynn.com/reference/patchageverificationlivenesssessionid.md): Age Verification with Liveness ensures the user is physically present in front of the camera by requiring real-time facial movement detection. This method prevents spoofing, deepfakes, and injection attacks by verifying biometric liveness before estimating age. It provides a significantly higher level of security compared to static selfie-based verification, making it the preferred choice for fraud prevention and regulatory compliance. - [Complete - Age Verification Liveness Result](https://docs.bynn.com/reference/getageverificationlivenessageverificationidcomplete.md): Run this to complete liveness session - [No liveness - Age Verification with Selfie](https://docs.bynn.com/reference/postageverificationselfie.md): Age Verification with Selfie is a less secure method where you submit a user’s selfie to estimate their age. It does not ensure the user is physically present and does not detect deepfakes or injection attacks. This method is suitable for images where consent has been obtained but lacks liveness detection, making it vulnerable to spoofing. For higher security, we recommend using Age Verification with Liveness, which confirms real-time presence and enhances fraud prevention. - [Create a submission](https://docs.bynn.com/reference/postdocuments.md): Create a new submission for a document to be analyzed - [Delete a document submission](https://docs.bynn.com/reference/deletedocumentsid.md): Deletes a previously submitted document. The supplied identifier can be any of: - the humanized `document_id` returned on creation (e.g. `5PGACUU2E`), - the prefixed `submission_id` (`document_xxx`), - the raw token. This operation is idempotent — deleting an already-deleted document returns 200 with no error. - [Retrieve a document submission](https://docs.bynn.com/reference/getdocumentsid.md): Retrieves a previously submitted document together with the full forensic analysis result. ### Identifier formats The `:id` path parameter accepts any of the three identifiers Bynn returns when a document is submitted: | Format | Example | Source | | --- | --- | --- | | Humanized document ID | `5PGACUU2E` | `document_id` field of the create response | | Prefixed submission ID | `document_UBCG4aCU2dUMLGRPJU5PHyJL` | `submission_id` field of the create response | ### Polling / webhook for analysis completion Forensic analysis is asynchronous, we recommend using webhook and get the result from there. Immediately after creation `status` is `pending`; once analysis finishes it becomes `analyzed` (or `error` if it could not be processed). Poll this endpoint, or subscribe to the document webhook, to receive the final result. Recommended polling interval is 30 seconds. The endpoint is rate-limited to 500 requests per minute per organization. ### Response Returns the same payload that is delivered to the configured `document.analyzed` webhook. Notable fields include: - `submission_id` — prefixed `document_`, matches `submission_id` from the create response - `request_id` — humanized document ID (e.g. `5PGACUU2E`) - `status` — `pending`, `analyzed`, or `error` - `analysis_risk_status` — `pending`, `trusted`, `low`, `medium`, `high`, `fraud`, or `rejected` - `analysis_risk_score` — integer 0–100 - `document_content_type` — detected document type (e.g. `passport`, `bank_statements`, `invoice`) - `ai_generated_score`, `ai_deepfake_score`, `ai_generated_or_modified` — AI-generation signals - `ai_analysis`, `image_manipulation`, `tampering_results`, `address_validation`, `signature_details`, `barcode_details`, `qr_tax_system`, `goverlink`, `exif`, `xray` — detailed forensic findings - `risk_tags`, `risk_tags_detailed` — human-readable risk indicators - `original_file_url`, `media` — signed URLs to the uploaded file and rendered previews - `reference_id` — the customer-supplied `reference_id` from creation - `created_at`, `updated_at` — ISO 8601 timestamps ### Errors - `401 authentication_error` — no key, malformed key, or the key has been revoked. - `404 not_found` — no document with the given identifier exists in this organization. Deleted documents (see `DELETE /documents/:id`) also return `404`. - [List and search document submissions](https://docs.bynn.com/reference/getdocuments.md): Returns a paginated list of the organization's document submissions, most recent first, with optional free-text search. ### Query parameters - `search` — optional, case-insensitive match on the document name or the humanized document id (e.g. `5PGACUU2E`). - `page` — optional, 1-based page number (default 1). - `per_page` — optional, items per page (default 50, max 100). ### Response A lightweight summary per document (use `GET /documents/:id` for the full forensic analysis): ``` { "documents": [ { "submission_id": "document_UBCG4a...", "document_id": "5PGACUU2E", "name": "passport.jpg", "reference_id": "your-ref-123", "status": "analyzed", "analysis_risk_status": "trusted", "analysis_risk_score": 4, "document_content_type": "passport", "created_at": "2025-01-20T10:30:00Z" } ], "page": 1, "per_page": 50, "total": 128, "total_pages": 3 } ``` ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - [Search AML data (sanctions, PEP & watchlists)](https://docs.bynn.com/reference/postamlsearch.md): Screens a name against Bynn's AML data — global sanctions, PEP (politically exposed persons), and watchlists. Search for a **person** or an **entity** (company / organization) with the `type` parameter. Returns the ranked matches; use the returned `id` with the AML detail endpoints to pull a full profile. ### Response ``` { "query": "John Doe", "type": "person", "total": 2, "results": [ { "id": "NK-…", "name": "John Doe", "schema": "Person", "match": true, "score": 0.92, "topics": ["sanction"], "birth_date": ["1965-04-12"], "country": ["ru"] } ] } ``` ### Errors - `401 authentication_error` — missing, malformed, or revoked private key. - `402 payment_required` — the request could not be completed for this account. - `503 service_unavailable` — screening is temporarily unavailable; retry. - [NFC data submission](https://docs.bynn.com/reference/postnfc.md): Submit NFC-scanned identity document data from mobile device NFC reader to the session. - [List all public moderation models (no auth required)](https://docs.bynn.com/reference/getmoderationmodelsall.md): Get all available moderation models across all types (image, video, audio, text) with public pricing - [Get a single moderation model with full documentation](https://docs.bynn.com/reference/getmoderationmodelsapiname.md): Get detailed information about a specific moderation model including full documentation - [Create a moderation inference](https://docs.bynn.com/reference/postmoderationinfer.md): Submit content for moderation using the specified model - [Get inference result](https://docs.bynn.com/reference/getmoderationinferencetoken.md): Retrieve the result of a moderation inference by token - [Create a face collection](https://docs.bynn.com/reference/postfacecollections.md): Create a new face collection for your organization. Collections are used to group enrolled faces for search and identification. - [List face collections](https://docs.bynn.com/reference/getfacecollections.md): List all face collections belonging to your organization, ordered by most recently created. Each collection includes the number of enrolled faces. Supports pagination via page and per_page parameters. - [Delete a face collection](https://docs.bynn.com/reference/deletefacecollectionstoken.md): Delete a face collection and all its enrolled faces. This action is irreversible. - [Enroll a face into a collection](https://docs.bynn.com/reference/postfacecollectionstokenenroll.md): Enroll a single face into a collection by providing an image URL, base64-encoded image, or a file upload (multipart/form-data). The image must contain exactly one face. If no face or multiple faces are detected, an error is returned. You can optionally provide a name, external_id, and metadata for the enrolled face. - [Delete a face from a collection](https://docs.bynn.com/reference/deletefacecollectionscollectiontokenfacesfacetoken.md): Remove an enrolled face from a collection. This action is irreversible and the face embedding will be permanently deleted. - [Search for faces in a collection](https://docs.bynn.com/reference/postfacecollectionstokensearch.md): Search for similar faces in a collection by providing a probe image (URL, base64, or file upload). Returns matching faces ordered by similarity (lowest distance first). If the image contains multiple faces, the largest/first detected face is used for the search.