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

# Create beneficiary

> This endpoint allows you to create a beneficiary.



## OpenAPI

````yaml openapi.json post /beneficiary
openapi: 3.0.3
info:
  title: Bread API
  description: >-
    The Bread provides comprehensive cryptocurrency wallet management
    capabilities including wallet creation, balance monitoring, and asset
    transfers.
  version: 2.0.0
servers:
  - url: https://processor-prod.up.railway.app
    description: Production server
security: []
paths:
  /beneficiary:
    post:
      tags:
        - Beneficiary
      summary: Create beneficiary
      description: This endpoint allows you to create a beneficiary.
      operationId: createBeneficiary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBeneficiaryRequest'
      responses:
        '201':
          description: Beneficiary created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBeneficiaryResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CreateBeneficiaryRequest:
      type: object
      required:
        - currency
        - identity_id
        - details
      properties:
        currency:
          type: string
          enum:
            - NGN
          description: The currency code for the beneficiary
          example: ngn
        identity_id:
          type: string
          description: The identity ID associated with this beneficiary
          example: 68bf2de7196a18d7bd165ffb
        details:
          oneOf:
            - $ref: '#/components/schemas/NigeriaDetails'
            - $ref: '#/components/schemas/CrossBorderDetails'
          description: Banking details based country
    CreateBeneficiaryResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        status:
          type: integer
          example: 201
        message:
          type: string
          example: Beneficiary created successfully
        timestamp:
          type: string
          format: date-time
          example: '2025-09-08T20:40:35.538Z'
        data:
          type: object
          properties:
            id:
              type: string
              example: 68bf2eba196a18d7bd166184
    NigeriaDetails:
      type: object
      title: Nigerian Bank Account
      required:
        - bank_code
        - account_number
      properties:
        bank_code:
          type: string
          description: Nigerian bank code
          example: '100004'
        account_number:
          type: string
          description: Account number
          example: '1234567890'
      additionalProperties: false
    CrossBorderDetails:
      type: object
      title: Other Bank Account
      properties:
        bank_address:
          $ref: '#/components/schemas/BankAddress'
        bank_name:
          type: string
          description: Name of the bank
          example: Chase Bank
        account_name:
          type: string
          description: Account holder's name
          example: John Doe
        account_number:
          type: string
          description: Account number
          example: '1234567890'
        routing_number:
          type: string
          description: Routing number (USA Only)
        transit_number:
          type: string
          description: Transit number (Canada Only)
        ifsc_code:
          type: string
          description: IFSC code (India Only)
        sort_code:
          type: string
          description: Sort code (UK Only)
        bsb_number:
          type: string
          description: BSB number (Australia Only)
        ncc_number:
          type: string
          description: NCC number
        clabe_number:
          type: string
          description: CLABE number (Mexico Only)
        branch_code:
          type: string
          description: Branch code
        cnaps_code:
          type: string
          description: CNAPS code (China Only)
        clearing_code:
          type: string
          description: Clearing code (Hong Kong Only)
        pix_code:
          type: string
          description: PIX code (Brazil Only)
        iban:
          type: string
          description: IBAN (Europe Only)
        swift_code:
          type: string
          description: SWIFT/BIC (Europe Only)
      additionalProperties: false
    BankAddress:
      type: object
      required:
        - house_no
        - street
        - city
        - state
        - postal_code
        - country
      properties:
        house_no:
          type: number
          description: House number
          example: 123
        street:
          type: string
          description: Street name
          example: Main Street
        city:
          type: string
          description: City name
          example: Lagos
        state:
          type: string
          description: State or province
          example: Lagos State
        postal_code:
          type: string
          description: Postal or ZIP code
          example: '100001'
        country:
          type: string
          description: Country code
          example: NG
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-service-key

````