Create a customer

post

https://harbor-sandbox.owlpay.com/api/v1/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

The type of the customer. Must not be greater than 80 characters.

Allowed:

first_name

string

(type:individual) The first name of the customer. This field is required when type is individual. Must not be greater than 255 characters.

middle_name

string | null

(type:individual) The middle name of the customer. Must not be greater than 255 characters.

last_name

string

(type:individual) The last name of the customer. This field is required when type is individual. Must not be greater than 255 characters.

company_name

string

(type:business) The company name of the customer. This field is required when type is business. Must not be greater than 255 characters.

string

required

The email of the customer. Must be a valid email address.

phone_country_code

string | null

The phone country code of the customer. Must be 2 characters.

phone_number

string | null

The phone number of the customer. Must not be greater than 20 characters.

birth_date

string

(KYC-delegated individual) Date of birth.

description

string | null

The description of the customer (Only application visible). Must not be greater than 500 characters.

agreement_redirect_url

string | null

The URL to redirect after the customer signs the agreement. Must be a valid URL.

incorporation_date

string

(KYC-delegated business) Company incorporation / establishment date.

country

string

(KYC-delegated only) ISO 3166-1 alpha-2 country code. For type:individual represents nationality; for type:business represents registered / incorporation country.

identification_number

string

(KYC-delegated only) For type:individual the personal ID / passport number; for type:business the company registration / tax ID number.

address

object

(KYC-delegated only) Residential (individual) or business address object.

Headers

X-API-KEY

string

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201