Dataset API

This is the Dataset API that provides programmatic access to various resources and services. The API supports the following areas: Time Data, Person Data, Location Data, Loan Data. All endpoints require authentication using a Bearer token.

The dataset model

The dataset model contains all the information about your dataset entities.

Properties

Name
countries
Type
array
Description
List of countries items
Name
totalCountries
Type
integer
Description
Integer value for totalCountries

List Countries

Fetches a comprehensive list of all countries for geographical data selection.

Request

GET

/v1/datasets/countries

curl -G https://api.adiba.app/v1/datasets/countries \
  -H "Authorization: Bearer {token}"

{
"countries": [
    {
        "countryCode": "NG",
        "countryName": "Nigeria",
        "phoneCode": "+234",
        "currency": "Naira",
        "currencyCode": "NGN",
        "isActive": true,
        "flag": "🇳🇬"
    },
    {
        "countryCode": "GH",
        "countryName": "Ghana",
        "phoneCode": "+233",
        "currency": "Cedi",
        "currencyCode": "GHS",
        "isActive": true,
        "flag": "🇬🇭"
    },
    {
        "countryCode": "KE",
        "countryName": "Kenya",
        "phoneCode": "+254",
        "currency": "Shilling",
        "currencyCode": "KES",
        "isActive": true,
        "flag": "🇰🇪"
    }
],
"totalCountries": 195
}

List States By Country

Retrieves all states or provinces associated with a specified country.

Required attributes

Name
countryCode
Type
string
Description
Countrycode parameter specified in the URL path

Request

GET

/v1/datasets/{countryCode}/states

curl -G https://api.adiba.app/v1/datasets/{countryCode}/states \
  -H "Authorization: Bearer {token}"

{
"countryCode": "NG",
"countryName": "Nigeria",
"states": [
    {
        "stateCode": "LA",
        "stateName": "Lagos",
        "capital": "Ikeja",
        "isActive": true
    },
    {
        "stateCode": "AB",
        "stateName": "Abuja",
        "capital": "Abuja",
        "isActive": true
    },
    {
        "stateCode": "RI",
        "stateName": "Rivers",
        "capital": "Port Harcourt",
        "isActive": true
    }
],
"totalStates": 36
}

List Cities By State

Displays a list of cities located within a particular state.

Required attributes

Name
stateCode
Type
string
Description
Statecode parameter specified in the URL path

Request

GET

/v1/datasets/{stateCode}/cities

curl -G https://api.adiba.app/v1/datasets/{stateCode}/cities \
  -H "Authorization: Bearer {token}"

{
"stateCode": "LA",
"stateName": "Lagos",
"cities": [
    {
        "cityCode": "IKEJA",
        "cityName": "Ikeja",
        "isCapital": true,
        "isActive": true
    },
    {
        "cityCode": "VICTORIA_ISLAND",
        "cityName": "Victoria Island",
        "isCapital": false,
        "isActive": true
    },
    {
        "cityCode": "LEKKI",
        "cityName": "Lekki",
        "isCapital": false,
        "isActive": true
    }
],
"totalCities": 20
}

List Genders

Provides a predefined list of gender options for user profile creation.

Request

GET

/v1/datasets/person/genders

curl -G https://api.adiba.app/v1/datasets/person/genders \
  -H "Authorization: Bearer {token}"

{
"genders": [
    {
        "genderCode": "M",
        "genderName": "Male",
        "description": "Male gender",
        "isActive": true
    },
    {
        "genderCode": "F",
        "genderName": "Female",
        "description": "Female gender",
        "isActive": true
    },
    {
        "genderCode": "O",
        "genderName": "Other",
        "description": "Other gender options",
        "isActive": true
    }
],
"totalGenders": 3
}

List Marital Statuses

Retrieves a standard set of marital status options for user data input.

Request

GET

/v1/datasets/person/maritalStatus

curl -G https://api.adiba.app/v1/datasets/person/maritalStatus \
  -H "Authorization: Bearer {token}"

{
"maritalStatuses": [
    {
        "statusCode": "SINGLE",
        "statusName": "Single",
        "description": "Never married",
        "isActive": true
    },
    {
        "statusCode": "MARRIED",
        "statusName": "Married",
        "description": "Currently married",
        "isActive": true
    },
    {
        "statusCode": "DIVORCED",
        "statusName": "Divorced",
        "description": "Legally divorced",
        "isActive": true
    },
    {
        "statusCode": "WIDOWED",
        "statusName": "Widowed",
        "description": "Spouse deceased",
        "isActive": true
    }
],
"totalStatuses": 4
}

