v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Create Person

post/person

Request body

name_firststring required

name_laststring required

name_otherstring required

phonestring required

Kindly provide the full phone number complete with the country prefix e.g. +11234567890

emailstring required

dobstring date required

Date format should be YYYY-MM-DD

id_type'passport' | 'drivers_license' | 'national_id' | 'voters_card'

id_numberstring

Document number of either an International Passport, SSN, Drivers License, NIN, or Voters Card depending on the ID level of this individual

id_countrystring required

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

bank_id_numberstring

BVN for Nigerian ID holders

kyc_level'preliminary' | 'basic'

Response

201

messagestring

{"stackTrail":"paths:/person:post:responses:201:content:application/json:schema:properties:meta","oasType":"schema","type":"unknown"}

statusstring

Example response

{
  "data": {
    "id": "f5eb5e3ab39f11ed97c982e65b002663",
    "name_first": "takeshi",
    "name_last": "kovacs",
    "name_other": "lev",
    "email": "takesi@carbon.io",
    "phone": "2348024056288",
    "dob": "1989-01-16T00:00:00Z",
    "id_level": "secondary",
    "id_type": "nin",
    "id_number": "98374273242",
    "id_country": "NG",
    "id_upload_type": "document",
    "id_upload": "https://res.cloudinary.com/rapidpay-africa/image/upload/v1682887473/sandbox/DRIVERS_LICENSE_dpf491.png",
    "address_line1": "34 Marka Close",
    "address_city": "Sasche",
    "address_state": "Texas",
    "address_country": "US",
    "status": "active",
    "kyc_status": "verified",
    "kyc_level": "basic",
    "created_at": "2023-02-23T17:31:52Z",
    "updated_at": "2023-02-23T17:31:52Z"
  },
  "message": "Person created successfully",
  "status": "success"
}