{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1603251f-1b01-47cf-b49a-58bc106addac","name":"Idyntic API","description":"Idyntic provides high-performance, developer-first identity verification infrastructure for Nigeria. Verify National Identity Numbers (NIN), Bank Verification Numbers (BVN), and inspect wallet balances with deterministic test sandbox fixtures, strict idempotency protection, and automated rate limiting.\n\n---\n\n## Quick Setup in Postman\n\n1. **Configure Environment Variables**:\n   - `base-url`: `https://idyntic.getapexly.com` (or `http://localhost:3000` for local dev)\n   - `api-key`: Set with your test key (`id_test_...`) or live key (`id_live_...`) generated from the Developer Dashboard.\n2. **Execute Requests**: Run any endpoint from this collection.\n\n---\n\n## Real Current Pricing Reference\n\n| Endpoint | Service | Live Success | Billable Not Found / Suspended | Sandbox Test |\n|---|---|---|---|---|\n| `POST /api/public/v1/verifications/nin` | **NIN by NIN** | ₦100.00 (10,000 kobo) | ₦100.00 (10,000 kobo) | Free (0 kobo) |\n| `POST /api/public/v1/verifications/nin/phone` | **NIN by Phone** | ₦120.00 (12,000 kobo) | ₦100.00 (10,000 kobo) | Free (0 kobo) |\n| `POST /api/public/v1/verifications/bvn` | **BVN by BVN** | ₦110.00 (11,000 kobo) | ₦100.00 (10,000 kobo) | Free (0 kobo) |\n| `POST /api/public/v1/verifications/bvn/slip/pdf` | **Download BVN Slip PDF** | ₦100.00 (10,000 kobo) | N/A | Free (0 kobo) |\n| `POST /api/public/v1/verifications/bvn/slip/preview` | **Preview BVN Slip** | Free (0 kobo) | N/A | Free (0 kobo) |\n| `GET /api/public/v1/balance` | **Get Wallet Balance** | Free (0 kobo) | N/A | Free (0 kobo) |\n\n*Note: Subsequent PDF slip re-downloads using the same verification reference are completely free (0 kobo).*\n\n---\n\n## Standard Response Envelopes\n\n### 1. NIN Verification (NIN) Success (₦100.00 / 10,000 kobo)\n```json\n{\n  \"success\": true,\n  \"message\": \"NIN Verification (NIN) Successful\",\n  \"data\": {\n    \"reference\": \"clw9x01230001...\",\n    \"status\": \"successful\",\n    \"type\": \"nin\",\n    \"environment\": \"live\",\n    \"result\": {\n      \"surname\": \"NWACHUKWU\",\n      \"firstName\": \"CHIDINMA\",\n      \"otherNames\": \"ADAEZE\",\n      \"gender\": \"female\",\n      \"dob\": \"1995-04-12\",\n      \"phone\": \"08012345678\",\n      \"nin\": \"12345678901\",\n      \"trackingId\": \"NIN-2026-948194\",\n      \"residence_address\": \"24 Specimen Avenue, Off Demo Road\",\n      \"residence_state\": \"Lagos\",\n      \"residence_town\": \"Ikeja\",\n      \"residence_lga\": \"Ikeja\",\n      \"photo\": \"data:image/jpeg;base64,...\"\n    }\n  },\n  \"billing\": {\n    \"amount\": 10000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": true,\n    \"note\": \"Wallet charged 100.00 NGN\"\n  }\n}\n```\n\n### 2. NIN Verification (Phone) Success (₦120.00 / 12,000 kobo)\n```json\n{\n  \"success\": true,\n  \"message\": \"NIN Verification (Phone) Successful\",\n  \"data\": {\n    \"reference\": \"clw9x01230007...\",\n    \"status\": \"successful\",\n    \"type\": \"nin_phone\",\n    \"environment\": \"live\",\n    \"result\": {\n      \"surname\": \"NWACHUKWU\",\n      \"firstName\": \"CHIDINMA\",\n      \"otherNames\": \"ADAEZE\",\n      \"gender\": \"female\",\n      \"dob\": \"1995-04-12\",\n      \"phone\": \"08012345678\",\n      \"nin\": \"12345678901\",\n      \"trackingId\": \"NIN-2026-948194\",\n      \"residence_address\": \"24 Specimen Avenue, Off Demo Road\",\n      \"residence_state\": \"Lagos\",\n      \"residence_town\": \"Ikeja\",\n      \"residence_lga\": \"Ikeja\",\n      \"photo\": \"data:image/jpeg;base64,...\"\n    }\n  },\n  \"billing\": {\n    \"amount\": 12000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": true,\n    \"note\": \"Wallet charged 120.00 NGN\"\n  }\n}\n```\n\n### 3. BVN Verification Success (₦110.00 / 11,000 kobo)\n```json\n{\n  \"success\": true,\n  \"message\": \"BVN Verification (BVN) Successful\",\n  \"data\": {\n    \"reference\": \"clw9x01230003...\",\n    \"status\": \"successful\",\n    \"type\": \"bvn\",\n    \"environment\": \"live\",\n    \"result\": {\n      \"surname\": \"NWACHUKWU\",\n      \"firstName\": \"CHIDINMA\",\n      \"otherNames\": \"ADAEZE\",\n      \"gender\": \"Female\",\n      \"dob\": \"05-Dec-1994\",\n      \"phone\": \"08012345678\",\n      \"phone2\": \"08087654321\",\n      \"email\": \"chidinma.nwachukwu@example.com\",\n      \"bvn\": \"22222222222\",\n      \"nin\": \"12345678901\",\n      \"stateOfOrigin\": \"Lagos State\",\n      \"lgaOfOrigin\": \"Ikeja\",\n      \"residentialAddress\": \"24 Specimen Avenue, Off Demo Road\",\n      \"photo\": \"data:image/jpeg;base64,...\"\n    },\n    \"slip\": {\n      \"status\": \"available\",\n      \"type\": \"bvn-slip\",\n      \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n      \"previewUrl\": \"/api/public/v1/verifications/bvn/slip/preview\",\n      \"downloadUrl\": \"/api/public/v1/verifications/bvn/slip/pdf\"\n    }\n  },\n  \"billing\": {\n    \"amount\": 11000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": true,\n    \"note\": \"Wallet charged 110.00 NGN\"\n  }\n}\n```\n\n### 4. BVN Slip PDF Download (₦100.00 / 10,000 kobo)\n```json\n{\n  \"success\": true,\n  \"message\": \"BVN Slip PDF generated successfully\",\n  \"data\": {\n    \"reference\": \"clw9x01230003...\",\n    \"filename\": \"bvn-slip-22222222222.pdf\",\n    \"mimeType\": \"application/pdf\",\n    \"pdfBase64\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoK...\"\n  },\n  \"billing\": {\n    \"amount\": 10000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": true,\n    \"note\": \"Wallet charged 100.00 NGN\"\n  }\n}\n```\n\n### 5. Record Not Found Response (₦100.00 / 10,000 kobo)\n```json\n{\n  \"success\": true,\n  \"message\": \"Record not found\",\n  \"data\": {\n    \"reference\": \"clw9x01230002...\",\n    \"status\": \"not_found\",\n    \"type\": \"nin\",\n    \"environment\": \"live\",\n    \"result\": null\n  },\n  \"billing\": {\n    \"amount\": 10000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": true,\n    \"note\": \"Wallet charged 100.00 NGN\"\n  }\n}\n```\n\n### 6. Insufficient Balance / Error (0 kobo charge)\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INSUFFICIENT_BALANCE\",\n    \"message\": \"Your wallet balance is insufficient for this verification.\",\n    \"requestId\": \"550e8400-e29b-41d4-a716-446655440001\"\n  },\n  \"billing\": {\n    \"amount\": 10000,\n    \"currency\": \"NGN\",\n    \"unit\": \"kobo\",\n    \"charged\": false,\n    \"note\": \"No charges\"\n  }\n}\n```\n\n---\n\n## Authentication & Scopes\n\nAll API requests require a Bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer {{api-key}}\n```\n\n### Permission Scopes\n\n- `NIN_VERIFY`: Required for `POST /api/public/v1/verifications/nin` and `POST /api/public/v1/verifications/nin/phone`\n- `BVN_VERIFY`: Required for `POST /api/public/v1/verifications/bvn`, `POST /api/public/v1/verifications/bvn/slip/pdf`, and `POST /api/public/v1/verifications/bvn/slip/preview`\n- `BALANCE_READ`: Required for `GET /api/public/v1/balance`\n\n---\n\n## Request Idempotency\n\nAll POST verification endpoints require an `Idempotency-Key` header (8 to 128 characters) to prevent duplicate debits during network retries:\n\n```http\nIdempotency-Key: {{$guid}}\n```\n\n- Replaying an identical request returns the cached response with `Idempotency-Replayed: true` and 0 additional charge.\n- Reusing a key with a modified request body returns `409 Conflict` (`IDEMPOTENCY_KEY_REUSED`).\n\n---\n\n## Sandbox Test Vectors\n\nWhen using a test credential (`id_test_...`), test the following deterministic scenarios without upstream provider calls or wallet charges:\n\n| Test Input | Simulated Result | HTTP Status |\n|---|---|---|\n| `12345678901` (NIN) / `08012345678` (Phone) / `22222222222` (BVN) | Deterministic verified identity record | `200 OK` |\n| `33333333333` (NIN / BVN) / `08033333333` (Phone) | Simulates identity restricted or suspended | `422 Unprocessable` |\n| `44444444444` (NIN / BVN) / `08044444444` (Phone) | Simulates merchant insufficient wallet balance | `402 Payment Required` |\n| `55555555555` (NIN / BVN) / `08055555555` (Phone) | Simulates upstream provider service outage | `503 Service Unavailable` |\n| *Any other 11 digits* | Simulates record not found (`result: null`) | `200 OK` |\n\n---\n\n## Developer Resources\n\n- Documentation: [https://idyntic.getapexly.com/developers/docs](https://idyntic.getapexly.com/developers/docs)\n- Dashboard: [https://idyntic.getapexly.com/dashboard/developers](https://idyntic.getapexly.com/dashboard/developers)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"47004344","team":9011196,"collectionId":"1603251f-1b01-47cf-b49a-58bc106addac","publishedId":"2sBYAvwWPA","public":true,"publicUrl":"https://documenter-api.postman.tech/view/47004344/2sBYAvwWPA","privateUrl":"https://go.postman.co/documentation/47004344-1603251f-1b01-47cf-b49a-58bc106addac","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Idyntic API lets developers integrate NIN and BVN verification, identity validation, and slip printing into their applications. Explore endpoints, authentication, and request examples for fast, reliable identity verification in Nigeria."},{"name":"title","value":"Idyntic API Documentation - NIN/BVN Verification & Slip Printing API"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.6","publishDate":"2026-09-05T15:43:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Idyntic API Documentation - NIN/BVN Verification & Slip Printing API","description":"Idyntic API lets developers integrate NIN and BVN verification, identity validation, and slip printing into their applications. Explore endpoints, authentication, and request examples for fast, reliable identity verification in Nigeria."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/13b4ff859bd770e7dc030ffc3dbd73c394c732a03e695e251799dab413507e9e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYAvwWPA"}