GET /person

GET/v1/person
Returns a full person object including name, gender, date of birth, phone number, email, and national ID.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/person?country=GH&count=1
EXAMPLE RESPONSE
{
  "country": "GH",
  "count": 1,
  "data": [{
    "name": {
      "first": "Akosua",
      "last": "Mensah",
      "full": "Akosua Mensah"
    },
    "gender": "female",
    "dob": "1991-03-14",
    "phone": "0244871032",
    "network": "MTN",
    "email": "akosua.mensah91@gmail.com",
    "national_id": "GHA-829341720-5",
    "ethnicity": "Akan"
  }]
}
GET/v1/person/name
Returns name fields only - first, last, full, and ethnicity.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/person/name?country=NG&count=2
EXAMPLE RESPONSE
{
  "country": "NG",
  "count": 2,
  "data": [
    {"first": "Chukwuemeka", "last": "Obi", "full": "Chukwuemeka Obi", "ethnicity": "Igbo"},
    {"first": "Fatima", "last": "Abdullahi", "full": "Fatima Abdullahi", "ethnicity": "Hausa"}
  ]
}
GET/v1/person/contact
Returns contact fields - phone number, mobile network, and email address.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/person/contact?country=KE&count=1
EXAMPLE RESPONSE
{
  "country": "KE",
  "count": 1,
  "data": [{"phone": "0712345678", "network": "Safaricom", "email": "wanjiru.k@gmail.com"}]
}
GET/v1/person/identity
Returns identity fields - national ID number, date of birth, and gender.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/person/identity?country=ZA&count=1
EXAMPLE RESPONSE
{
  "country": "ZA",
  "count": 1,
  "data": [{"national_id": "9001014800086", "dob": "1990-01-01", "gender": "male"}]
}