{"info":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","description":"

Overview

\n

Welcome to UserID API! Here you'll find all the documentation you need to get up and running with the UserID API.

\n

For more information, please visit https://www.userid.africa.

\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
ServiceDescription
UPDVUser On-boarding Service. This covers every thing related to verifying your user's identity.
RAVResidential Address Verification. Verify your user's current place of residence.
DGSDigital Guarantor Request Service. Offer your users a streamlined and efficient way of providing guarantors on your platform.
POIProof Of Identity. Verify your user is human and is the true owner of the provided identity document.
\n

Getting Started

\n

To get started, create an account at https://dashboard.userid.africa. Once you have created an account and completed the KYC process, you can immediately start integrating UserID into your application.

\n

Next, create your first App from your Dashboard and copy your Integration Key.

\n

Authentication

\n

All requests to UserID are authenticated using API keys. To get your API Key pair, login to your dashboard at https://dashboard.userid.africa/account. Your API Key pair can be found under the \"Accounts\" menu under the API section.

\n

Note: A combination of your account API key and your App's integration key is required.

\n

Webhooks

\n

UserID API uses webhooks to return status objects to your system once a user completes a verification session. Be sure to provide a valid callback url.

\n

To verify the authenticity of a received status object, UserID includes a \"vHash\" header parameter in every webhook posted to your callback url.

\n

vHash = hash512(YOUR-UNIQUE-REFERENCE + YOUR-ACCOUNT-API-ENCRYPTION-KEY)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"}],"owner":"242585","collectionId":"80eab171-8470-4cd5-9191-96225812921e","publishedId":"2s83mjE1ES","public":true,"customColor":{"top-bar":"5B2EEA","right-sidebar":"303030","highlight":"5B2EEA"},"publishDate":"2022-10-12T11:14:34.000Z"},"item":[{"name":"UPDV Endpoints","item":[{"name":"Create UPDV Session","id":"e31a33da-0f88-4361-b284-f549a89249a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"country_code\": \"NGA\",\n \"enable_liveness_check\": true,\n \"document_types\":[],\n \"additional_information\": [\n {\n \"display_name\": \"Favourite Hero\",\n \"key\": \"hero\",\n \"type\": \"select\",\n \"options\": [\n \"Superman\",\n \"Batman\",\n \"Freakazoid\",\n \"Deathstroke\",\n \"Johnny Bravo\",\n \"Captain Caveman\",\n {\n \"value\": \"justice_league\",\n \"display_name\": \"Justice League\"\n }\n ]\n },\n {\n \"display_name\": \"Email Address\",\n \"key\": \"email\",\n \"type\": \"email | text | number | date\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/updv/create.json","description":"

Seamlessly on-board your users, we handle the entire process and will send you a status object once completed.

\n

Note: Send your users to the returned verification link.

\n

Callback Url is required to receive a status object once your user has completed the process. See Fetch UPDV Endpoint for a sample of the JSON status object sent to your callback url.

\n

Additional Information provides a way of capturing unique information about a user that is required by your service. This is an optional parameter and can be skipped if not required. The value provided by your user will be sent along with the status object.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","updv","create.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"250f97d5-5354-43b0-8fc8-5643ac8ea2a4","name":"Create UPDV Session","originalRequest":{"method":"POST","header":[{"key":"token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"country_code\": \"NGA\",\n \"additional_information\": [\n {\n \"display_name\": \"Favourite Hero\",\n \"key\": \"hero\",\n \"type\": \"select\",\n \"options\": [\n \"Superman\",\n \"Batman\",\n \"Freakazoid\",\n \"Deathstroke\",\n \"Johnny Bravo\",\n \"Captain Caveman\"\n ]\n },\n {\n \"display_name\": \"Email Address\",\n \"key\": \"email\",\n \"type\": \"text\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/updv/create.json"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"session_reference\": \"\",\n \"redirect_url\": \"\"\n }\n}"}],"_postman_id":"e31a33da-0f88-4361-b284-f549a89249a6"},{"name":"Fetch UPDV Session","id":"d4846293-39b0-4664-a100-23fab87ca8b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/updv//status.json","description":"

Fetch a previously generate UPDV session.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","updv","","status.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"bc0baa25-a0b3-4aee-b39f-bb11458e78a6","name":"Fetch UPDV Session","originalRequest":{"method":"GET","header":[],"url":"https://api.userid.africa/api/updv//status.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 13:11:02 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Length","value":"221166"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"event\": \"updv.result\",\n \"reference\": \"\",\n \"session_reference\": \"\",\n \"verification_status\": \"success\",\n \"verification_data\": {\n \"profile\": {\n \"last_name\": \"Doe\",\n \"other_names\": \"John\",\n \"dob\": \"1990-01-01\",\n \"gender\": \"M\",\n \"photo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/\"\n },\n \"document\": {\n \"name\": \"International Passport\",\n \"type\": \"passport\",\n \"country_code\": \"NGA\",\n \"exp_date\": \"2030-07-15\",\n \"document_number\": \"B012345678\",\n \"image\": {\n \"front\": \"data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/\",\n \"back\": null\n }\n }\n },\n \"additional_information\": {\n \"email\": \"johndoe@theworld.com\",\n \"hero\": \"Freakazoid\"\n }\n }\n}"}],"_postman_id":"d4846293-39b0-4664-a100-23fab87ca8b2"},{"name":"Create UPDV Collection","id":"5081d38b-6398-4f4e-be0f-5fbf058d6480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"country_code\": \"NGA\",\n \"enable_liveness_check\": true,\n \"document_types\":[\"BVN\", \"PASSPORT\"],\n \"form_fields\": [\n {\n \"display_name\": \"Favourite Hero\",\n \"key\": \"hero\",\n \"type\": \"select\",\n \"options\": [\n \"Superman\",\n \"Batman\",\n \"Freakazoid\",\n \"Deathstroke\",\n \"Johnny Bravo\",\n \"Captain Caveman\",\n {\n \"value\": \"justice_league\",\n \"display_name\": \"Justice League\"\n }\n ]\n },\n {\n \"display_name\": \"Email Address\",\n \"key\": \"email\",\n \"type\": \"email | text | number | date\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/updv/collections/create.json","description":"

Create UPDV collections (form builder). Share a single verification link with your users to capture relevant information and verify their identities.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","updv","collections","create.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"b47167b6-a9ae-4ac6-af21-83ff8d551330","name":"Create UPDV Collection","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"country_code\": \"NGA\",\n \"enable_liveness_check\": true,\n \"document_types\":[\"BVN\", \"PASSPORT\"],\n \"form_fields\": [\n {\n \"display_name\": \"Favourite Hero\",\n \"key\": \"hero\",\n \"type\": \"select\",\n \"options\": [\n \"Superman\",\n \"Batman\",\n \"Freakazoid\",\n \"Deathstroke\",\n \"Johnny Bravo\",\n \"Captain Caveman\",\n {\n \"value\": \"justice_league\",\n \"display_name\": \"Justice League\"\n }\n ]\n },\n {\n \"display_name\": \"Email Address\",\n \"key\": \"email\",\n \"type\": \"email | text | number | date\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/updv/collections/create.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"collection\": {\n\n },\n \"redirect_url\": \"https://api.userid.africa/v1/updv/collection/\"\n }\n}"}],"_postman_id":"5081d38b-6398-4f4e-be0f-5fbf058d6480"},{"name":"Get Collection","id":"02171659-2c50-4af4-ab0c-4332b4979637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/updv/collections//get.json","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","updv","collections","","get.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"02171659-2c50-4af4-ab0c-4332b4979637"},{"name":"List Collections","id":"82b50891-7e8b-4b44-8106-e118fde1e9bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/updv/collections.json","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","updv","collections.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"82b50891-7e8b-4b44-8106-e118fde1e9bb"}],"id":"42926436-5d9b-4ab0-afec-3570031436bd","_postman_id":"42926436-5d9b-4ab0-afec-3570031436bd","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}}},{"name":"POI Endpoints","item":[{"name":"Verify ID (+ Face Match)","id":"4d849250-fd06-4e72-9022-9bbaf4557b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"country_code\": \"NGA\",\n \"document_type\": \"BVN\",\n \"document_number\": \"12345678901\",\n \"photo\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/identity/search.json","description":"

