Skip to main content
POST
/
v1
/
customers
Create customer
curl --request POST \
  --url https://api.platnova.com/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "+23490123456789",
  "country_code": "NG",
  "date_of_birth": "1970-12-28",
  "country": "Nigeria",
  "document": {
    "id_type": "NATIONAL_ID",
    "id_number": "1096277890",
    "front_doc": "",
    "back_doc": ""
  },
  "address": {
    "street": "12 Lekki Lane",
    "city": "Lekki",
    "state": "Lagos",
    "postal_code": "200123",
    "country": "Nigeria",
    "document_url": "http://example.com"
  }
}
'
{
  "status": true,
  "data": {
    "id": "3be6624b-81a4-40d9-bfa9-c4dd8e4f7c18",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "90123456789",
    "country_code": "NGA",
    "status": "APPROVAL_PENDING"
  },
  "error": [],
  "message": "operation was successful"
}

Overview

Create a new individual customer profile. This endpoint allows you to onboard customers with necessary identification details, address information, and KYC (Know Your Customer) compliance data. The response confirms successful creation or returns relevant validation errors.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Body

application/json
first_name
string

Customer first name

last_name
string

Customer last name

email
string<email>

Customer email

phone
string

Customer phone number

country_code
string

ISO country code

date_of_birth
string<date>

Date of birth (YYYY-MM-DD)

country
string

Country name

document
object
address
object

Response

Customer created successfully

status
boolean
data
object
error
any[]
message
string