Certta DevHub

Home

• Caf Dev Hub: Bem vindo ao Caf Dev Hub. Explore nossos guias, documentações de API e SDK e comece.

Product guides

• Overview
• User Onboarding
• ID Document Verification
• Know Your Customer - KYC
• Know Your Business - KYB
• Account Takeover Prevention
• Trust Platform
• New Query
• Executions
• Company
• Onboarding List
• Onboarding Builder
• Query Templates
• Workflow Builder
• SSO Configuration: Configure Single Sign-On (SSO) for Trust users.
• Microsoft Entra ID (SAML): Configure SSO with Microsoft Entra ID (Azure AD) using the SAML protocol.
• Okta (SAML / OIDC): Configure SSO with Okta using SAML or OIDC protocols.
• Auth0 (SAML / OIDC): Configure SSO with Auth0 using SAML or OIDC protocols.
• Google Workspace (SAML): Configure SSO with Google Workspace using SAML protocol.
• Generic Provider (SAML / OIDC): Configure SSO with any SAML or OIDC compatible provider.
• Smart Auth (identity): On this page, you will find information about the Smart Auth SDK.
• Getting Started
• Access Token
• Checking the Response
• Rules Catalog
• Resolution 6: All.id is a distributed network built upon a peer-to-peer protocol using DLT concepts for storing and processing digital identity data.
• All.id components
• Peer components
• Facial biometrics
• Features
• Core procedure
• Profile insertion
• Biometric validation
• Onboarding Journey
• Company Search through API
• Onboarding links into WebView and iFrame
• WebView: This document provides guidelines for configuring WebView to ensure proper functionality of web Onboarding integrations.
• Android: This document provides instructions to create a WebView into an Android project.
• iOS: This document provides instructions to create a WebView into an iOS project.
• React Native: This document provides instructions to create a WebView using React Native.
• Flutter: This document provides instructions to create a WebView using Flutter.
• iFrame: This document provides instructions for integrating the Onboarding process into an iFrame.
• Events: This document explains how to handle events emitted by the onboarding process using window.postMessage().

APIs

• Overview: Welcome to the API documentation! On this page, you will find everything you need to know to improve the security and quality of your apps using our API.
• Getting Started
• Rate Limit
• Transactions
• Transaction linking
• Validation rules
• Manual reprovals
• Services
• Document OCR
• Documentscopy
• Face Liveness
• Facematch
• Facial Biometrics
• Private Faceset
• Shared Faceset
• Document Liveness
• Global Document Reader
• Global Document Verification
• Deepfake Detection
• Image Similarity Check
• Face Details
• Verif AI Smart OCR
• Background check
• Data structure
• KYC
• Driver
• Financial
• Labor
• Register data
• Relationships
• Risk
• Documents
• Adverse Media
• PEPs
• Warnings
• Sanctions
• Global identity verification
• Global identity double verification
• KYB
• Financial
• Labor
• Register data
• Risk
• Documents
• Credit Report
• Business Identity
• Vehicle
• Register data
• Authentication
• Applications
• Creating an Application
• Managing Applications
• Available Permissions
• Certificates
• Creating a Certificate
• Managing Certificates
• Using mTLS
• Authenticating
• Webhooks
• Creating Webhooks
• Managing Webhooks
• Events
• Request
• Signature
• Best Practices
• Available resources
• Transaction
• Onboarding
• Profile
• Face Authentication
• Synchronous services
• OCR Sync
• Doc Less Sync
• Company search
• Company record
• Cpf Sync (Individual)
• Basic Data Sync (Individual)
• Joint Resolution 6
• Suspected Fraud Creation
• Suspected Fraud Query
• Suspected Fraud Update
• Suspected Fraud Deletion
• Changelog
• Authentication
• Transaction linking
• Available resources
• Transaction
• Onboarding
• Profile
• Face Authentication
• Synchronous services
• OCR Sync
• Doc Less Sync
• Company search
• Company record
• Cpf Sync (Individual)
• Basic Data Sync (Individual)
• Transaction details
• Services
• Document OCR
• Documentscopy
• Face Liveness
• Facematch
• Facial Biometrics
• Private Faceset
• Shared Faceset
• Document Liveness
• Global Document Reader
• Deepfake Detection
• Image Similarity Check
• Face Details
• Verif AI Smart OCR
• Background check
• Data structure
• KYC
• Driver
• Financial
• Labor
• Register data
• Relationships
• Risk
• Documents
• Adverse Media
• PEPs
• Warnings
• Sanctions
• Global identity verification
• Global identity double verification
• KYB
• Financial
• Labor
• Register data
• Risk
• Documents
• Credit Report
• Business Identity
• Vehicle
• Register data
• Validation rules
• Manual reprovals
• Webhooks
• Transaction: Transaction webhooks are used to communicate transaction status updates to the client-server.
• Profile: Profile webhooks are used to communicate profile status updates to the client-server.
• Face authentication: Face authentication webhooks are used to communicate authentication to the client-server.
• Authentication (deprecated): Authenticate the Mobile API with your access key to use the available resources.
• Available resources (deprecated)
• Face liveness (deprecated)
• Face registration (deprecated)
• Face authentication (deprecated)
• Response signature (deprecated)
• Authentication
• Available resources
• Authentications
• Create identity
• Política de Depreciação de Recursos: 06 de junho, 2025
• Deprecation Policy for Resources: June 6, 2025
• All ID Documentation
• Technical Requirements
• Architecture Overview
• Production Guidance
• AWS ECS (CDK)
• AWS ECS (Terraform)
• Configuration
• Security Best Practices
• Facematch AI Documentation
• Available Resources
• Legacy Joint Resolution 6 Documentation
• Authentication
• Using mTLS
• Available resources
• Suspected fraud creation
• Suspected fraud query
• Suspected fraud update
• Suspected fraud deletion

