Radius API Documentation covers how to use the API endpoints and handling authentication. Please before you get started, ensure you sign up to Radius.
\nRadius uses API Tokens to allow acces to its API. Api tokens can be gotten by creating API Keys at the Radius Dashboard. The API token must be added to the request headers using Api-Token.
API keys require specific permissions in order to use the corresponding API Endpoints. This can be set when creating an API key or when editing its permissions under Settings.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15324321","collectionId":"1302032d-e134-417a-a8f4-cc4a2f420190","publishedId":"TzJoDLJB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-12T14:12:42.000Z"},"item":[{"name":"Identity","item":[{"name":"Fetch BVN (Advanced) Details","id":"272384d2-5b7a-49b4-9f5f-94a7f35383af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/identity/bvn/advanced/This endpoint fetches the details for a BVN.
\nURL Params:
\nNote:
\nThis endpoint fetches the details for a NIN.
\nURL Params:
\nNote:
\nThis endpoint fetches the details for a NIN using the associated phone number.
\nURL Params:
\nNote:
\nThis endpoint fetches the details for a CAC.
\nURL Params:
\nQuery Params:
\nNote:
\nThis endpoint fetches the details for a Driver License Number.
\nURL Params:
\nNote:
\nThis endpoint fetches the details for a Nigerian Passport.
\nURL Params:
\nQuery Params:
\nNote:
\nformat is Y-m-d e.g. 1978-03-01
\n","type":"text/plain"},"key":"dob","value":"This endpoint fetches an API token using OAuth Authorization Code. An API token obtained in this way, can only be used to perform actions on behalf of the logged-in user. This endpoint is to be called after the user has been redirected to the vendor site after a successful login using AuthX.
\nRequest Body Parameters:
\n","urlObject":{"path":["oauth","access","token"],"host":["{{authx_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b262f8c0-af78-45de-b51f-d96e39cd2446","name":"Get Access Token (Using Authorization Code)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"grant_type\": \"authorization_code\",\r\n \"client_id\": \"CL5P7YL3dgCrhCMK26kemxvLw54Sn9Js4ouTU6e9\",\r\n \"client_secret\": \"PCfafUebusXCmhU2sPm2lxFNdXF8W82Abrow6inHXoYLtVd45pDQjrZc6cGo\",\r\n \"redirect_uri\": \"http://www.example.com/authorized\",\r\n \"code\": \"def502008caf01987e24866ec26a7fd71628f6df10eb11c7d61e6ab10d33a2ff8c984a1b4c19807e79f6a49ff1fdc40355bc16150bc7230d186b17ecb9b8916ad38280b3867cc9452238070ea562dbcc35c2f09e0cfeb82279f9dc1c992cde781a337e34de7e38ceb93b3881050448eebe8d8736319cc896210a2d4df43b2ff99269b971bdc35e442f7d870e92c587ef0dd008eb88c29ae23158c6c5e7b73e722a232be4ff1c60a90fbe6f16dcec3479aefe566dd800ae9ab57b19db28747f46638223bb1ac8f18ca7eef85b2046837df74e4f53cd8850272fc40b6c1b8c6e691225e18714cc7be7c3e797da901347248feed2552fe1035a16eebec27ad1c6bd53e6582d4fb02a2175aa5f3f5fe04f3dc6846d7732cd0410283c751eada8cff78e9621043b7337c8f4cf7a5d4cb2842f5f85f1f0e79e97a923532398d0958aabe3837337519c23f4055ea8925093cc3a9542efc2b422eca66cba4b246be4ed70a044bae91197db07c2890a8540545aa69728ded770edb6e98fe0582163ec7eb85ca51b510123b8927d2bbc6b722d596c19d68e8a4420de46c0b9514df2561d78e8979731f23eee69fc8222afd913380ee7bcbf88760e82444bede60b35de3fc8bc4659de1d2c208b14f23adf2fbd865f9e966153fb3fc34eece5638a3790ce835e626fd8146b1c0a2c28c630c36edf4510f0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{authx_base_url}}/oauth/access/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Aug 2021 22:52:05 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Set-Cookie","value":"XDEBUG_SESSION=PHPSTORM; expires=Mon, 30-Aug-2021 23:52:05 GMT; Max-Age=3600; path=/"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Length","value":"296"},{"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 \"expires_in\": 3597,\n \"access_token\": \"d7d1fe00fe38e7282d1ec4c6557dd4d6e1b8dbafb1a52bff32498947128468d914d87628c97f07eb\",\n \"user\": {\n \"identifier\": \"example@gmail.com\",\n \"code\": \"e60dfb96-824d-42cc-a9ed-05d4837fa0ef\",\n \"data\": {\n \"field1\": \"value1\",\n \"field2\": \"value2\"\n }\n }\n },\n \"message\": null\n}"}],"_postman_id":"b53038ed-4727-4252-acdb-1d1e283bf3c0"},{"name":"Get Access Token (Using Client Credentials)","id":"6bfe7f78-5143-4767-a47c-ca63f44cb56f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"grant_type\": \"client_credentials\",\r\n \"client_id\": \"{{app_client_id}}\",\r\n \"client_secret\": \"{{app_client_secret}}\",\r\n \"scope\": \"authx.vendors\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{authx_base_url}}/oauth/access/token","description":"This endpoint fetches an API token using OAuth Client Credentials. An API token obtained in this way has vendor level permission which means can access any data associated with the AuthX App.
\nRequest Body Parameters:
\n","urlObject":{"path":["oauth","access","token"],"host":["{{authx_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"994a5ee1-08a1-4e92-9809-6703843a6dd4","name":"Get Access Token (Using Client Credentials)","originalRequest":{"method":"POST","header":[{"key":"DATA-USER-ID","value":"{{data_user_id}}","type":"text"},{"key":"DATA-USER-TYPE","value":"{{data_user_type}}","type":"text"},{"key":"DATA-ORGANISATION-ID","value":"{{data_organisation_id}}","type":"text"},{"key":"DATA-SERVICE-PERMISSIONS","value":"{{data_service_permissions}}","type":"text"},{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"grant_type\": \"client_credentials\",\r\n \"client_id\": \"CL5P7YL3dgCrhCMK26kemxvLw54Sn9Js4ouTU6e9\",\r\n \"client_secret\": \"PCfafUebusXCmhU2sPm2lxFNdXF8W82Abrow6inHXoYLtVd45pDQjrZc6cGo\",\r\n \"scope\": \"authx.vendors\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{authx_base_url}}/oauth/access/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Aug 2021 22:58:13 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Length","value":"258"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"expires_in\": 3600,\n \"access_token\": \"d41b321b9b47dbb2e88cd4d40564c075e90373ef1e6c6f6aeb41dc3fd64c0e40c8089545fce9fe07\",\n \"app\": {\n \"name\": \"Aros App\",\n \"code\": \"b85910af-0bed-414b-8c75-caac404efa6a\",\n \"description\": \"blah blah\"\n }\n },\n \"message\": null\n}"}],"_postman_id":"6bfe7f78-5143-4767-a47c-ca63f44cb56f"}],"id":"e3771ef2-b859-4f66-9a17-87696ce468e9","_postman_id":"e3771ef2-b859-4f66-9a17-87696ce468e9","description":""},{"name":"User","item":[{"name":"Fetched User Details","id":"064ad779-26c0-4baf-a8b2-7d895d66dbed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{authx_base_url}}/apps/{{app_code}}/users/{{user_code}}","description":"vendor, user
This endpoint fetches a user's details.
\nURL Parameters:
\n","urlObject":{"path":["apps","{{app_code}}","users","{{user_code}}"],"host":["{{authx_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4619a361-62e0-49fb-a1c1-c8aaca0a9d1a","name":"Fetched User Details","originalRequest":{"method":"GET","header":[{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"url":"{{authx_base_url}}/apps/8d529725-6a7f-4495-a5f9-2f408975c078/users/b89b0eab-1ff5-491c-bb55-5ea9c653472b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Aug 2021 17:41:58 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Set-Cookie","value":"XDEBUG_SESSION=PHPSTORM; expires=Mon, 30-Aug-2021 18:41:58 GMT; Max-Age=3600; path=/"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Length","value":"367"},{"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 \"identifier\": \"example@gmail.com\",\n \"code\": \"b89b0eab-1ff5-491c-bb55-5ea9c653472b\",\n \"app\": {\n \"name\": \"New App\",\n \"code\": \"8d529725-6a7f-4495-a5f9-2f408975c078\",\n \"status\": \"active\"\n },\n \"signed_up_at\": \"2021-08-13 12:43:55\",\n \"status\": \"active\",\n \"main_data\": {\n \"data\": {\n \"field1\": \"value1\",\n \"field2\": \"value2\"\n },\n \"modified_at\": \"2021-08-13 14:40:43\"\n }\n },\n \"message\": null\n}"}],"_postman_id":"064ad779-26c0-4baf-a8b2-7d895d66dbed"},{"name":"Fetched User List","id":"f6ad755b-610a-4bd7-9e4e-03bff2089ba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{authx_base_url}}/apps/{{app_code}}/users","description":"vendor, user
This endpoint fetches a list of users with their details. This list is paginated. The list can be altered with available URL Query Parameters. If this endpoint is used as a user then it will only return the user's record.
URL Parameters:
\nURL Query Parameters:
\n","urlObject":{"path":["apps","{{app_code}}","users"],"host":["{{authx_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ad8a0437-c1c2-48a3-b3ce-b5edf3cd8e0d","name":"Fetched User List","originalRequest":{"method":"GET","header":[{"key":"Api-Token","value":"{{api_token}}","type":"text"}],"url":"{{authx_base_url}}/apps/8d529725-6a7f-4495-a5f9-2f408975c078/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Aug 2021 17:41:41 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Set-Cookie","value":"XDEBUG_SESSION=PHPSTORM; expires=Mon, 30-Aug-2021 18:41:41 GMT; Max-Age=3600; path=/"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Length","value":"780"},{"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 \"pagination\": {\n \"total_count\": 1,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"count\": 1\n },\n \"list\": [\n {\n \"identifier\": \"example@gmail.com\",\n \"code\": \"aa1abad3-5207-44c2-af44-2997c3d8b1a0\",\n \"app\": {\n \"name\": \"New App\",\n \"code\": \"8d529725-6a7f-4495-a5f9-2f408975c078\",\n \"status\": \"active\"\n },\n \"signed_up_at\": \"2021-08-11 17:02:55\",\n \"status\": \"active\",\n \"main_data\": {\n \"data\": {\n \"field1\": \"value1\",\n \"field2\": \"value2\"\n },\n \"modified_at\": \"2021-08-11 17:19:54\"\n }\n }\n ]\n },\n \"message\": null\n}"}],"_postman_id":"f6ad755b-610a-4bd7-9e4e-03bff2089ba0"}],"id":"62d96293-7e2d-4fcf-a8ad-f5f32bd98a58","_postman_id":"62d96293-7e2d-4fcf-a8ad-f5f32bd98a58","description":""}],"id":"0dae6539-dbb5-4ffa-ba99-8547ecd1e02a","description":"This section explains API provided by the AuthX Service. Most AuthX API endpoints require an API token for authorization.
\nThe API token can be obtained into two ways:
\nThe OAuth Section showcase the endpoints that use the above details to obtain the API token.
It is important to note that if the API token is obtained using the Authorization Code, API requests can only be made on behalf of the logged-in user. This means that the API token can only be used to act as the user when performing an action, fetch and/or manipulate the user's data. An API token obtained in this manner cannot be used for another user. Any endpoint in this document which allows this type of access will be be tagged with user
If the API token is obtained using the App Client Credentials, it has the vendor access which means that it can access any data associated with the app. Any endpoint in this document which allows this type of access will be be tagged with vendor
In order to use an API token for an endpoint, it needs to be passed in the Request Headers using the following key: Api-Token
Note
\n","_postman_id":"0dae6539-dbb5-4ffa-ba99-8547ecd1e02a"}]}