Public
Documentation Settings
Radius API
Double Column
cURL - cURL
Radius API
Introduction
Identity
AuthX

Radius API

Introduction

Radius API Documentation covers how to use the API endpoints and handling authentication. Please before you get started, ensure you sign up to Radius.

Authentication

Radius 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.

Identity

GETFetch BVN (Advanced) Details

https://api.radius.africa/services/v1/identity/bvn/advanced/<bvn>

This endpoint fetches the details for a BVN.

URL Params:

  • < bvn >: the BVN to query

Note:

  • Please check the example to see the response format. The image field in the response is a base64 string.
  • Please add your Api-Token to the Header in order to use the endpoint.
HEADERS
Api-Token

your_api_token

Example Request
Fetch BVN (Advanced) Details
curl
curl --location 'https://api.radius.africa/services/v1/identity/bvn/advanced/78945612356' \
--header 'Api-Token: your_api_token'
200 OK
Example Response
json
{
  "status": "success",
  "data": {
    "type": "response",
    "data": {
      "origin": {
        "lga": "North Lindsaymouth",
        "state": "Kansas"
      },
      "biodata": {
        "image": "Base 64 string"
      },
      "contact": {
        "email": "vlockman@example.net",
        "main_phone_number": "08081234567",
        "other_phone_number": "09011234567"
      },
      "profile": {
        "title": "Prof.",
        "gender": "",
        "last_name": "Goldner",
        "first_name": "Constance",
        "middle_name": "Ashley",
        "nationality": "Nepal",
        "date_of_birth": "",
        "marital_status": ""
      },
      "identity": {
        "bvn": "78945612356",
        "nin": ""
      },
      "metadata": {
        "watch_listed": "",
        "registration_date": ""
      },
      "residence": {
        "lga": "Lake Hayden",
        "state": "Pennsylvania",
        "address": "7588 Keven Manors Suite 826"
      }
    }
  },
  "message": null
}
Date

Sat, 10 Apr 2021 19:52:40 GMT

Server

Apache/2.4.29 (Ubuntu)

Set-Cookie

XDEBUG_SESSION=PHPSTORM; expires=Sat, 10-Apr-2021 20:52:40 GMT; Max-Age=3600; path=/

Cache-Control

no-cache, private

Content-Length

631

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

GETFetch NIN Details

https://api.radius.africa/services/v1/identity/nin/<nin>

This endpoint fetches the details for a NIN.

URL Params:

  • < nin >: the NIN to query

Note:

  • Please check the example to see the response format. The image and signature fields in the response are base64 strings.
  • Please add your Api-Token to the Header in order to use the endpoint.
HEADERS
Api-Token

your_api_token

Example Request
Fetch NIN Details
curl
curl --location 'https://api.radius.africa/services/v1/identity/nin/12345678996' \
--header 'Api-Token: your_api_token'
200 OK
Example Response
json
{
  "status": "success",
  "data": {
    "type": "response",
    "data": {
      "origin": {
        "lga": "South Wileychester",
        "state": "Illinois",
        "address": "1831 Morissette Pines"
      },
      "biodata": {
        "image": "Base 64 string",
        "signature": "Base 64 string"
      },
      "contact": {
        "email": "chesley22@example.com",
        "main_phone_number": "08031234567"
      },
      "profile": {
        "title": "Mrs.",
        "gender": "",
        "surname": "Monahan",
        "religion": "",
        "first_name": "Araceli",
        "maiden_name": "Lakin",
        "middle_name": "Vicenta",
        "nationality": "Bouvet Island (Bouvetoya)",
        "date_of_birth": "",
        "marital_status": "",
        "spoken_language": "kk",
        "educational_level": ""
      },
      "residence": {
        "lga": "Bayerhaven",
        "town": "Framiside",
        "state": "Oklahoma",
        "status": "",
        "address": "81353 Coy Island Apt. 095"
      },
      "employment": {
        "status": "",
        "profession": "Animal Control Worker"
      },
      "next_of_kin": {
        "surname": "Schinner",
        "residence": {
          "lga": "Dejahton",
          "state": "Missouri",
          "address": "88877 Batz Walk Dooleyberg"
        },
        "first_name": "Elmo"
      },
      "birth_details": {
        "lga": "Tremblayfort",
        "date": "",
        "state": "South Carolina",
        "country": "Russian Federation"
      }
    }
  },
  "message": null
}
Date

