v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Update Person

patch/person/{person_id}

Path parameters

person_idstring required

Request body

name_firststring
name_laststring
name_otherstring
emailstring
phonestring
dobstring date
id_type'passport' | 'drivers_license' | 'national_id' | 'voters_card'
id_countrystring

Use ISO Alpha-2 country codes (e.g., "US" for United States) for accurate processing.

id_numberstring
bank_id_numberstring

Response

200

messagestring
{"stackTrail":"paths:/person/{person_id}:patch:responses:200:content:application/json:schema:properties:meta","oasType":"schema","type":"unknown"}
statusstring

Example response

{
  "data": {
    "id": "9386ba06b2cd11ef97d00edb5e3a61d3",
    "environment": "live",
    "name_first": "caleb ii",
    "name_last": "michael",
    "name_other": "john",
    "email": "1002212@email.com",
    "phone": "2389479284236",
    "dob": "1999-01-16T00:00:00Z",
    "id_level": "primary",
    "id_type": "passport",
    "id_number": "X00190000",
    "id_country": "NG",
    "id_upload": "https://oval-staging.s3.amazonaws.com/kyc/8dbe79d36c1011ed8cc5dacad92d8272/person/fc253ea9bb1f4cd6b497f176ae261960",
    "id_upload_type": "document",
    "bank_id_number": "0000000000",
    "bank_id_type": "bvn",
    "address": {
      "line1": "34 Marka Close",
      "city": "Ikeja",
      "state": "Lagos",
      "country": "NG",
      "postal_code": "100612"
    },
    "status": "active",
    "kyc_status": "verified",
    "kyc_level": "basic",
    "created_at": "2024-12-05T05:55:48Z",
    "updated_at": "2024-12-05T06:08:05Z"
  },
  "message": "Person updated successfully",
  "status": "success"
}