This API Endpoint verifies a user's provided ID document.

\n

Optional: To perform a face match against the ID, provide a clear photo showing the user's face.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","identity","search.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"5b15987c-402f-4f74-b97b-172945a637bd","name":"Verify ID (+ Face Match)","originalRequest":{"method":"POST","header":[{"key":"token","value":"","type":"default"}],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"country_code\": \"NGA\",\n \"document_type\": \"PASSPORT\",\n \"document_number\": \"12345678901\",\n \"photo\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/identity/search.json"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"result\": {\n \"last_name\": \"Doe\", \n \"first_name\": \"John\", \n \"middle_name\": \"\", \n \"dob\": \"1990-01-01\", \n \"gender\": \"M\", \n \"exp_date\": \"2030-07-15\", \n \"face\": \"data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/\", \n \"document_number\": \"12345678901\",\n \"face_match\": {\n \"checked\": false,\n \"result\": false\n }\n }\n }\n}"}],"_postman_id":"4d849250-fd06-4e72-9022-9bbaf4557b51"},{"name":"Verify ID (+ Human Liveness Check)","id":"d66185a5-a856-405a-89ae-7ac4c90dbf7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"country_code\": \"\",\n \"document_type\": \"\",\n \"document_number\": \"\",\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/poi/create.json","description":"

