Customer API

API endpoints for managing customers in your Celar organization.

1. Create Customer

Register a new customer with their KYC information.

curl --request POST \
  --url https://api.sandbox.celar.io/api/v1/customers \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <<your_api_key>>' \
  --data '{
    "email": "customer@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "country": "US"
  }'

Response

{
  "customer_id": "cus_abc123",
  "email": "customer@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "country": "US",
  "status": "pending_verification",
  "created_at": "2024-01-01T00:00:00Z"
}

2. List Customers

curl --request GET \
  --url https://api.sandbox.celar.io/api/v1/customers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <<your_api_key>>'

3. Get Customer

curl --request GET \
  --url https://api.sandbox.celar.io/api/v1/customers/<customer_id> \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <<your_api_key>>'

4. Update Customer

curl --request PATCH \
  --url https://api.sandbox.celar.io/api/v1/customers/<customer_id> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <<your_api_key>>' \
  --data '{
    "first_name": "Jane"
  }'