Add a customer

Create a new customer record.

POST/v1/customers

Headers

Required for POST requests. Reuse only for an identical retry.

Request Body

Request Examples

{
"first_name": "john",
"middle_name": "william",
"last_name": "doe",
"email": "john.doe@example.com",
"phone": "+15555550101",
"type": "individual",
"gender": "male",
"date_of_birth": "1990-04-16",
"external_id": "individual_12345",
"address": {
"address_line1": "1800 N Pole St",
"address_line2": "Suite 202",
"city": "Orlando",
"postal_code": "32801",
"state": "US-FL",
"country": "US"
}
}

{
"type": "business",
"email": "contact@acmecorp.com",
"phone": "+12025550173",
"business_name": "Acme Corporation",
"business_description": "Technology and software development",
"business_type": "private_limited",
"business_industry": "Technology",
"registration_number": "RC-987654",
"external_id": "BUS-67890",
"address": {
"address_line1": "1800 N Pole St",
"address_line2": "Suite 202",
"city": "Orlando",
"postal_code": "32801",
"state": "US-FL",
"country": "US"
},
"associated_persons": [
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@acmecorp.com",
  "date_of_birth": "1990-06-15",
  "gender": "female",
  "phone": "+15555550102",
  "address": {
    "address_line1": "1800 N Pole St",
    "address_line2": "Suite 202",
    "city": "Orlando",
    "postal_code": "32801",
    "state": "US-FL",
    "country": "US"
  }
}
]
}

Responses

Status	Description
`200`	Customer created successfully
`400`	Bad request — invalid or missing parameters

200 response

Full customer object returned by create and get endpoints.

Possible values: individual, business

Possible values: male, female, other

{
"data": {
"id": "e59daa17-20ed-4727-833c-e1c633782cc8",
"first_name": "Jane",
"last_name": "Doe",
"middle_name": "A.",
"type": "individual",
"email": "jane@example.com",
"phone": "+15555550101",
"address": {
  "address_line1": "1800 N Pole St",
  "address_line2": "Suite 202",
  "city": "Orlando",
  "postal_code": "32801",
  "state": "US-FL",
  "country": "US"
},
"status": "active",
"kyc": [],
"associated_persons": [],
"date_added": "2024-01-15T10:30:00Z",
"external_id": "individual_12345",
"industry_code": ""
},
"error": null
}

400 response

{
"data": null,
"error": "invalid request body"
}

Authorization

ApiKeyAuth

Was this page helpful?