Verify that your user is human, is present and is the owner of the presented means of Identification via our AI driven human liveness algorithm.

\n

Note: Send your users to the returned verification link.

\n

Callback Url is required to receive a status object once your user has completed the process. See Fetch POI Endpoint for a sample of the JSON status object sent to your callback url.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","poi","create.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"3b81bf0f-002a-4744-895f-637fa26e72c3","name":"Verify Identity Ownership (POI)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"country_code\": \"\",\n \"document_type\": \"\",\n \"document_number\": \"\",\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/poi/create.json"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"session_reference\": \"\",\n \"redirect_url\": \"\"\n }\n}"}],"_postman_id":"d66185a5-a856-405a-89ae-7ac4c90dbf7c"},{"name":"Fetch POI Session Status","id":"8cec9e51-8de5-44ea-9836-7eb0c001d6c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/poi//status.json","description":"

Fetch a previously generate POI session.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","poi","","status.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"afcce424-ac3f-4cc4-be01-5f16683c7dab","name":"Fetch POI Session","originalRequest":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/poi//status.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 13:11:02 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Length","value":"221166"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"event\": \"poi.request.complete\",\n \"reference\": \"\",\n \"session_reference\": \"\",\n \"verification_data\": {\n \"status\": \"verified\",\n \"closed\": true,\n \"created\": \"%Y-%m-%d %H:%M:%S\",\n \"applicant\": {\n \"country\": \"NGA\",\n \"document_type\": \"\",\n \"document_number\": \"\",\n \"photo\": \"\"\n },\n \"liveness_data\":{\n \"photo\": \"\",\n \"passed\": true,\n \"verified_on\": \"%Y-%m-%d %H:%M:%S\"\n }\n }\n }\n}"}],"_postman_id":"8cec9e51-8de5-44ea-9836-7eb0c001d6c6"}],"id":"bb120191-49c3-4229-b20d-232c9b316eaa","_postman_id":"bb120191-49c3-4229-b20d-232c9b316eaa","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}}},{"name":"RAV Endpoints","item":[{"name":"Create RAV Session","id":"55c78c34-179f-4836-aeea-838629123085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"customer\":{\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"email\":\"\",\n \"phone\":\"\",\n \"photo\":\"\"\n },\n \"address\":{\n \"full_address\":\"\",\n \"latitude\":\"\",\n \"longitude\": \"\"\n },\n \"callback_url\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/rav/create.json","description":"

Verify your user's claimed residential address with ease. This service is a asynchronous.

\n

Note: Send your users to the returned verification link.

\n

Callback Url is required to receive a status object once your user has completed the process. See Fetch RAV Endpoint for a sample of the JSON status object sent to your callback url.

\n

Customer Object: This is optional. When passed, all fields are mandatory.

\n

Address Object: This is optional. When passed, all fields are mandatory.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","rav","create.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"e1d7a943-faeb-4288-a2a1-77aa780f6f81","name":"Create RAV Session","originalRequest":{"method":"POST","header":[{"key":"token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"customer\":{\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"email\":\"\",\n \"phone\":\"\",\n \"photo\":\"\"\n },\n \"address\":{\n \"full_address\":\"\",\n \"latitude\":\"\",\n \"longitude\": \"\"\n },\n \"callback_url\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/rav/create.json"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"session_reference\": \"\",\n \"redirect_url\": \"\"\n }\n}"}],"_postman_id":"55c78c34-179f-4836-aeea-838629123085"},{"name":"Fetch RAV Session","id":"198c6f6a-d918-4b61-8a59-284bf5a40a30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/rav//status.json","description":"

Fetch a previously generate RAV session.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","rav","","status.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"a13dca36-7ae0-429a-9af1-d4d7ed609eb7","name":"Fetch RAV Session","originalRequest":{"method":"GET","header":[{"key":"token","value":"","type":"text"}],"url":"https://api.userid.africa/v1/rav//status.json"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"event\": \"address.verification.complete\",\n \"reference\": \"\",\n \"session_reference\": \"\",\n \"verification_data\": {\n \"confidence_score\": \"93.91\",\n \"address\": {\n \"residential_address\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"customer\": {\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"gender\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"photo\": \"\"\n },\n \"verifications\": [\n {\n \"reference\": \"\",\n \"photo\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"score\": \"85.97\",\n \"captured_on\": \"%Y-%m-%d %H:%M:%S\",\n \"timestamp\": \"\"\n }\n ]\n }\n }\n}"}],"_postman_id":"198c6f6a-d918-4b61-8a59-284bf5a40a30"}],"id":"86e86f59-6153-4232-bf52-33da7a482800","_postman_id":"86e86f59-6153-4232-bf52-33da7a482800","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}}},{"name":"DGS Endpoints","item":[{"name":"Create Session","id":"11246f03-4b4a-4659-89ec-a67721a695fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"reason\": \"The applicant has applied for loan with KYB Digital Bank and wishes for you to be a guarantor\",\n \"country_code\": \"NGA\",\n \"applicant\": {\n \"last_name\": \"Doe\",\n \"first_name\": \"John\",\n \"gender\": \"M\",\n \"dob\": \"1990-01-01\",\n \"email_address\": \"john.doe@theworld.com\",\n \"phone_number\": \"\",\n \"identity\": {\n \"document_type\": \"DL\",\n \"document_number\": \"\"\n }\n },\n \"additional_information\": [\n {\n \"display_name\": \"Bank Name\",\n \"key\": \"bank\",\n \"type\": \"select\",\n \"options\": [\n \"Access Bank\",\n \"First Bank\",\n \"Zenith Bank\",\n \"Fidelity Bank\",\n \"Union Bank\",\n \"Sterling Bank\"\n ]\n },\n {\n \"display_name\": \"Account Name\",\n \"key\": \"account_name\",\n \"type\": \"text\",\n \"options\": []\n },\n {\n \"display_name\": \"Account Number\",\n \"key\": \"account_number\",\n \"type\": \"text\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/dgs/create.json","description":"