Sat, 10 Apr 2021 19:53:25 GMT

Server

Apache/2.4.29 (Ubuntu)

Set-Cookie

XDEBUG_SESSION=PHPSTORM; expires=Sat, 10-Apr-2021 20:53:25 GMT; Max-Age=3600; path=/

Cache-Control

no-cache, private

Content-Length

992

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

GETFetch NIN Details (Using Phone Number)

https://api.radius.africa/services/v1/identity/nin/phone/<phone>

This endpoint fetches the details for a NIN using the associated phone number.

URL Params:

  • < phone >: the phone number to query

Note:

  • Please check the example to see the response format. The image and signature fields in the response are base64 strings.
  • Please add your Api-Token to the Header in order to use the endpoint.
HEADERS
Api-Token

your_api_token

Example Request
Fetch NIN Details (Using Phone Number)
curl
curl --location 'https://api.radius.africa/services/v1/identity/nin/phone/<phone>' \
--header 'Api-Token: your_api_token'
200 OK
Example Response
json
{
  "status": "success",
  "data": {
    "type": "response",
    "data": {
      "origin": {
        "lga": "Ikorodu",
        "state": "Lagos",
        "address": "12 Coal way",
        "spoken_language": "yoruba"
      },
      "biodata": {
        "image": "Base 64 String",
        "signature": "Base 64 String"
      },
      "contact": {
        "email": "chesley22@example.com",
        "main_phone_number": "08075461234"
      },
      "profile": {
        "title": "mr",
        "gender": "m",
        "surname": "TAIWO",
        "religion": "islam",
        "first_name": "OLA",
        "maiden_name": "",
        "middle_name": "FEMI",
        "nationality": "",
        "date_of_birth": "18-11-1985",
        "marital_status": "single",
        "spoken_language": "",
        "educational_level": "tertiary"
      },
      "identity": {
        "nin": "12345678900"
      },
      "residence": {
        "lga": "Ikorodu",
        "town": "Ikorodu",
        "state": "Lagos",
        "status": "birth",
        "address": "12 Coal way"
      },
      "employment": {
        "status": "self employed",
        "profession": "ENGINEER"
      },
      "next_of_kin": {
        "surname": "TAIWO",
        "residence": {
          "lga": "Ikorodu",
          "state": "Lagos",
          "address": "12 Coal way"
        },
        "first_name": "SHOLA",
        "spoken_language": ""
      },
      "birth_details": {
        "lga": "Ikorodu",
        "date": "18-11-1985",
        "state": "Lagos",
        "country": "nigeria"
      }
    }
  },
  "message": null
}
Date

Tue, 10 Aug 2021 12:19:52 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

cache-control

no-cache, private

CF-Cache-Status

DYNAMIC

Expect-CT

max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"

Report-To

{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=vzWo%2FnmVFEV8odqWWLKYdcwm2VBk897CA6zaFNfvEna88OOHBKLnnyrhI7KlCcXvk%2FnbtGXfeCZIjFy0Vd5PpYZDr8%2BtrcjbbBIzx%2F5TEXTgkp%2FxFDyjYtvBuDLKljY7FZ5vAA%3D%3D"}],"group":"cf-nel","max_age":604800}

NEL

{"success_fraction":0,"report_to":"cf-nel","max_age":604800}

Server

cloudflare

CF-RAY

67c92cbf8a320109-AMS

Content-Encoding

br

alt-svc

h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400, h3=":443"; ma=86400