API Reference

{
  "phone": "08031234567",
  "template": "Your {site} code is {code}. Expires in {minutes} minutes.", // optional
  "reference": "signup-8842"   // optional, your own id, echoed back
}

{
  "id": "phv_01hxyz...",
  "phone": "+2348031234567",
  "status": "pending",
  "expires_at": "2026-09-08T10:35:00Z",
  "reference": "signup-8842",
  "cost": 6.0,
  "is_test": false
}

{
  "id": "phv_01hxyz...",
  "code": "418209"
}

{
  "id": "phv_01hxyz...",
  "phone": "+2348031234567",
  "status": "verified",
  "verified": true,
  "reference": "signup-8842"
}

multipart/form-data
  file      = your logo or screenshot (PNG/JPG)
  kind      = icon | screenshot | splash
  platform  = play | ios | both

A zip file, with each asset named by the size
and folder the store expects.

{
  "bvn": "12345678901",
  "phone_number": "08012345678", // required on live keys
  "first_name": "Adaeze",        // optional, for cross-match
  "last_name": "Okafor",         // optional, for cross-match
  "date_of_birth": "1992-04-15"  // optional, for cross-match
}

{
  "id": "ver_01hxyz...",
  "type": "bvn",
  "status": "success",
  "match": true,
  "confidence_score": 98,
  "data": {
    "bvn": "12345678901",
    "date_of_birth": "1992-04-15",
    "phone_number": "+2348012345678",
    "gender": "female"
  }
}

{
  "nin": "12345678901",
  "first_name": "Adaeze", // optional, for cross-match
  "last_name": "Okafor"   // optional, for cross-match
}

{
  "id": "ver_01hxyz...",
  "type": "nin",
  "status": "success",
  "match": true,
  "data": {
    "nin": "12345678901",
    "first_name": "Adaeze",
    "last_name": "Okafor",
    "date_of_birth": "1992-04-15",
    "phone_number": "+2348012345678",
    "gender": "female"
  }
}

{
  "licence_number": "ABC12345DE67",
  "first_name": "Adaeze", // optional
  "last_name": "Okafor"   // optional
}

{
  "id": "ver_01hxyz...",
  "type": "frsc",
  "status": "success",
  "data": {
    "licence_status": "valid",
    "expiry_date": "2028-11-30",
    "licence_class": "B",
    "state_of_issue": "Lagos"
  }
}

{
  "account_number": "0123456789",
  "bank_code": "058"
}

{
  "id": "ver_01hxyz...",
  "type": "bank_account",
  "status": "success",
  "data": {
    "account_number": "0123456789",
    "account_name": "ADAEZE NGOZI OKAFOR",
    "bank_code": "058"
  }
}

{
  "account_number": "0123456789",
  "bank_code": "058",
  "bvn": "22212345678"
}

{
  "id": "ver_01hxyz...",
  "type": "bvn_account_match",
  "status": "success",
  "match": true,
  "confidence_score": 100,
  "data": {
    "account_number": "0123456789",
    "account_name": "ADAEZE NGOZI OKAFOR",
    "match_status": "FULL_MATCH",
    "match_percentage": 100
  }
}

{
  "address": "12 Adeola Odeku Street, Victoria Island, Lagos",
  "full_name": "Ada Obi",
  "country": "NG",
  "radius_m": 150,
  "reference": "loan-4821"
}

{
  "id": "ver_01hxyz...",
  "type": "address",
  "status": "pending",
  "match": false,
  "confidence_score": 40,
  "address": {
    "submitted": "12 Adeola Odeku Street, Victoria Island, Lagos",
    "formatted": "12 Adeola Odeku St, Victoria Island, Lagos, Nigeria",
    "latitude": 6.4281,
    "longitude": 3.4219,
    "precision": "ROOFTOP"
  },
  "checks": {
    "address_exists": { "status": "pass", "points": 40 },
    "location": { "status": "not_provided", "points": 0 },
    "document": { "status": "not_provided", "points": 0 }
  },
  "signals": [],
  "confirm_url": "https://identifyorg.com/verify-address/...",
  "expires_at": "2026-10-15T10:24:00Z",
  "cost": 150.0,
  "currency": "NGN",
  "is_test": false
}

