Onboarder

API Documentation

Verification Types

All verification types supported by Onboarder and how they work.

How Verification Works

When users sign in through OAuth, Onboarder automatically handles all verification based on your verification flow configuration. Users complete verifications in our hosted UI - you don't build any forms or verification screens.

Biometric Identity System

Face and voice enrollment, liveness detection, and document verification with unique identity IDs

OTP Verification

Email and phone verification via one-time passwords sent directly to users

Document Verification

Government-issued ID verification with automated data extraction and validation.

passport

Passport

International passport verification. Nigeria-focused coverage.

Extracted: Full name, DOB, passport number, nationality, expiry date

Checks: Document authenticity, expiry, photo match

Coverage: Nigeria

voters_card

Voter's Card

Nigerian Permanent Voter's Card (PVC) verification.

Extracted: Full name, VIN number, polling unit

Checks: Document authenticity, active voter status

Coverage: Nigeria

drivers_license

Driver's License

Nigerian driver's license verification with address validation.

Extracted: Full name, DOB, license number, address

Checks: Document authenticity, expiry

Coverage: Nigeria

Contact Verification

Verify email addresses and phone numbers via one-time passwords (OTP).

email_otp

Email Verification

Send OTP code to user's email address for verification.

Method: 6-digit OTP sent via email

Expiry: 10 minutes

Attempts: 3 resend attempts allowed

phone_otp

Phone Verification

Send OTP code to user's phone number via SMS.

Method: 6-digit OTP sent via SMS

Expiry: 10 minutes

Attempts: 3 resend attempts allowed

Biometric Identity Enrollment

Multi-modal biometric system using face and voice enrollment for secure identity verification and transaction authorization. Each user receives a unique biometric identity ID (format: OBD-XXXXXX).

face_enrollment

Face Enrollment

Capture and store facial biometric template with liveness detection.

Method: Multiple face captures with liveness detection

Checks: Live person, anti-spoofing, quality assessment

Storage: Encrypted biometric template (embeddings)

voice_enrollment

Voice Enrollment

Capture and store voice biometric template for multi-modal authentication.

Method: Voice sample recording and analysis

Use Case: Transaction authorization with face + voice

Storage: Encrypted voice embeddings

liveness

Liveness Detection

Verify that the person is physically present (not a photo or video).

Method: Real-time movement and texture analysis

Checks: Live person, anti-spoofing, single face

Integration: Part of face enrollment flow

document_match

Document Face Matching

Match enrolled face with photo on ID document.

Method: Biometric comparison of face vs document photo

Threshold: High confidence matching

Note: Requires both document upload and face enrollment

Verification Lifecycle

All verifications follow this lifecycle:

Pending

Not yet started

In Progress

User completing

Verified

Successfully verified

Possible Statuses

pending - Not started yet
in_progress - User is completing
verified - Successfully verified
failed - Verification failed
review - Manual review required
expired - Session expired