Coinbax Core API

Workspace Customers

Customer management within workspaces

View as Markdown

List workspace customers

GET/workspaces/{id}/customersBearer token

Retrieve a paginated list of customers belonging to a specific workspace. **Permissions:** ADMIN or SUPER_ADMIN only

Path parameters

idstring (uuid)required
Workspace UUID

Query parameters

pageinteger
Page number (1-indexed)
limitinteger
Items per page
statusenum
Filter by customer status
"active" · "inactive" · "suspended" · "pending"
searchstring
Search by name or email

Responses

200Customers list retrieved successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataarray of Customer
  array of Customer
  idstring (uuid)required
  Customer unique identifier
  workspaceIdstring (uuid)required
  Associated workspace ID
  externalIdstring
  External identifier from your system
  emailstring (email)
  Customer's email address
  firstNamestring
  Customer's first name
  lastNamestring
  Customer's last name
  phoneNumberstring
  Customer's phone number
  dateOfBirthstring (date)
  Customer's date of birth
  addressstring
  Customer's street address
  citystring
  Customer's city
  statestring
  Customer's state/province
  postalCodestring
  Customer's postal code
  countrystring
  Customer's country
  statusenumrequired"active" · "inactive" · "suspended" · "pending"
  Customer status
  walletAddressstring
  Customer's blockchain wallet address
  emailVerifiedboolean
  Whether email is verified
  metadataobject
  Custom metadata
  object
  Custom metadata
  createdAtstring (date-time)required
  Customer creation timestamp
  updatedAtstring (date-time)required
  Last update timestamp
- metaobject
  Meta
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
  object
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "createdAt": "2026-01-20T08:30:00.000Z",
      "updatedAt": "2026-02-15T16:45:00.000Z"
    }
  ],
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5
    }
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

403Forbidden - insufficient permissions

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource",
    "statusCode": 403
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

404Resource not found

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "statusCode": 404
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Create customer in workspace

POST/workspaces/{id}/customersBearer token

Create a new customer within a specific workspace. **Permissions:** ADMIN or SUPER_ADMIN only

Path parameters

idstring (uuid)required
Workspace UUID

Request body

emailstring (email)required
firstNamestringrequired
lastNamestringrequired
phoneNumberstring
addressstring
citystring
statestring
postalCodestring
countrystring
metadataobject
object

Responses

201Customer created successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomer
  idstring (uuid)required
  Customer unique identifier
  workspaceIdstring (uuid)required
  Associated workspace ID
  externalIdstring
  External identifier from your system
  emailstring (email)
  Customer's email address
  firstNamestring
  Customer's first name
  lastNamestring
  Customer's last name
  phoneNumberstring
  Customer's phone number
  dateOfBirthstring (date)
  Customer's date of birth
  addressstring
  Customer's street address
  citystring
  Customer's city
  statestring
  Customer's state/province
  postalCodestring
  Customer's postal code
  countrystring
  Customer's country
  statusenumrequired"active" · "inactive" · "suspended" · "pending"
  Customer status
  walletAddressstring
  Customer's blockchain wallet address
  emailVerifiedboolean
  Whether email is verified
  metadataobject
  Custom metadata
  object
  Custom metadata
  createdAtstring (date-time)required
  Customer creation timestamp
  updatedAtstring (date-time)required
  Last update timestamp

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "createdAt": "2026-02-24T12:00:00.000Z",
    "updatedAt": "2026-02-24T12:00:00.000Z"
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

403Forbidden - insufficient permissions

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource",
    "statusCode": 403
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

404Resource not found

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "statusCode": 404
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1-555-123-4567",
  "address": "123 Main St",
  "city": "San Francisco",
  "state": "CA",
  "postalCode": "94102",
  "country": "USA",
  "metadata": {}
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumber": "+1-555-123-4567",
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "USA",
    "metadata": {}
  }),
});
const result = await response.json();

Register customer

POST/workspaces/{id}/customers/auth/registerPublic

Path parameters

idstringrequired
Workspace ID or slug

Request body

emailstring (email)required
passwordstringrequired
firstNamestring
lastNamestring

Responses

201Customer registered successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomerAuthResponse
  customerobject
  idstring (uuid)
  emailstring (email)
  firstNamestring
  lastNamestring
  walletAddressstring
  statusenum"pending" · "active" · "suspended"
  accessTokenstring
  JWT access token
  refreshTokenstring
  JWT refresh token
  expiresIninteger
  Token expiration in seconds

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "customer": {
      "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
      "email": "developer@example.com",
      "firstName": "string",
      "lastName": "string",
      "walletAddress": "string",
      "status": "pending"
    },
    "accessToken": "string",
    "refreshToken": "string",
    "expiresIn": 100
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

409Conflict - resource already exists or state conflict

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "CONFLICT",
    "message": "Resource already exists",
    "statusCode": 409
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/register \
  -H "Content-Type: application/json" \
  -d '{
  "email": "customer@example.com",
  "password": "securePassword123",
  "firstName": "John",
  "lastName": "Doe"
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "customer@example.com",
    "password": "securePassword123",
    "firstName": "John",
    "lastName": "Doe"
  }),
});
const result = await response.json();