Issue a digital guarantor request session for your users. Say goodbye to paper forms and manual processes.

\n

Note: Send your users to the returned verification link.

\n

Callback Url is required to receive a status object once your user has completed the process. See Fetch DGS Endpoint for a sample of the JSON status object sent to your callback url.

\n

Additional Information Object is only required if your service requires certain information from a guarantor. You can skip or set to null to ignore this.

\n

For a list of available ID document types for a country, see the endpoint: Document Types.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","dgs","create.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"6bea9510-8022-45d1-869e-c7804b84dff0","name":"Create Session","originalRequest":{"method":"POST","header":[{"key":"token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"app_integration_key\": \"\",\n \"verification_reference\": \"\",\n \"reason\": \"The applicant has applied for loan with KYB Digital Bank and wishes for you to be a guarantor\",\n \"country_code\": \"NGA\",\n \"applicant\": {\n \"last_name\": \"Doe\",\n \"first_name\": \"John\",\n \"gender\": \"M\",\n \"dob\": \"1990-01-01\",\n \"email_address\": \"john.doe@theworld.com\",\n \"phone_number\": \"\",\n \"identity\": {\n \"document_type\": \"DL\",\n \"document_number\": \"\"\n }\n },\n \"additional_information\": [\n {\n \"display_name\": \"Bank Name\",\n \"key\": \"bank\",\n \"type\": \"select\",\n \"options\": [\n \"Access Bank\",\n \"First Bank\",\n \"Zenith Bank\",\n \"Fidelity Bank\",\n \"Union Bank\",\n \"Sterling Bank\"\n ]\n },\n {\n \"display_name\": \"Account Name\",\n \"key\": \"account_name\",\n \"type\": \"text\",\n \"options\": []\n },\n {\n \"display_name\": \"Account Number\",\n \"key\": \"account_number\",\n \"type\": \"text\",\n \"options\": []\n }\n ],\n \"callback_url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.userid.africa/v1/dgs/create.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 12:42:35 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Length","value":"117"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"session_reference\": \"\",\n \"redirect_url\": \"\"\n }\n}"}],"_postman_id":"11246f03-4b4a-4659-89ec-a67721a695fa"},{"name":"Fetch DGS Session","id":"2006e58b-b23d-4b69-9aee-20ad7e0f11f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/dgs//status.json","description":"

Fetch a previously generate DGS session.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","dgs","","status.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"060207f6-aebd-4edb-b084-4953750b658e","name":"Fetch DGS Session","originalRequest":{"method":"GET","header":[{"key":"token","value":"","type":"text"}],"url":"https://api.userid.africa/v1/dgs//status.json"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"event\": \"guarantor.request.complete\",\n \"reference\": \"\",\n \"session_reference\": \"\",\n \"data\": {\n \"guarantor_number\": 1,\n \"status\": \"completed\",\n \"closed\": true,\n \"created\": \"%Y-%m-%d %H:%M:%S\",\n \"applicant\": {\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"gender\": \"M\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"document_type\": \"NIN\",\n \"document_number\": \"012345678901\"\n },\n \"guarantors\": [\n {\n \"profile\": {\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"gender\": \"M or F\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"photo\": \"\"\n },\n \"identity_document\": {\n \"document_type\": \"DL\",\n \"document_name\": \"Driver's License\",\n \"document_number\": \"01234567890\",\n \"document_photo\": \"\"\n },\n \"relationship_type\": \"Friend\",\n \"relationship_duration\": \"365 days\",\n \"comment\": \"\",\n \"consent\": true,\n \"additional_information\": {\n \"key\":\"value\"\n },\n \"timestamp\": \"%Y-%m-%d %H:%M:%S\"\n }\n ]\n }\n }\n}"}],"_postman_id":"2006e58b-b23d-4b69-9aee-20ad7e0f11f3"}],"id":"30cc355b-a01e-4543-b6f7-ab0a10f66ce2","_postman_id":"30cc355b-a01e-4543-b6f7-ab0a10f66ce2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}}},{"name":"List Countries","id":"74f720c6-c39a-4195-b90a-65ba8e97098e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/common/countries/list.json","description":"

