Create a customer

post

https://sandbox-api.sandbox.boxproc.io/rc/create-customer

Create a new customer

This is how to create customers

Body Params

institution_id

integer

required

Internal identifier of institution.

date_created

string

Format is yyyy-mm-dd.

status

string

enum

required

Defaults to A

A - Active, C - Closed, D - Deleted, I - Inactive, P - Pending, R - Action Required

Allowed:

customer_limit

float

1 to 10000

customer_reference

string

Your reference for this customer.

first_name

string

length ≤ 64

First name of the customer.

last_name

string

length ≤ 64

Last name of the customer.

string

length ≤ 128

A valid email address of the customer.

mobile_phone_number

string

Customer's mobile phone number (excludes leading zero) appended by the country calling code with a leading + sign. Hyphens, spaces or parenthesis in the number are not supported.

address_line1

string

length ≤ 64

Address line 1 (House name or house number).

address_line2

string

length ≤ 64

Address line 2 (Street name and optionally number).

address_line3

string

length ≤ 64

Address line 3 (Locality).

address_line4

string

length ≤ 64

Address line 4.

address_town

string

length ≤ 64

Customer address town.

address_post_code

string

length ≤ 16

Customer address post code.

address_country_code

string

length ≤ 3

ISO 3166 three digit country code.

identification_type

string

enum

N - No Identification, P - Passport, D - Driving license, I - ID card

Allowed:

identification_number

string

The identification value that corresponds to the identification type used. Required for the identification types P, D, I.

Response

200OK