Login customer

POST/workspaces/{id}/customers/auth/loginPublic

Authenticate a customer and receive access tokens. **Authentication:** Public endpoint (no auth required)

Path parameters

idstringrequired
Workspace ID or slug

Request body

emailstring (email)required
passwordstringrequired

Responses

200Customer logged in successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomerAuthResponse
  customerobject
  idstring (uuid)
  emailstring (email)
  firstNamestring
  lastNamestring
  walletAddressstring
  statusenum"pending" · "active" · "suspended"
  accessTokenstring
  JWT access token
  refreshTokenstring
  JWT refresh token
  expiresIninteger
  Token expiration in seconds

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "customer": {
      "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
      "email": "developer@example.com",
      "firstName": "string",
      "lastName": "string",
      "walletAddress": "string",
      "status": "pending"
    },
    "accessToken": "string",
    "refreshToken": "string",
    "expiresIn": 100
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/login \
  -H "Content-Type: application/json" \
  -d '{
  "email": "customer@example.com",
  "password": "securePassword123"
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/login', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "customer@example.com",
    "password": "securePassword123"
  }),
});
const result = await response.json();

Get current customer

GET/workspaces/{id}/customers/auth/meBearer token

Get the current authenticated customer's profile. **Requires:** Customer authentication (workspace-specific JWT)

Path parameters

idstringrequired
Workspace ID or slug

Responses

200Customer profile retrieved successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomerProfile
  idstring (uuid)
  emailstring (email)
  firstNamestring
  lastNamestring
  walletAddressstring
  walletLinkedAtstring (date-time)
  emailVerifiedboolean
  statusenum"pending" · "active" · "suspended"

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "email": "developer@example.com",
    "firstName": "string",
    "lastName": "string",
    "walletAddress": "string",
    "walletLinkedAt": "2026-01-15T12:00:00.000Z",
    "emailVerified": true,
    "status": "pending"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

403Forbidden - insufficient permissions

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource",
    "statusCode": 403
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/me', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Refresh customer token

POST/workspaces/{id}/customers/auth/refreshPublic

Refresh an expired access token using a refresh token. **Authentication:** Public endpoint (no auth required)

Path parameters

idstringrequired
Workspace ID or slug

Request body

refreshTokenstringrequired

Responses

200Token refreshed successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomerAuthResponse
  customerobject
  idstring (uuid)
  emailstring (email)
  firstNamestring
  lastNamestring
  walletAddressstring
  statusenum"pending" · "active" · "suspended"
  accessTokenstring
  JWT access token
  refreshTokenstring
  JWT refresh token
  expiresIninteger
  Token expiration in seconds

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "customer": {
      "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
      "email": "developer@example.com",
      "firstName": "string",
      "lastName": "string",
      "walletAddress": "string",
      "status": "pending"
    },
    "accessToken": "string",
    "refreshToken": "string",
    "expiresIn": 100
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{
  "refreshToken": "string"
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/refresh', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "refreshToken": "string"
  }),
});
const result = await response.json();

Link wallet to customer

POST/workspaces/{id}/customers/auth/link-walletBearer token

Link an external wallet address to the customer account. Requires signature verification to prove wallet ownership. **Requires:** Customer authentication (workspace-specific JWT)

Path parameters

idstringrequired
Workspace ID or slug

Request body

walletAddressstringrequired
Ethereum wallet address
signaturestringrequired
Signed message proving wallet ownership
messagestringrequired
Original message that was signed

Responses

200Wallet linked successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataCustomerProfile
  idstring (uuid)
  emailstring (email)
  firstNamestring
  lastNamestring
  walletAddressstring
  walletLinkedAtstring (date-time)
  emailVerifiedboolean
  statusenum"pending" · "active" · "suspended"

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "email": "developer@example.com",
    "firstName": "string",
    "lastName": "string",
    "walletAddress": "string",
    "walletLinkedAt": "2026-01-15T12:00:00.000Z",
    "emailVerified": true,
    "status": "pending"
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/link-wallet \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "signature": "0x...",
  "message": "Link wallet to Coinbax: 1234567890"
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/link-wallet', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "signature": "0x...",
    "message": "Link wallet to Coinbax: 1234567890"
  }),
});
const result = await response.json();

Get customer wallet

GET/workspaces/{id}/customers/auth/walletBearer token

Get the linked wallet address for the current customer. **Requires:** Customer authentication (workspace-specific JWT)

Path parameters

idstringrequired
Workspace ID or slug

Responses

200Wallet information retrieved successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataobject
  walletAddressstring
  walletLinkedAtstring (date-time)

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "walletAddress": "string",
    "walletLinkedAt": "2026-01-15T12:00:00.000Z"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/wallet \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/customers/auth/wallet', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();