Get a list of supported countries.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","common","countries","list.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"532053dd-8c4b-4315-a4d6-b7dd997b78b8","name":"List Countries","originalRequest":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/common/countries/list.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 12:30:02 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Length","value":"160"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"countries\": [\n {\n \"id\": 154,\n \"country_name\": \"Nigeria\",\n \"iso_alpha3\": \"NGA\",\n \"currency_code\": \"NGN\",\n \"currency_symbol\": \"₦\"\n }\n ]\n }\n}"}],"_postman_id":"74f720c6-c39a-4195-b90a-65ba8e97098e"},{"name":"List ID Document Types","id":"89fe1d68-89bb-436e-aeeb-c2a5aaa156d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/common/document_types//list.json","description":"

Get a list of supported ID documents by country.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"80eab171-8470-4cd5-9191-96225812921e","id":"80eab171-8470-4cd5-9191-96225812921e","name":"UserID API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","common","document_types","","list.json"],"host":["api","userid","africa"],"query":[],"variable":[]}},"response":[{"id":"d07a2dce-4eda-42e3-88a6-64aa7207404e","name":"List ID Document Types","originalRequest":{"method":"GET","header":[],"url":"https://api.userid.africa/v1/common/document_types//list.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 12:31:08 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Length","value":"443"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"document_types\": [\n {\n \"id\": 1,\n \"title\": \"International Passport\",\n \"short_code\": \"passport\",\n \"parameters\": [\n {\n \"display_name\": \"Last Name\",\n \"key\": \"last_name\",\n \"type\": \"text\"\n }\n ]\n },\n {\n \"id\": 3,\n \"title\": \"Driver's License\",\n \"short_code\": \"dl\",\n \"parameters\": []\n },\n {\n \"id\": 5,\n \"title\": \"Bank Verification Number (BVN)\",\n \"short_code\": \"bvn\",\n \"parameters\": []\n },\n {\n \"id\": 6,\n \"title\": \"NIN\",\n \"short_code\": \"nin\",\n \"parameters\": []\n }\n ]\n }\n}"}],"_postman_id":"89fe1d68-89bb-436e-aeeb-c2a5aaa156d0"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"be0c8b0f-0a11-40bb-ab64-c71542b33437","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fa8d4d37-cebc-4e3f-b94c-714e774e9a5e","type":"text/javascript","exec":[""]}}]}