> ## Documentation Index
> Fetch the complete documentation index at: https://developers.bumxpress.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create customer

> Create an individual, retail, or business customer.

Create a customer before starting payment flows so quotes, payments, transfers, and webhook events can be reconciled to your internal records.


## OpenAPI

````yaml POST /customers
openapi: 3.0.3
info:
  title: Bumxpress Business Merchant API
  version: 1.0.0
  description: >
    Merchant API for customers, KYC, quotes, payins, payouts, transfers, and
    webhooks.

    All merchant resources are scoped to the merchant attached to the API key.
  license:
    name: Proprietary
    url: https://business.bumxpress.com
servers:
  - url: https://api.business.bumxpress.com
    description: Production
security:
  - ApiKeyAuth: []
    ApiSecretAuth: []
tags:
  - name: Customers
    description: Create and retrieve merchant-scoped customer records.
  - name: Customer KYC
    description: Submit and retrieve customer identity document status.
  - name: Quotes
    description: Create and retrieve pricing and routing quotes.
  - name: Payins
    description: Create and retrieve payment collection resources.
  - name: Payouts
    description: Create and retrieve disbursement resources.
  - name: Transfers
    description: Create, retrieve, and relaunch two-leg transfer resources.
paths:
  /customers:
    post:
      tags:
        - Customers
      summary: Create customer
      description: Create an individual, retail, or business customer.
      operationId: createCustomer
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
            examples:
              individual:
                value:
                  external_ref: your-internal-id-123
                  customer_type: individual
                  first_name: Awa
                  last_name: Ngu
                  id_number: ID123456
                  id_type: national_id
                  email: awa@example.com
                  phone: '+237670000000'
                  country_code: CM
                  nationality_code: CM
                  date_of_birth: '1990-05-15'
                  address_line1: 123 Main Street
                  city: Douala
                  occupation: Engineer
                  source_of_funds: salary
              business:
                value:
                  external_ref: biz-456
                  customer_type: business
                  business_name: Acme SARL
                  email: billing@acme.com
                  phone: '+237670000001'
                  country_code: CM
                  nationality_code: CM
                  address_line1: 45 Avenue Kennedy
                  city: Douala
      responses:
        '201':
          description: Customer created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Unique key for this business intent. Reuse only when retrying the same
        request body.
      schema:
        type: string
      example: payin_2026_06_08_0001
  schemas:
    CreateCustomerRequest:
      type: object
      properties:
        external_ref:
          type: string
          description: Merchant reference, unique per merchant.
        customer_type:
          type: string
          enum:
            - individual
            - retail
            - business
          default: individual
        first_name:
          type: string
        last_name:
          type: string
        business_name:
          type: string
        id_number:
          type: string
        id_type:
          type: string
          enum:
            - national_id
            - passport
            - driver_license
        email:
          type: string
          format: email
        phone:
          type: string
          example: '+237670000000'
        country_code:
          $ref: '#/components/schemas/CountryCode'
        nationality_code:
          $ref: '#/components/schemas/CountryCode'
        date_of_birth:
          type: string
          format: date
        address_line1:
          type: string
        city:
          type: string
        occupation:
          type: string
        source_of_funds:
          type: string
    Customer:
      allOf:
        - $ref: '#/components/schemas/CreateCustomerRequest'
        - type: object
          required:
            - id
            - merchant_id
            - customer_type
            - kyc_status
            - status
            - created_at
            - updated_at
          properties:
            id:
              type: string
              format: uuid
            merchant_id:
              type: string
              format: uuid
            kyc_status:
              type: string
              enum:
                - not_started
                - pending
                - approved
                - rejected
            status:
              type: string
              example: active
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            _meta:
              $ref: '#/components/schemas/IdempotencyMeta'
    CountryCode:
      type: string
      minLength: 2
      maxLength: 2
      example: CM
    IdempotencyMeta:
      type: object
      properties:
        idempotency_key:
          type: string
        idempotency_replayed:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: bad_request
            message:
              type: string
              example: quote_id is required
  responses:
    BadRequest:
      description: >-
        Invalid body, missing field, expired quote, quote mismatch, or
        insufficient balance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid, expired, or inactive API credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: Idempotency conflict or request with same key still processing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Public API key from the merchant dashboard.
    ApiSecretAuth:
      type: apiKey
      in: header
      name: X-Api-Secret
      description: Secret shown once when the API key is created.

````