---
title: "Create a Customer"
method: POST
path: "/v1/customers"
tags: ["Customers"]
---

# Create a Customer

`POST /v1/customers`

## Request

- Base URL: `//mapi.boomfi.xyz` (relative, and the document’s source URL is not known)
- URL: `//mapi.boomfi.xyz/v1/customers`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/boomfi/apis/boomfi-merchants-api/docs/v1/customers/post.ts> (a function with typed inputs; its response is checked against the schema)

The **Create a Customer** endpoint allows you to create a new customer record within your organization. This endpoint requires a payload that includes key details about the customer, such as their email and wallet address.

> 📘 Note
> 
> If a customer makes a payment without being pre-registered, the system automatically creates a customer record during the checkout process.

## Request body

- CustomersCreateCustomerRequest
  - `customer_ident` string: Unique identifier for a customer.
  - `discord` string: Discord username or identifier associated with a customer, allowing for communication and linkage to Discord-based interactions.
  - `email` string, required: Customer's email address.
  - `name` string: Customer's name.
  - `number` string: Numeric identifier or contact number associated with the customer.
  - `twitter` string: Twitter handle associated with the customer.
  - `wallet_address` string: Unique address associated with a customer's wallet.

## Response `200`

OK

- CustomersResponseCustomer
  - `created_at` string: The timestamp indicating when the customer record was created.
  - `customer_ident` string: The unique identifier for the customer.
  - `email` string: The email address associated with the customer.
  - `guest` boolean: Indicates whether the customer is a guest (true) or not (false).
  - `id` string: The unique identifier for the customer.
  - `is_deleted` boolean: Indicates whether the customer has been deleted (true) or not (false).
  - `last_payment_date` string: The timestamp indicating the date of the last payment made by the customer.
  - `metadata` object: Additional metadata associated with the customer.
  - `name` string: The name of the customer.
  - `organisation_id` string: The identifier of the organization to which the customer belongs.
  - `payments_count` integer: The total count of payments made by the customer.
  - `phone` string: The phone number associated with the customer.
  - `properties` object: Additional custom properties associated with the customer.
  - `updated_at` string: The timestamp indicating when the customer record was last updated.
  - `wallet_address` string: The wallet address associated with the customer for cryptocurrency transactions.

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/boomfi/apis/boomfi-merchants-api.md) - [All operations](https://skmtc.dev/boomfi/apis/boomfi-merchants-api/llms.txt) - [OpenAPI document](https://skmtc.dev/boomfi/apis/boomfi-merchants-api/revisions/ace3c3df05fe?raw)