Build with CredFlare

Powerful APIs, comprehensive SDKs, and detailed documentation to integrate verification into your application. Go live in hours, not weeks.

RESTful API
Webhooks
Official SDKs
Quick Start Example Node.js
import { CredFlare } from '@credflare/sdk';

const credflare = new CredFlare({
  apiKey: process.env.CREDFLARE_API_KEY
});

// Create a verification request
const verification = await credflare.verifications.create({
  type: 'kyc',
  email: '[email protected]',
  documents: ['passport', 'bank_statement'],
  biometric: true
});

console.log(verification.id);
// => "ver_8847KJ92XM"

Official SDKs & Libraries

Production-ready SDKs with full TypeScript support and comprehensive examples.

JavaScript/Node.js

npm install @credflare/sdk

Full TypeScript support with auto-completion and type safety.

View Docs →

Python

pip install credflare

Async/await support with Python 3.8+ compatibility.

View Docs →

Go

go get credflare/sdk

Idiomatic Go with context support and error handling.

View Docs →

Ruby

gem install credflare

Ruby on Rails integration with ActiveRecord support.

View Docs →

API Reference

RESTful API with JSON request/response format. Base URL: https://api.credflare.net/v1

Create Verification Request

Create a new verification request for a user. Returns a verification ID and submission URL.

POST /verifications

Request Body:

{
  "type": "kyc",
  "email": "[email protected]",
  "documents": ["passport", "bank_statement"],
  "biometric": true,
  "callback_url": "https://yourapp.com/webhook"
}

Response:

{
  "id": "ver_8847KJ92XM",
  "status": "pending",
  "submission_url": "https://verify.credflare.net/ver_8847KJ92XM",
  "expires_at": "2025-02-01T00:00:00Z"
}

Retrieve Verification

Get the current status and results of a verification request.

GET /verifications/:id

Response:

{
  "id": "ver_8847KJ92XM",
  "status": "completed",
  "result": "approved",
  "documents": [
    {
      "type": "passport",
      "uvn": "CF-ID-2025-8847-XJ92",
      "status": "verified",
      "data": {
        "name": "John Doe",
        "dob": "1990-01-01",
        "country": "US"
      }
    }
  ],
  "biometric": {
    "status": "matched",
    "confidence": 98.5
  },
  "completed_at": "2025-01-15T10:30:00Z"
}

Webhooks

Receive real-time notifications when verification status changes.

Webhook Events

verification.created

A new verification request was created

verification.completed

User has submitted all required documents

verification.approved

Verification was approved (auto or manual)

verification.rejected

Verification was rejected

Webhook Payload Example:

{
  "event": "verification.completed",
  "data": {
    "id": "ver_8847KJ92XM",
    "status": "completed",
    "result": "approved",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Integration Guides

Step-by-step tutorials for popular frameworks and platforms.

Next.js Integration

Add KYC verification to your Next.js app with React hooks and server-side rendering support.

Read Guide →

Django Integration

Integrate CredFlare verification into your Django application with middleware and views.

Read Guide →

WordPress Plugin

Official WordPress plugin for member verification and gated content access.

Download Plugin →

Start Building Today

Get your API keys and start integrating CredFlare in minutes. Free sandbox environment included.