Create Customer

Register a new customer

SecurityoAuth2
Request
Request Body schema: application/json

Customer Info

legalName
required
string <= 255 characters

Legal name of the customer

customerId
string <= 25 characters

Customer id assigned by the user, this is an optional field and if it is provided then it is unique.

customerType
required
string

Type of the customer

Enum: "Corporate" "Consumer"
federalTaxId
string <= 10 characters

Federal Tax ID (upto 10 characters)

required
object (Address)
mailingAddressSameAsLegalAddress
boolean
object (Address)
emailAddress
string <email>

Email address of the customer

phoneNumber
string

Phone number with country code

submittedBy
string

User who submitted the request

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

post/v2/customers
Request samples
application/json
{
  • "legalName": "string",
  • "customerId": "string",
  • "customerType": "Corporate",
  • "federalTaxId": "string",
  • "legalAddress": {
    },
  • "mailingAddressSameAsLegalAddress": true,
  • "mailingAddress": {
    },
  • "emailAddress": "user@example.com",
  • "phoneNumber": "+15551234567",
  • "submittedBy": "string"
}
Response samples
application/json
{
  • "customerUID": "string",
  • "legalName": "string",
  • "customerId": "string",
  • "customerType": "Corporate",
  • "federalTaxId": "string",
  • "legalAddress": {
    },
  • "mailingAddress": {
    },
  • "mailingAddressSameAsLegalAddress": true,
  • "emailAddress": "user@example.com",
  • "phoneNumber": "string",
  • "kycStatus": "Approved",
  • "status": "Active",
  • "createdOn": "11/13/2025 12:45:10",
  • "lastUpdatedOn": "11/13/2025 12:45:10",
  • "submittedBy": "string"
}