Create Customer

Create a new customer

post

Header parameters

AuthorizationstringRequired

Token for authentication

Body

application/json

emailstring · emailRequired

The unique email address of the customer

first_namestringOptional

The first name of the customer (required for individual customers)

last_namestringOptional

The last name of the customer (required for individual customers)

company_namestringOptional

The name of the company (required for corporate customers)

beneficiary_typestring · enumRequired

The type of beneficiary

Possible values:

Responses

200

Successful retrieval of liquidation address

application/json

post

HTTPcURLJavaScriptPython

POST /v0/customers HTTP/1.1
Host: api.alignlabs.dev
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "beneficiary_type": "individual"
}

200

Successful retrieval of liquidation address

{
  "customer_id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "company_name": "text",
  "first_name": "text",
  "last_name": "text",
  "address": {
    "country": "United States",
    "city": "San Francisco",
    "street_line_1": "123 Main Street",
    "postal_code": "94105",
    "state": "CA"
  },
  "kycs": {
    "status": "pending",
    "status_breakdown": [
      {
        "currency": "aed",
        "payment_rails": "uaefts",
        "status": "pending"
      }
    ],
    "sub_status": "kyc_form_submission_started",
    "kyc_flow_link": "text"
  }
}