{"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

Quick Setup in Postman

\n
    \n
  1. Configure Environment Variables:\n
    2. \n
  2. Execute Requests: Run any endpoint from this collection.
    3. \n
\n
\n

Real Current Pricing Reference

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EndpointServiceLive SuccessBillable Not Found / SuspendedSandbox Test
POST /api/public/v1/verifications/ninNIN by NIN₦100.00 (10,000 kobo)₦100.00 (10,000 kobo)Free (0 kobo)
POST /api/public/v1/verifications/nin/phoneNIN by Phone₦120.00 (12,000 kobo)₦100.00 (10,000 kobo)Free (0 kobo)
POST /api/public/v1/verifications/bvnBVN by BVN₦110.00 (11,000 kobo)₦100.00 (10,000 kobo)Free (0 kobo)
POST /api/public/v1/verifications/bvn/slip/pdfDownload BVN Slip PDF₦100.00 (10,000 kobo)N/AFree (0 kobo)
POST /api/public/v1/verifications/bvn/slip/previewPreview BVN SlipFree (0 kobo)N/AFree (0 kobo)
GET /api/public/v1/balanceGet Wallet BalanceFree (0 kobo)N/AFree (0 kobo)
\n

Note: Subsequent PDF slip re-downloads using the same verification reference are completely free (0 kobo).

\n
\n

Standard Response Envelopes

\n

1. NIN Verification (NIN) Success (₦100.00 / 10,000 kobo)

\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

2. NIN Verification (Phone) Success (₦120.00 / 12,000 kobo)

\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

3. BVN Verification Success (₦110.00 / 11,000 kobo)

\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

4. BVN Slip PDF Download (₦100.00 / 10,000 kobo)

\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

5. Record Not Found Response (₦100.00 / 10,000 kobo)

\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

6. Insufficient Balance / Error (0 kobo charge)

\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

Authentication & Scopes

\n

All API requests require a Bearer token in the Authorization header:

\n
Authorization: Bearer \n
\n

Permission Scopes

\n\n
\n

Request Idempotency

\n

All POST verification endpoints require an Idempotency-Key header (8 to 128 characters) to prevent duplicate debits during network retries:

\n
Idempotency-Key: 8ac77d5b-0eec-491e-bd34-9fd5fc6dc228\n
\n\n
\n

Sandbox Test Vectors

\n

When using a test credential (id_test_...), test the following deterministic scenarios without upstream provider calls or wallet charges:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Test InputSimulated ResultHTTP Status
12345678901 (NIN) / 08012345678 (Phone) / 22222222222 (BVN)Deterministic verified identity record200 OK
33333333333 (NIN / BVN) / 08033333333 (Phone)Simulates identity restricted or suspended422 Unprocessable
44444444444 (NIN / BVN) / 08044444444 (Phone)Simulates merchant insufficient wallet balance402 Payment Required
55555555555 (NIN / BVN) / 08055555555 (Phone)Simulates upstream provider service outage503 Service Unavailable
Any other 11 digitsSimulates record not found (result: null)200 OK
\n
\n

Developer Resources

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"47004344","collectionId":"1603251f-1b01-47cf-b49a-58bc106addac","publishedId":"2sBYAvwWPA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-05T15:43:37.000Z"},"item":[{"name":"Get Wallet Balance","item":[{"name":"Get wallet balance","id":"db3b1413-208a-4531-a864-fc311d2e211c","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with BALANCE_READ scope

\n"}],"url":"https://idyntic.getapexly.com/api/public/v1/balance","urlObject":{"path":["api","public","v1","balance"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db3b1413-208a-4531-a864-fc311d2e211c"}],"id":"60308b73-2a58-4959-85bb-681b629126b3","description":"

Wallet balance endpoints

\n","_postman_id":"60308b73-2a58-4959-85bb-681b629126b3"},{"name":"NIN Verification","item":[{"name":"NIN By NIN","id":"3ec43b8b-7355-429d-ad57-f1d3e41c1864","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with NIN_VERIFY scope

\n"},{"key":"Idempotency-Key","value":"eb311355-94fd-4c7e-b3d3-660291c0215d","description":"

Unique UUID to prevent duplicate billing

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"nin\": \"12345678901\"\n}","options":{"raw":{"language":"json"}}},"url":"https://idyntic.getapexly.com/api/public/v1/verifications/nin","urlObject":{"path":["api","public","v1","verifications","nin"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ec43b8b-7355-429d-ad57-f1d3e41c1864"},{"name":"NIN By Phone","id":"f90fc8d5-c5bc-223c-1015-19b91f7a502a","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with NIN_VERIFY scope

\n"},{"key":"Idempotency-Key","value":"dca64199-03e8-48b6-af34-880da89dbd9e","description":"

Unique UUID to prevent duplicate billing

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"08012345678\"\n}","options":{"raw":{"language":"json"}}},"url":"https://idyntic.getapexly.com/api/public/v1/verifications/nin/phone","urlObject":{"path":["api","public","v1","verifications","nin","phone"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f90fc8d5-c5bc-223c-1015-19b91f7a502a"}],"id":"52322174-bfaf-4bd2-8a2a-a1c020ef9e81","description":"

National Identity Number (NIN) verification endpoints

\n","_postman_id":"52322174-bfaf-4bd2-8a2a-a1c020ef9e81"},{"name":"BVN Verification","item":[{"name":"BVN By BVN","id":"268028fe-65bb-4543-8058-0cc8ed6e1f24","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with BVN_VERIFY scope

\n"},{"key":"Idempotency-Key","value":"50c4d39b-6603-4bf8-b425-da18038e0ddd","description":"

Unique UUID to prevent duplicate billing

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bvn\": \"22222222222\"\n}","options":{"raw":{"language":"json"}}},"url":"https://idyntic.getapexly.com/api/public/v1/verifications/bvn","urlObject":{"path":["api","public","v1","verifications","bvn"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"268028fe-65bb-4543-8058-0cc8ed6e1f24"},{"name":"Download BVN Slip PDF","id":"c3317130-750d-63ff-20f2-153883d44d37","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with BVN_VERIFY scope

\n"},{"key":"Idempotency-Key","value":"58715f82-af37-4d47-83df-d04bab729bc6","description":"

Unique UUID to prevent duplicate billing

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"clw9x01230003...\",\n \"token\": \"\",\n \"format\": \"json\"\n}","options":{"raw":{"language":"json"}}},"url":"https://idyntic.getapexly.com/api/public/v1/verifications/bvn/slip/pdf","urlObject":{"path":["api","public","v1","verifications","bvn","slip","pdf"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3317130-750d-63ff-20f2-153883d44d37"},{"name":"Preview BVN Slip","id":"919a73ce-80b2-2a44-b943-224853f23c4b","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"

API Key with BVN_VERIFY scope

\n"},{"key":"Idempotency-Key","value":"ded555ae-4b27-4770-a2ea-2b5339b4cdc9","description":"

Unique UUID to prevent duplicate billing

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"clw9x01230003...\",\n \"token\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://idyntic.getapexly.com/api/public/v1/verifications/bvn/slip/preview","urlObject":{"path":["api","public","v1","verifications","bvn","slip","preview"],"host":["https://idyntic.getapexly.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"919a73ce-80b2-2a44-b943-224853f23c4b"}],"id":"9dbc367f-36f5-46df-aae5-0e21dc5b6133","description":"

Bank Verification Number (BVN) verification and slip generation endpoints

\n","_postman_id":"9dbc367f-36f5-46df-aae5-0e21dc5b6133"}],"variable":[{"key":"base-url","value":"https://idyntic.getapexly.com"},{"key":"api-key","value":""},{"key":"bvn_slip_token","value":""}]}