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

# Create a customer

> Creates an individual or business customer under the current tenant account.

## What this endpoint does

Creates an individual or business customer under the current tenant account.

## When to use it

Create the customer before issuing verification or customer-owned payment routes.

## Before you call

Use a secret API key with customer write access and supply a stable external reference or identity fields required by the request schema.

## Money and balance effect

This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.

## States and completion

Creation does not approve the customer. Verification and entitlements progress asynchronously.

## Safe retries

Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.

Read [Customers](/console/customers) for the complete workflow.


## OpenAPI

````yaml /api-reference/openapi.json post /v1/customers
openapi: 3.0.0
info:
  title: Wayex API
  description: >-
    Wayex APIs for direct customer payment routes and isolated, prefunded
    Treasury accounts. Each API key is bound to one tenant account and its own
    wallet, settings, webhooks, and reporting.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.sandbox.wayex.com
    description: Sandbox integration environment
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Treasury
    description: >-
      Prefunded AUD and stablecoin wallets for one isolated tenant account.
      Fund, pay, convert, withdraw, track, and reconcile without selecting
      another account.
  - name: Customers
    description: >-
      Onboard end customers, run verification, and manage each customer's
      entitlements.
  - name: Payment routes
    description: >-
      Standing deposit instructions per customer. When a customer funds a route,
      Wayex auto-converts at the live rate and pays out/sends — no quote, no
      lock.
  - name: Transfers
    description: >-
      Read the conversion records produced when customers fund payment routes —
      the live activity feed and per-conversion lifecycle timeline.
  - name: Rates
    description: >-
      The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex
      quotes. Indicative only; the binding price is struck when a route's funds
      land.
  - name: Revenue
    description: Your developer-fee revenue over time.
  - name: Invoices
    description: >-
      Your monthly invoices — Wayex platform fees due, net of your accrued
      developer-fee credit.
  - name: Webhooks
    description: Subscribe to HMAC-signed event webhooks and inspect deliveries.
  - name: API keys
    description: Create, list, and rotate API keys for programmatic access.
  - name: Fees
    description: >-
      Configure your developer fee — the markup withheld from each conversion
      and credited against your monthly invoice.
  - name: Invitations
    description: Accept a team invitation and activate your account.