{
  "latitude": 6.4283,
  "longitude": 3.4221,
  "accuracy_m": 12
}

{
  "id": "ver_01hxyz...",
  "type": "address",
  "status": "verified",
  "match": true,
  "confidence_score": 80,
  "checks": {
    "address_exists": { "status": "pass", "points": 40 },
    "location": { "status": "pass", "points": 40, "distance_m": 31, "accuracy_m": 12 },
    "document": { "status": "not_provided", "points": 0 }
  }
}

curl -X POST https://api.identifyorg.com/v1/verify/address/ver_01hxyz.../document \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@bill.jpg"

{
  "id": "ver_01hxyz...",
  "type": "address",
  "status": "verified",
  "confidence_score": 100,
  "checks": {
    "document": { "status": "pass", "points": 20, "address_match": 100, "name_match": true }
  }
}

curl -X POST https://api.identifyorg.com/v1/verify/document \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@passport.jpg"

{
  "id": "ver_01hxyz...",
  "type": "document",
  "status": "success",
  "match": null,
  "confidence_score": 91,
  "data": {
    "full_name": "OKAFOR ADAEZE N",
    "document_number": "A12345678",
    "expiry_date": "2030-05-01"
  },
  "cost": 30.0,
  "currency": "NGN",
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

curl -X POST https://api.identifyorg.com/v1/verify/liveness \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@selfie.jpg"

{
  "id": "ver_01hxyz...",
  "type": "liveness",
  "status": "success",
  "match": null,
  "confidence_score": 91,
  "data": null,
  "cost": 25.0,
  "currency": "NGN",
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

curl -X POST https://api.identifyorg.com/v1/verify/face-match \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "selfie=@selfie.jpg" \
  -F "id_photo=@id_card_photo.jpg"

{
  "id": "ver_01hxyz...",
  "type": "face_match",
  "status": "success",
  "match": true,
  "confidence_score": 94,
  "data": null,
  "cost": 35.0,
  "currency": "NGN",
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

{
  "room_name": "kyc-session-4821", // optional, omit to create a new room
  "identity": "user-8821",
  "display_name": "Adaeze Okafor", // optional
  "role": "publisher"              // publisher (send+receive) or viewer
}

{
  "session_id": "cs_01hxyz...",
  "room_name": "kyc-session-4821",
  "token": "eyJhbGciOi...",
  "url": "wss://livekit.identifyorg.com",
  "type": "video",
  "expires_in_minutes": 180,
  "price_per_minute": 2.5,
  "currency": "NGN",
  "is_test": false
}

[
  {
    "id": "cs_01hxyz...",
    "type": "video",
    "room_name": "kyc-session-4821",
    "status": "completed",
    "duration_seconds": 342,
    "cost": 14.25,
    "currency": "NGN",
    "created_at": "2026-07-02T10:24:00Z"
  }
]

{
  "balance": 48250.00,
  "currency": "NGN",
  "low_balance": false,
  "free_tier_remaining": 2
}

curl -X POST https://api.identifyorg.com/v1/tools/pdf-to-docx \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@document.pdf" \
  -o converted.docx

curl -X POST https://api.identifyorg.com/v1/tools/docx-to-pdf \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@document.docx" \
  -o converted.pdf

curl -X POST https://api.identifyorg.com/v1/tools/audio-convert \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@voice-note.wav" \
  -F "target_format=mp3" \
  -o converted.mp3

curl -X POST https://api.identifyorg.com/v1/tools/remove-background \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@photo.jpg" \
  -o no-background.png

{
  "url": "https://example.com"
}

{
  "id": "aud_01hxyz...",
  "url": "https://example.com/",
  "status": "ready",
  "score": 78,
  "grade": "C",
  "findings": [
    {
      "category": "headers",
      "severity": "warning",
      "title": "Content-Security-Policy header is missing",
      "detail": "",
      "fix": "Add a Content-Security-Policy response header to reduce this class of attack surface."
    }
  ],
  "lighthouse": {
    "performance": { "score": 92, "title": "Performance" },
    "accessibility": { "score": 96, "title": "Accessibility" },
    "best_practices": { "score": 96, "title": "Best Practices" },
    "seo": { "score": 100, "title": "SEO" }
  },
  "ai_signals": { "signals": [], "count": 0 },
  "cost": 300.0,
  "created_at": "2026-07-02T10:24:00Z"
}

[
  {
    "id": "aud_01hxyz...",
    "url": "https://example.com/",
    "status": "ready",
    "score": 78,
    "grade": "C",
    "cost": 300.0,
    "created_at": "2026-07-02T10:24:00Z"
  }
]

{
  "url": "https://example.com",
  "tier": "deep",
  "github_repo_url": "https://github.com/owner/repo"
}

{
  "id": "aud_01hxyz...",
  "url": "https://example.com/",
  "status": "pending",
  "score": null,
  "grade": null,
  "tier": "deep",
  "active_tests_run": false,
  "cost": 5000.0,
  "created_at": "2026-07-02T10:24:00Z"
}

{
  "domain": "example.com"
}

{
  "id": "dom_01hxyz...",
  "domain": "example.com",
  "token": "3a810d5fe095e8f16555177ab14b8c29",
  "dns_txt": {
    "record": "_identifyorg-verify.example.com",
    "type": "TXT",
    "value": "3a810d5fe095e8f16555177ab14b8c29"
  },
  "well_known_file": {
    "path": "/.well-known/identifyorg-verify.txt",
    "url": "https://example.com/.well-known/identifyorg-verify.txt",
    "content": "3a810d5fe095e8f16555177ab14b8c29"
  }
}

{
  "verified": true,
  "method": "dns_txt"
}

curl -X POST https://api.identifyorg.com/v1/media-scan/image \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@photo.jpg"

{
  "id": "scn_01hxyz...",
  "media_type": "image",
  "status": "ready",
  "verdict": "likely_authentic",
  "signals": [
    {
      "category": "provenance",
      "severity": "weak",
      "title": "No camera metadata present",
      "detail": "No Make/Model/DateTimeOriginal EXIF fields.",
      "measured": null
    }
  ],
  "signal_count": 1,
  "classifier_model": "ateeqq-ai-vs-human-siglip@1",
  "cost": 200.0,
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

{
  "text": "Paste at least 800 characters of text to check..."
}

{
  "id": "scn_01hxyz...",
  "media_type": "text",
  "status": "ready",
  "verdict": "likely_ai",
  "signals": [
    {
      "category": "language_model",
      "severity": "moderate",
      "title": "Text is unusually predictable to a language model",
      "detail": "Mean perplexity (20.2) is low.",
      "measured": { "mean_perplexity": 20.25 }
    }
  ],
  "signal_count": 1,
  "classifier_model": "gpt2-base@1",
  "text_char_count": 942,
  "cost": 150.0,
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

curl -X POST "https://api.identifyorg.com/v1/media-scan/video?frames=12" \
  -H "X-IdentifyOrg-Key: io_live_xxxx" \
  -F "file=@clip.mp4"

{
  "id": "scn_01hxyz...",
  "media_type": "video",
  "status": "ready",
  "verdict": "inconclusive",
  "signals": [
    {
      "category": "container",
      "severity": "weak",
      "title": "No audio stream present",
      "detail": "",
      "measured": null
    }
  ],
  "signal_count": 1,
  "duration_seconds": 8.4,
  "frames_sampled": 12,
  "cost": 800.0,
  "is_test": false,
  "created_at": "2026-07-02T10:24:00Z"
}

[
  {
    "id": "scn_01hxyz...",
    "media_type": "image",
    "status": "ready",
    "verdict": "likely_authentic",
    "signal_count": 1,
    "cost": 200.0,
    "created_at": "2026-07-02T10:24:00Z"
  }
]

{
  "company_name": "Acme Fintech",
  "style": "monogram",   // monogram | badge | abstract | wordmark
  "primary_color": "#10b981",
  "secondary_color": "#0a0f1a",
  "size": 256
}

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256">
  <rect width="256" height="256" rx="56" fill="#10b981" />
  <text ...>AF</text>
</svg>

[
  { "id": "8cabd11b-1293-432f-b429-9d222ce3e452", "label": "My shop", "phone": "2348012345678", "status": "connected" }
]

{
  "to": "2348012345678",
  "text": "Order #1042 is out for delivery."
}

{ "sent": 1, "session_active": false }

{
  "to": "2348012345678",
  "brand": "Acme Pay",      // optional, shown in the message
  "length": 6,              // optional, 4 to 8
  "ttl_minutes": 10,        // optional, 1 to 30
  "reference": "signin-8842" // optional, your own id
}

{
  "id": "5b0e...",
  "kind": "otp",
  "to": "2348012345678",
  "status": "pending",
  "expires_at": "2026-10-11T10:35:00Z"
}

{
  "to": "2348012345678",
  "code": "483920"
}

{ "valid": true, "reason": null, "reference": "signin-8842" }

{
  "to": "2348012345678",
  "question": "What is your date of birth? (DD/MM/YYYY)",
  "expected": "12/03/1990",
  "reference": "customer_8841",  // optional
  "ttl_minutes": 30,             // optional
  "max_attempts": 3              // optional, 1 to 5
}

{
  "id": "c41f...",
  "kind": "identity",
  "to": "2348012345678",
  "status": "pending",
  "attempts": 0,
  "expires_at": "2026-10-11T10:55:00Z"
}

{
  "id": "c41f...",
  "kind": "identity",
  "status": "verified",
  "attempts": 1,
  "resolved_at": "2026-10-11T10:41:12Z"
}

{
  "status": "active",
  "business_verified": false,
  "limit": 5000000.0,
  "received": 1250000.0,
  "remaining": 3750000.0,
  "balance": 1237500.0,
  "held": 0.0,
  "fees_charged": 12500.0,
  "fees": { "flat": 50.0, "percent_from": 5000.0, "percent": 1.0 },
  "live": true
}

{
  "customer_name": "Ada Obi",
  "customer_email": "ada@example.com",
  "reference": "cust-1042",   // optional
  "bvn": "22212345678"        // or "nin". Required on live accounts. Used once, never stored.
}

{
  "id": "5d1c...",
  "reference": "cust-1042",
  "account_number": "9950269842",
  "bank_name": "Wema Bank",
  "account_name": "Ada Obi",
  "customer_name": "Ada Obi",
  "customer_email": "ada@example.com",
  "test": false,
  "active": true,
  "created_at": "2026-10-12T09:00:00Z"
}

{
  "accounts": [
    { "id": "5d1c...", "reference": "cust-1042", "account_number": "9950269842", "bank_name": "Wema Bank",
      "customer_name": "Ada Obi", "payments": 3, "total_received": 45000.0, "test": false }
  ]
}

{
  "amount": 15000,
  "customer_name": "Ada Obi",
  "customer_email": "ada@example.com",
  "description": "Order 8842"
}

{
  "reference": "mp_3f9a...",
  "checkout_url": "https://checkout.example/pay/mp_3f9a...",
  "payment": { "status": "pending", "amount": 15000.0 }
}

{
  "payments": [
    { "id": "a7b2...", "method": "transfer", "status": "success", "amount": 15000.0, "fee": 150.0, "net": 14850.0,
      "payer_name": "Ada Obi", "virtual_account_id": "5d1c...", "test": false, "paid_at": "2026-10-12T09:30:00Z" }
  ]
}

{
  "virtual_account_id": "5d1c...",
  "amount": 20000
}

{ "status": "success", "payment_id": "a7b2..." }

{
  "business_name": "Ada Stores",
  "business_type": "individual",
  "contact_phone": "08030000000"
}

{ "business_name": "Ada Stores", "business_type": "individual", "contact_phone": "08030000000" }

{ "amount": 50000 }

{
  "id": "e3f1...",
  "reference": "po_8c1e...",
  "status": "requested",
  "amount": 50000.0,
  "fee": 0.0,
  "you_receive": 50000.0,
  "bank_name": "Guaranty Trust Bank",
  "account_number": "0123456789"
}

{
  "payment_id": "a7b2...",
  "amount": 5000,
  "reason": "Customer cancelled the order"
}

{ "id": "b91c...", "reference": "rf_41d0...", "status": "requested", "amount": 5000.0, "reason": "Customer cancelled the order" }

{
  "events": [
    { "kind": "refund.processed", "message": "₦5,000.00 refunded to Ada Obi", "created_at": "2026-10-12T11:00:00Z" }
  ]
}