List Professions

Displays a comprehensive list of professions for user data collection.

Request

GET

/v1/datasets/person/professions

curl -G https://api.adiba.app/v1/datasets/person/professions \
  -H "Authorization: Bearer {token}"

{
"professions": [
    {
        "professionCode": "ENGINEER",
        "professionName": "Engineer",
        "category": "TECHNICAL",
        "isActive": true
    },
    {
        "professionCode": "DOCTOR",
        "professionName": "Doctor",
        "category": "MEDICAL",
        "isActive": true
    },
    {
        "professionCode": "LAWYER",
        "professionName": "Lawyer",
        "category": "LEGAL",
        "isActive": true
    },
    {
        "professionCode": "TEACHER",
        "professionName": "Teacher",
        "category": "EDUCATION",
        "isActive": true
    }
],
"pagination": {
    "page": 1,
    "size": 10,
    "total": 150,
    "hasNext": true,
    "hasPrevious": false
}
}

List Family Relationships

Fetches a list of family relationship types for defining next-of-kin.

Request

GET

/v1/datasets/person/relationships

curl -G https://api.adiba.app/v1/datasets/person/relationships \
  -H "Authorization: Bearer {token}"

{
"relationships": [
    {
        "relationshipCode": "SPOUSE",
        "relationshipName": "Spouse",
        "description": "Husband or wife",
        "isActive": true
    },
    {
        "relationshipCode": "PARENT",
        "relationshipName": "Parent",
        "description": "Father or mother",
        "isActive": true
    },
    {
        "relationshipCode": "CHILD",
        "relationshipName": "Child",
        "description": "Son or daughter",
        "isActive": true
    },
    {
        "relationshipCode": "SIBLING",
        "relationshipName": "Sibling",
        "description": "Brother or sister",
        "isActive": true
    },
    {
        "relationshipCode": "OTHER",
        "relationshipName": "Other",
        "description": "Other family relationship",
        "isActive": true
    }
],
"totalRelationships": 5
}

List Time Periods

Retrieves a set of predefined time periods for scheduling or reporting.

Request

GET

/v1/datasets/periods

curl -G https://api.adiba.app/v1/datasets/periods \
  -H "Authorization: Bearer {token}"

{
"periods": [
    {
        "periodCode": "DAILY",
        "periodName": "Daily",
        "duration": "24 hours",
        "description": "Daily period",
        "isActive": true
    },
    {
        "periodCode": "WEEKLY",
        "periodName": "Weekly",
        "duration": "7 days",
        "description": "Weekly period",
        "isActive": true
    },
    {
        "periodCode": "MONTHLY",
        "periodName": "Monthly",
        "duration": "30 days",
        "description": "Monthly period",
        "isActive": true
    },
    {
        "periodCode": "QUARTERLY",
        "periodName": "Quarterly",
        "duration": "3 months",
        "description": "Quarterly period",
        "isActive": true
    },
    {
        "periodCode": "YEARLY",
        "periodName": "Yearly",
        "duration": "12 months",
        "description": "Yearly period",
        "isActive": true
    }
],
"totalPeriods": 5
}

List Loan Time Intervals

Displays available loan repayment intervals for credit application setup.

Request

GET

/v1/datasets/loan/duration

curl -G https://api.adiba.app/v1/datasets/loan/duration \
  -H "Authorization: Bearer {token}"

{
"intervals": [
    {
        "intervalCode": "3_MONTHS",
        "intervalName": "3 Months",
        "durationInMonths": 3,
        "description": "3-month loan term",
        "isActive": true
    },
    {
        "intervalCode": "6_MONTHS",
        "intervalName": "6 Months",
        "durationInMonths": 6,
        "description": "6-month loan term",
        "isActive": true
    },
    {
        "intervalCode": "12_MONTHS",
        "intervalName": "12 Months",
        "durationInMonths": 12,
        "description": "12-month loan term",
        "isActive": true
    },
    {
        "intervalCode": "24_MONTHS",
        "intervalName": "24 Months",
        "durationInMonths": 24,
        "description": "24-month loan term",
        "isActive": true
    },
    {
        "intervalCode": "36_MONTHS",
        "intervalName": "36 Months",
        "durationInMonths": 36,
        "description": "36-month loan term",
        "isActive": true
    }
],
"totalIntervals": 5
}