Idenfo API Integration Guide: Empowering Developers
Building Better with Simplified API Integration
Overview
Idenfo’s REST APIs help you embed digital onboarding, KYC, and AML verification into your product. Use authenticated endpoints to create individual or company profiles, trigger self‑service onboarding via deep links, and retrieve risk and screening outcomes once processing completes. The platform supports OCR extraction from identity documents and authenticity checks using PRADO‑backed document verification on the beta one‑call onboarding flow, with structured request/response examples and standard error codes to speed up integration. Metadata endpoints (work types, industries, products) help you drive form options. A typical flow is: obtain an access token, create a customer or company (or send a deep link), and then fetch the processed KYC + AML results or export a PDF for audit.
What’s inside this guide
- Authentication and headers: obtain an access token to call protected APIs → /endpoint/v1/login
- Create Customer: build an individual profile with rich KYC fields → /endpoint/v1/create-customer
- Create Company: register a business profile with directors/UBOs inputs → /endpoint/v1/create-company
- Deep Link onboarding: email a link so customers self‑register → /endpoint/v1/deepLink
- One‑call onboarding (beta): OCR + PRADO checks + KYC/AML in one request → /endpoint/v1/customers/onboard
- Fetch results: retrieve KYC summary, screening hits, and risk ratings → /endpoint/v1/fetch-customer
- Metadata for forms: get work types, industries, and products → /endpoint/v1/get-workTypes, /endpoint/v1/get-industries, /endpoint/v1/get-products
- Export: download a processed PDF for records → /endpoint/v1/download-pdf
- Mobile SDKs: Android, iOS, Flutter, React Native integration and init → Android, iOS, Flutter, React Native
- Web SDK: essentials to integrate in web apps → Web
- UAE PASS Guide: overview and step‑by‑step integration process → Overview, Process
Quick start
- Get an access token → /endpoint/v1/login
- Create a profile (individual or company) → /endpoint/v1/create-customer, /endpoint/v1/create-company
- Send a self‑service deep link to start onboarding → /endpoint/v1/deepLink
- Retrieve processed KYC + AML results → /endpoint/v1/fetch-customer
- Try the one‑call onboarding (beta) → /endpoint/v1/customers/onboard
- Integrate the Android or iOS SDK → Android, iOS
- Add SDK to Flutter or React Native → Flutter, React Native
- Set up UAE PASS authentication flow → UAE PASS Overview
API & SDK coverage
- REST v1: login, create customer/company, deep link, fetch results, metadata, download PDF → e.g. /endpoint/v1/login, /endpoint/v1/create-customer
- REST v2: updated endpoints for login, create customer/company, deep link, metadata, edits, downloads → e.g. /endpoint/v2/login, /endpoint/v2/create-customer, /endpoint/v2/deepLink
- SDKs: Android, iOS, Flutter, React Native, Web → e.g. Android, iOS
- Beta: one‑call onboarding combines OCR, PRADO authenticity, and compliance checks → /endpoint/v1/customers/onboard