5-Minute API Integration Guide

Complete step-by-step tutorial for integrating South African ID verification into your application

5-minute setupBulk process 100+ IDs99.9% accuracyReal-time validation

The Manual Verification Problem

Manual Processing Issues

  • No bulk processing capability
  • Human error in checksum validation
  • 2+ hours daily verification time
  • Inconsistent date parsing

Check ID API Solution

  • 0.3 second API response time
  • 99.9% accuracy guaranteed
  • Bulk process 100 IDs at once
  • 5-minute integration setup

Quick Start Guide

1

Get Your API Key

Start with a free test API key for development. No credit card required.

Free test key available! Sign in to view your test API key, or create your own key from the API Keys dashboard.

Get API Key
2

Choose Your Endpoint

The Check ID API offers two validation endpoints to suit your needs:

Single ID Validation

Perfect for real-time form validation and individual verifications

GET /api/v1/validate/{idNumber}

Bulk ID Validation

Process up to 100 ID numbers simultaneously - ideal for CSV imports and batch processing

POST /api/v1/validate/bulk
3

Integrate with Your Code

Choose your programming language and copy the code examples below:

// Single ID Verification
const verifyID = async (idNumber) => {
  const response = await fetch(`https://api.checkid.co.za/api/v1/validate/${idNumber}`, {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  });
  return await response.json();
};

// Bulk ID Verification (up to 100 IDs)
const verifyBulkIDs = async (idNumbers) => {
  const response = await fetch('https://api.checkid.co.za/api/v1/validate/bulk', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ idNumbers })
  });
  return await response.json();
};

Pro Tip

Use bulk validation for CSV uploads or database imports - process up to 100 IDs in a single request for maximum efficiency.

4

Process the Response

Here's the exact response structure you'll receive for each ID verification:

{
  "idNumber": "8903075555088",
  "isValid": true,
  "dob": "1989-03-07T00:00:00",
  "age": 35,
  "gender": "M",
  "citizenship": "SA Citizen"
}
FieldDescriptionUse Case
isValidBoolean indicating if ID number is validInput validation, error handling
dobExtracted birth dateAge verification, demographics
genderM/F from ID structureUser personalization
citizenshipSA Citizen/Permanent ResidentCompliance, eligibility checks

Performance Benchmarks

0.3s
Response Time
Average API response
99.9%
Accuracy Rate
Checksum validation
100
Bulk Processing
IDs per request
99.9%
Uptime
Service availability

Real-World Applications

🏦

Financial Services

  • Account opening verification
  • Loan application processing
  • KYC compliance automation
🏢

HR & Recruitment

  • Employee background checks
  • Payroll system integration
  • Bulk staff verification
🏠

Property & Rentals

  • Tenant screening automation
  • Lease application processing
  • Identity verification
🛒

E-commerce

  • Age verification for restricted products
  • Fraud prevention
  • User registration validation

Ready to Get Started?

Join 1,000+ South African businesses automating their ID verification process. Get started with 10 free verifications - no credit card required.

Related Developer Resources