curl --request PATCH \ --url http://localhost:3050/api/v1/business/open/customer/{uuid} \ --header 'Content-Type: application/json' \ --header 'authorization: <api-key>' \ --data ' { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone_number": "+1234567890", "country": "USA", "customer_type": "INDIVIDUAL", "run_kyc_check": true, "address": "123 Main St", "postal_code": "12345", "state": "California", "city": "Los Angeles", "kyc_metadata": { "id_type": "NIGERIAN_BVN_VERIFICATION", "bvn": "22222222222222", "selfie_image": "https://image.com" } } '

Customer

Update Customer

Updates an existing customer with optional KYC verification.

KYC Validation Rules:

If run_kyc_check is true, the following fields are required: address, postal_code, state, city, kyc_metadata
If any of these fields (address, postal_code, state, city, kyc_metadata) are provided, run_kyc_check must be set to true
If run_kyc_check is false, none of the KYC fields should be provided
All fields are optional; only provide the fields you want to update

PATCH

/

api

/

v1

/

business

/

open

/

customer

/

{uuid}

curl --request PATCH \ --url http://localhost:3050/api/v1/business/open/customer/{uuid} \ --header 'Content-Type: application/json' \ --header 'authorization: <api-key>' \ --data ' { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone_number": "+1234567890", "country": "USA", "customer_type": "INDIVIDUAL", "run_kyc_check": true, "address": "123 Main St", "postal_code": "12345", "state": "California", "city": "Los Angeles", "kyc_metadata": { "id_type": "NIGERIAN_BVN_VERIFICATION", "bvn": "22222222222222", "selfie_image": "https://image.com" } } '

Authorizations

authorization

string

header

required

Path Parameters

uuid

string

required

Body

application/json

first_name

string

Example:

"John"

last_name

string

Example:

"Doe"

email

string<email>

Example:

"[email protected]"

phone_number

string

Phone number of the business

Pattern: /^\+?[1-9]\d{1,14}$/

country

string

Example:

"USA"

address

string

Street address. Required when run_kyc_check is true.

Example:

"123 Main St"

postal_code

string

Postal/ZIP code. Required when run_kyc_check is true.

Example:

"12345"

customer_type

enum<string>

Available options:

INDIVIDUAL,

BUSINESS

state

string

State/Province. Required when run_kyc_check is true.

Example:

"California"

city

string

City name. Required when run_kyc_check is true.

Example:

"Los Angeles"

kyc_metadata

object

KYC verification metadata. Required when run_kyc_check is true.

Example:

{
  "id_type": "NIGERIAN_BVN_VERIFICATION",
  "bvn": "22222222222222",
  "selfie_image": "https://image.com"
}

run_kyc_check

boolean

Whether to run KYC verification.

Example:

true

Response

Customer updated successfully