v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

List People

get/person

Query parameters

pageinteger
per_pageinteger

Response

200

messagestring
statusstring

Example response

{
  "data": [
    {
      "id": "f5eb5e3ab39f11ed97c982e65b002663",
      "name_first": "takeshi",
      "name_last": "kovacs",
      "name_other": "lev",
      "email": "takesi@carbon.io",
      "phone": "18510452593",
      "dob": "1999-06-18T00:00:00Z",
      "id_level": "secondary",
      "id_type": "nin",
      "id_number": "98374273242",
      "address_line1": "34 Marka Close",
      "address_city": "Harlan",
      "address_state": "Texas",
      "address_country": "US",
      "status": "active",
      "kyc_status": "verified",
      "created_at": "2023-02-23T17:31:52Z",
      "updated_at": "2023-02-23T17:31:52Z"
    }
  ],
  "message": "People retrieved successfully",
  "meta": {
    "per_page": 20,
    "page": 1,
    "count_total": 1,
    "page_total": 1
  },
  "status": "success"
}