Skip to main content
POST
/
api
/
customers
/
create
Create Customer
curl --request POST \
  --url http://127.0.0.1:8083/api/customers/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "partner_customer_id": "<string>",
  "business_details": {
    "business_name_english": "<string>",
    "website": "https://www.example.com",
    "business_identifier_number": "<string>",
    "business_identifier_country_code": "US",
    "business_identifier_document_list": [
      "<string>"
    ],
    "business_name": "<string>",
    "business_identifier_start_date": "2023-11-07T05:31:56Z",
    "business_identifier_expiry_date": "2023-11-07T05:31:56Z"
  },
  "registration_address": {
    "registration_address_line1": "<string>",
    "registration_address_city": "<string>",
    "registration_address_state": "<string>",
    "registration_address_postcode": "<string>",
    "registration_address_country_code": "US"
  },
  "account_usage": {
    "operating_country": "US",
    "goods_service_description": "<string>",
    "industry_category_code": "<string>",
    "estimated_monthly_revenue_currency": "USD",
    "estimated_monthly_revenue_amount": 99.99
  },
  "primary_contact": {
    "contact_phone": "+8613800138000",
    "contact_email": "service@gemini.com"
  },
  "business_person_list": [
    {
      "basic_info": {
        "first_name_english": "<string>",
        "last_name_english": "<string>",
        "birth_date": "2023-11-07T05:31:56Z",
        "nationality": "US",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "residential_address": {
        "residential_address_line1": "<string>",
        "residential_address_city": "<string>",
        "residential_address_postcode": "<string>",
        "residential_address_country_code": "US",
        "residential_address_state": "<string>"
      },
      "identification": {
        "id_number": "<string>",
        "id_issuing_country_code": "US",
        "id_expiration_date": "2023-11-07T05:31:56Z",
        "id_issue_date": "2023-11-07T05:31:56Z",
        "id_document_front_file_id": "<string>",
        "id_document_back_file_id": "<string>"
      }
    }
  ]
}
'
{
  "partner_customer_id": "<string>",
  "business_details": {
    "business_name_english": "<string>",
    "website": "https://www.example.com",
    "business_identifier_number": "<string>",
    "business_identifier_country_code": "US",
    "business_identifier_document_list": [
      "<string>"
    ],
    "business_name": "<string>",
    "business_identifier_start_date": "2023-11-07T05:31:56Z",
    "business_identifier_expiry_date": "2023-11-07T05:31:56Z"
  },
  "registration_address": {
    "registration_address_line1": "<string>",
    "registration_address_city": "<string>",
    "registration_address_state": "<string>",
    "registration_address_postcode": "<string>",
    "registration_address_country_code": "US"
  },
  "customer_id": "cus_79fb361a05074629bf1ecf0d14cd244e",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "account_usage": {
    "operating_country": "US",
    "goods_service_description": "<string>",
    "industry_category_code": "<string>",
    "estimated_monthly_revenue_currency": "USD",
    "estimated_monthly_revenue_amount": 99.99
  },
  "primary_contact": {
    "contact_phone": "+8613800138000",
    "contact_email": "service@gemini.com"
  },
  "business_person_list": [
    {
      "basic_info": {
        "first_name_english": "<string>",
        "last_name_english": "<string>",
        "birth_date": "2023-11-07T05:31:56Z",
        "nationality": "US",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "residential_address": {
        "residential_address_line1": "<string>",
        "residential_address_city": "<string>",
        "residential_address_postcode": "<string>",
        "residential_address_country_code": "US",
        "residential_address_state": "<string>"
      },
      "identification": {
        "id_number": "<string>",
        "id_issuing_country_code": "US",
        "id_expiration_date": "2023-11-07T05:31:56Z",
        "id_issue_date": "2023-11-07T05:31:56Z",
        "id_document_front_file_id": "<string>",
        "id_document_back_file_id": "<string>"
      }
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Body

application/json

Add Customer Request Vocabulary

​
partner_customer_id
string
required

Partner Assigned Customer ID

Required string length: 20 - 64
​
business_details
object
required

Company Details Section

​
registration_address
object
required

Registration Address Section

​
account_usage
object

Business Details Section

​
primary_contact
object

Primary Contact Section

​
business_person_list
object[]

List of Legal Representatives

Response

Operation Successful

Customer Details Response Information

​
partner_customer_id
string
required

Partner Assigned Customer ID

Required string length: 20 - 64
​
business_details
object
required

Company Details Section

​
registration_address
object
required

Registration Address Section

​
customer_id
string

Unique Customer ID

Example:

"cus_79fb361a05074629bf1ecf0d14cd244e"

​
status
enum<string>

Customer status

Available options:
pending,
active,
rejected,
suspended
Example:

"active"

​
created_at
string<date-time>

Customer created time

​
account_usage
object

Business Details Section

​
primary_contact
object

Primary Contact Section

​
business_person_list
object[]

List of Legal Representatives