Create Customer - Novacrust API Documentation

Authorizations

authorization

string

header

required

Body

application/json

first_name

string

required

Example:

"John"

last_name

string

required

Example:

"Doe"

string<email>

required

Example:

"[email protected]"

phone_number

string

required

Phone number of the business

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

country

string

required

Example:

"USA"

customer_type

enum<string>

required

Available options:

INDIVIDUAL,

BUSINESS

run_kyc_check

boolean

required

Whether to run KYC verification. Must be true if any of the following fields are provided: address, postalCode, state, city, kyc_metadata.

Example:

true

address

string

Street address. Required when run_kyc_check is true. If provided, run_kyc_check must be true.

Example:

"123 Main St"

postal_code

string

Postal/ZIP code. Required when run_kyc_check is true. If provided, run_kyc_check must be true.

Example:

"12345"

state

string

State/Province. Required when run_kyc_check is true. If provided, run_kyc_check must be true.

Example:

"California"

city

string

City name. Required when run_kyc_check is true. If provided, run_kyc_check must be true.

Example:

"Los Angeles"

kyc_metadata

object

KYC verification metadata. Required when run_kyc_check is true. If provided, run_kyc_check must be true.

Example:

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

Response

Customer created successfully