SDKs

• Overview
• Authentication
• Installation Guide: Install and configure Certta for Android. Learn SDK requirements, permissions, repositories, dependencies, session setup, runtime token updates, and color theming.
• Face Liveness: Install and launch Face Liveness for Android. Learn prerequisites, LivenessConfiguration options, callback events, success and failure results, and error handling.
• Handling Failures: Reference for Android Face Liveness failure handling. Learn LivenessFailure types, cause values, provider-specific errors, and how to map failures to clear user guidance.
• Document Detector: Install and launch Document Detector for Android. Learn configuration options, UI setup, customization paths, callback events, and result handling.
• UI Customizations: Customize Document Detector for Android. Learn how to configure document selection, guidance screens, previews, uploads, retry states, and in-flow messages.
• Changelog: Android SDK release notes. Track versions, breaking changes, dependency updates, provider changes, fixes, and migration notes for Face Liveness and Document Detector.
• Legacy Getting Started with the SDK
• Standalone Modules
• Smart Auth: Enables you to integrate live facial verification and fingerprint authentication technology into your Android applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Current Version
• Requirements
• Gradle Dependencies
• Gradle Source Code
• Permissions
• SDK Lifecycle
• Building the SDK
• Start Smart Authentication
• Source Code
• References
• FAQ
• CafSDK
• Document Detector (DEPRECATED): Capture authentic, high-quality photos of user-submitted documents, allowing you to send them later for analysis in our API.
• Release Notes
• Current Version
• Requirements
• Gradle Dependencies
• Gradle Source Code
• Setting up the SDK
• Setting properties
• Capture Stages
• Messages Settings
• Customization: Learn how to customize our SDK and make it look like your app.
• Security Settings
• Detection Steps
• Upload Mode
• Advanced Settings: This page presents the default settings that can be made in all SDKs.
• Proxy configuration
• Preview configuration: This page explains the possible settings for displaying the capture preview screen.
• Start Document Detection
• Source Code
• Google security form
• Reduce SDKs size: This page presents some elements that will reduce the size of the SDKs.
• SDKs response
• References
• FAQ
• Face Liveness (DEPRECATED): Enables you to integrate live facial verification and fingerprint authentication technology into your Android applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Current Version
• Requirements
• Gradle Dependencies
• Gradle Source Code
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• References
• Advanced Features
• FAQ
• Face Authenticator (DEPRECATED): Enables you to integrate live facial authentication and fingerprint technology into your Android applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Face Liveness Lite: Lightweight face liveness verification SDK for Android. Provides a streamlined flow to verify that a captured face is live, with simple integration and minimal footprint.
• Release Notes
• Current Version
• Requirements
• Installation
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• References
• Result Reference
• FAQ
• Face Liveness (DEPRECATED): Enables you to integrate live facial verification and fingerprint authentication technology into your Android applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Deprecated SDKs
• DocumentDetector v7 or below (Deprecated)
• PassiveFaceLiveness (Deprecated): Smart camera that captures a reliable selfie of your user using artificial intelligence, capable of detecting and disapproving snapshots and recordings. Ideal for your onboarding.
• FaceAuthenticator (Deprecated): Facematch with proof of life from the user of your app, ideal for login flows or valuable financial transactions.
• Old Release Notes
• Começando com o SDK
• Começando com o SDK
• Installation Guide: Install and configure Certta for iOS. Learn SDK requirements, permissions, repositories, dependencies, session setup, runtime token updates, and color theming.
• Face Liveness: Install and configure Face Liveness for iOS with CafSDK's. Learn requirements, session setup, face liveness flow, UI configuration, delegates, theming, and support.
• Handling Failures: Reference for Certta Liveness delegate events, blocking errors, and failure mapping on iOS, including success handling, diagnostics, and UI guidance.
• Document Detector: Install and configure Document Detector for iOS with Certta and CafSDK. Learn requirements, session setup, document capture flow, UI configuration, delegates, theming, and support.
• Customizing Document Detector
• Smart Capture
• Changelog
• Legacy Getting Started with the SDK
• Standalone Modules
• Smart Auth
• Release Notes
• Installation
• Current Version
• Requirements
• SDK Lifecycle
• Building the SDK
• Start Smart Authentication
• Source Code
• References
• FAQ
• CafSDK
• Document Detector (DEPRECATED)
• Release Notes
• Current Version
• Requirements
• Installing the SDK
• Setting up the SDK
• Setting properties
• Messages Settings
• Customization
• Detection Steps
• Upload Mode
• Advanced Settings: This page presents the default settings that can be made in all SDKs.
• Proxy configuration
• Preview configuration: This page explains the possible settings for displaying the capture preview screen.
• Start Document Detection
• References
• FAQ
• Face Liveness (DEPRECATED): Enables you to integrate live facial verification and fingerprint authentication technology into your iOS applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Installation
• Current Version
• Requirements
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• References
• FAQ
• Face Authenticator (DEPRECATED)
• Release Notes
• Installation
• Current Version
• Requirements
• Building the SDK
• Start the SDK
• References
• FAQ
• Face Liveness Lite: Lightweight face liveness verification SDK for iOS. Provides a streamlined flow to verify that a captured face is live, with simple integration and minimal footprint.
• Building the SDK
• Start Liveness Verification
• Installation
• Current Version
• Requirements
• Source Code
• Result Reference
• Release Notes
• FAQ
• Face Liveness (DEPRECATED): FaceLiveness for iOS brings cutting-edge live facial verification and fingerprint authentication technology into your iOS applications. By leveraging the iProov Biometrics iOS SDK and FingerprintPro S
• Release Notes
• Deprecated SDKs
• DocumentDetector v7 or below (Deprecated)
• PassiveFaceLiveness (Deprecated): Smart camera that captures a reliable selfie of your user using artificial intelligence, capable of detecting and disapproving snapshots and recordings. Ideal for your onboarding.
• FaceAuthenticator (Deprecated): Facematch with proof of life from your app's user, ideal for login flows or valuable financial transactions.
• Old Release Notes
• Getting Started with the SDK
• Standalone Modules
• Document Detector: The Document Detector SDK allows seamless document capture and verification, enabling you to integrate advanced document detection capabilities into your applications.
• Release Notes
• Requirements
• Installating the SDK
• Android Configuration
• iOS Configuration
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• Face Liveness: Enables you to integrate live facial liveness detection technology into your Android and iOS applications, offering a seamless and secure way to verify users.
• Requirements
• Installating the SDK
• Android Configuration
• iOS Configuration
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• Face Authenticator: Enables you to integrate live facial authentication and fingerprint technology into your Android and iOS applications, offering a seamless and secure way to authenticate users.
• Requirements
• Installating the SDK
• Android Configuration
• iOS Configuration
• SDK Lifecycle
• Building the SDK
• Start Liveness Verification
• Source Code
• Deprecated SDKs: This page presents the first steps for using our Flutter SDKs.
• Release notes: Welcome to the release notes page for our Flutter products! This page serves as a comprehensive guide to the latest updates, features, enhancements, and bug fixes included in each version of our produ
• DocumentDetector
• FaceLiveness
• FaceAuth
• DocumentDetector: Capture authentic, high-quality photos of user-submitted documents, allowing you to send them later for analysis in our API.
• DocumentDetector v6.x and below
• DocumentDetector v7.x and above
• FaceLiveness: It brings cutting-edge live facial verification and fingerprint authentication technology into your Flutter applications, offering a seamless and secure way to authenticate users.
• FaceAuth: Incorporate facial authentication with proof of life verification and fingerprint authentication technology into your Flutter application. This integration is ideal for enhancing login flows and secur
• SDKs response: This page explains the reasons why an SDK is terminated. To do this, check the failure type of the object class present in the result object.
• Guia de Migração: CafSDK 2.1.0 → 3.0.0-rc.3
• Getting Started with the SDK
• Standalone Modules
• Document Detector (DEPRECATED)
• Release Notes
• Current Version
• Requirements
• Installation
• Hooks
• Start Document Verification
• Source Code
• TypeScript References
• Customizing Style
• FAQ
• Face Liveness (DEPRECATED): Enables you to integrate live facial verification and fingerprint authentication technology into your React Native applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Current Version
• Requirements
• Installation
• Hooks
• Start Liveness Verification
• Source Code
• TypeScript References
• FAQ
• Face Authenticator (DEPRECATED): Enables you to integrate live facial authentication and fingerprint technology into your Android applications, offering a seamless and secure way to authenticate users.
• Release Notes
• Current Version
• Requirements
• Installation
• Hooks
• Start Authentication Verification
• Source Code
• TypeScript References
• FAQ
• Smart Auth
• Getting started: This page presents the first steps to using the Identity SDK for React Native.
• Release notes
• Using Native Modules: Enables you to integrate live facial verification and fingerprint authentication technology into your Android applications, offering a seamless and secure way to authenticate users.
• Requirements
• Gradle Source Code
• Podfile Source Code
• Native Module Android
• Native Module iOS
• Import Native Modules
• Source Code
• TypeScript References
• FAQ
• Using Expo Modules: Enables you to integrate live facial verification and fingerprint authentication technology into your Android applications, offering a seamless and secure way to authenticate users.
• Requirements
• Create Local Expo Module
• Gradle Source Code
• Podspec Source Code
• Native Module Android
• Native Module iOS
• Import Expo Modules
• Source Code
• TypeScript References
• FAQ
• Standalone Modules: This page presents the first steps for using the latest versions of our JavaScript SDKs.
• Document Detector
• Getting started
• SDK builder options
• Analytics
• Appearance
• Messages
• SDK methods
• Event listeners
• Customization
• Release notes
• Face Liveness & Face Authenticator: Enables integration of facial verification into applications, providing a secure and seamless user authentication experience.
• Smart Auth
• SDK errors
• Customization
• Release notes
• DocumentDetector (Deprecated)
• Face Liveness (DEPRECATED)
• Customization
• Release notes
• Face Authenticator (DEPRECATED)
• Customization
• Release notes
• PassiveFaceLiveness (Deprecated)
• FaceAuthenticator (Deprecated)
• Security
• Release notes
• DocumentDetector (Deprecated)
• PassiveFaceLiveness (Deprecated)
• FaceAuthenticator (Deprecated)

---

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.caf.io/caf-dev-hub.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.