paths:
  /v1/customers:
    post:
      tags:
        - Customers
      summary: Create a customer
      description: >-
        Creates an individual or business customer under the current tenant
        account. Create the customer before issuing verification or
        customer-owned payment routes.
      operationId: CustomerController2_create_v1
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            A unique key for this logical action. Reuse the same key and
            identical payload when retrying after an unknown response.
          schema:
            type: string
            minLength: 8
            maxLength: 255
          example: 13bda8d7-87bd-4fa4-b7d5-e740725f9bd2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - business
                    externalCustomerId:
                      type: string
                      minLength: 1
                    contact:
                      type: object
                      properties:
                        email:
                          description: The customer's contact email address.
                          type: string
                          format: email
                        name:
                          description: Optional display name for the customer.
                          type: string
                          minLength: 1
                      required:
                        - email
                    businessDetails:
                      type: object
                      properties:
                        companyName:
                          type: string
                          minLength: 1
                        registrationNumber:
                          type: string
                          minLength: 1
                        country:
                          type: string
                          minLength: 1
                      required:
                        - companyName
                        - registrationNumber
                        - country
                    requestedEntitlements:
                      type: array
                      items:
                        type: string
                        enum:
                          - aud_onramp
                          - aud_offramp
                          - payment_route
                          - higher_limits
                      default:
                        - payment_route
                        - aud_onramp
                        - aud_offramp
                    metadata:
                      type: object
                      additionalProperties:
                        type: string
                  required:
                    - type
                    - contact
                    - businessDetails
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - individual
                    externalCustomerId:
                      type: string
                      minLength: 1
                    contact:
                      type: object
                      properties:
                        email:
                          description: The customer's contact email address.
                          type: string
                          format: email
                        name:
                          description: Optional display name for the customer.
                          type: string
                          minLength: 1
                      required:
                        - email
                    individualDetails:
                      type: object
                      properties:
                        firstName:
                          type: string
                          minLength: 1
                        lastName:
                          type: string
                          minLength: 1
                        dob:
                          type: string
                          minLength: 1
                        nationality:
                          type: string
                          minLength: 1
                        country:
                          type: string
                          minLength: 1
                      required:
                        - firstName
                        - lastName
                        - dob
                        - nationality
                        - country
                    requestedEntitlements:
                      type: array
                      items:
                        type: string
                        enum:
                          - aud_onramp
                          - aud_offramp
                          - payment_route
                          - higher_limits
                      default:
                        - payment_route
                        - aud_onramp
                        - aud_offramp
                    metadata:
                      type: object
                      additionalProperties:
                        type: string
                  required:
                    - type
                    - contact
                - type: object
                  properties:
                    email:
                      description: >-
                        The customer's email. Minimal onboarding: the customer
                        self-completes verification.
                      type: string
                      format: email
                    externalCustomerId:
                      description: >-
                        Your own identifier for this customer, echoed back for
                        cross-referencing.
                      type: string
                      minLength: 1
                    name:
                      description: Optional display name for the customer.
                      type: string
                      minLength: 1
                    requestedEntitlements:
                      description: >-
                        Capabilities to request; granted only once verification
                        is approved.
                      type: array
                      items:
                        type: string
                        enum:
                          - aud_onramp
                          - aud_offramp
                          - payment_route
                          - higher_limits
                      default:
                        - payment_route
                        - aud_onramp
                        - aud_offramp
                    metadata:
                      type: object
                      additionalProperties:
                        type: string
                  required:
                    - email
      responses:
        '201':
          description: The created customer.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: Unique Wayex identifier for this customer.
                    type: string
                    minLength: 1
                  counterpartyId:
                    description: >-
                      The client account (counterparty) this customer belongs
                      to. For API callers this is always your own account id.
                    type: string
                    minLength: 1
                  externalCustomerId:
                    description: >-
                      Your own identifier for this customer, echoed back for
                      cross-referencing.
                    type: string
                    minLength: 1
                  type:
                    description: >-
                      Whether the customer is an individual (natural person) or
                      a business (legal entity).
                    type: string
                    enum:
                      - individual
                      - business
                  contact:
                    type: object
                    properties:
                      email:
                        description: The customer's contact email address.
                        type: string
                        format: email
                      name:
                        description: Optional display name for the customer.
                        type: string
                        minLength: 1
                    required:
                      - email
                  businessDetails:
                    type: object
                    properties:
                      companyName:
                        type: string
                        minLength: 1
                      registrationNumber:
                        type: string
                        minLength: 1
                      country:
                        type: string
                        minLength: 1
                    required:
                      - companyName
                      - registrationNumber
                      - country
                  individualDetails:
                    type: object
                    properties:
                      firstName:
                        type: string
                        minLength: 1
                      lastName:
                        type: string
                        minLength: 1
                      dob:
                        type: string
                        minLength: 1
                      nationality:
                        type: string
                        minLength: 1
                      country:
                        type: string
                        minLength: 1
                    required:
                      - firstName
                      - lastName
                      - dob
                      - nationality
                      - country
                  verificationStatus:
                    description: >-
                      Current verification state. Value can only move on the
                      customer's behalf once approved.
                    type: string
                    enum:
                      - in_progress
                      - approved
                      - rejected
                      - requires_action
                  entitlements:
                    description: >-
                      The capabilities this customer is cleared for, granted as
                      verification completes.
                    type: array
                    items:
                      type: object
                      properties:
                        entitlement:
                          type: string
                          enum:
                            - aud_onramp
                            - aud_offramp
                            - payment_route
                            - higher_limits
                        status:
                          type: string
                          enum:
                            - in_progress
                            - approved
                            - rejected
                            - requires_action
                      required:
                        - entitlement
                        - status
                  metadata:
                    type: object
                    additionalProperties:
                      type: string
                  createdAt:
                    description: When the customer was created (ISO 8601).
                    type: string
                    format: date-time
                required:
                  - id
                  - counterpartyId
                  - type
                  - contact
                  - verificationStatus
                  - entitlements
                  - createdAt
        '400':
          description: Validation failed (unknown or malformed fields).
        '401':
          description: Missing or invalid API key.
        '409':
          description: Idempotency-Key reused with a different request body.
      security:
        - Bearer: []
        - ApiKey: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Wayex API key
      description: 'Send the same Wayex API key as `Authorization: Bearer <key>`.'
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: A Wayex API key. Use a secret key for write operations.

````