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

# Enable cNGN (BVN onboard)

> Starts KYC onboard for the customer. Requires `transfers:write` and `Idempotency-Key`.
Poll `POST /customers/{id}/strails/onboard-status` until `strails.userId` is set.




## OpenAPI

````yaml /openapi.yaml post /customers/{id}/strails/onboard
openapi: 3.1.0
info:
  title: Remitflex API
  version: 1.0.0
  description: >
    Programmatic access to Remitflex payment routes, fiat rates, customers, and
    transactions.


    **Dashboard:** Create API keys at https://dashboard.remitflex.io


    **Authentication:** Send your API key as `Authorization: Bearer
    rmf_live_...` or `rmf_test_...`.


    **Idempotency:** Mutating requests (`POST`, `PUT`, `PATCH`, `DELETE`)
    require an `Idempotency-Key` header when authenticated with an API key.
servers:
  - url: http://localhost:4000/v1
    description: Local development
  - url: https://api.remitflex.io/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /customers/{id}/strails/onboard:
    post:
      tags:
        - Customers
      summary: Enable cNGN (BVN onboard)
      description: >
        Starts KYC onboard for the customer. Requires `transfers:write` and
        `Idempotency-Key`.

        Poll `POST /customers/{id}/strails/onboard-status` until
        `strails.userId` is set.
      operationId: onboardCustomerCngn
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - bvn
              properties:
                bvn:
                  type: string
                  pattern: ^\d{11}$
                  description: Nigerian BVN (11 digits).
                email:
                  type: string
                  format: email
                  description: Optional. Defaults to the customer's email.
                phoneNumber:
                  type: string
                  description: Optional phone number.
            example:
              bvn: '22222222222'
              email: jane@example.com
      responses:
        '200':
          description: Onboarding started
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      customer:
                        type: object
                      onboard:
                        type: object
                        properties:
                          requestId:
                            type: string
                            nullable: true
                          status:
                            type: string
                            nullable: true
                          userId:
                            type: string
                            nullable: true
                          message:
                            type: string
                            nullable: true
                          estimatedCompletionTime:
                            type: string
                            nullable: true
      security:
        - ApiKeyAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Unique key for safe retries on mutating API-key requests. Cached for 24
        hours per org, method, and path.
      schema:
        type: string
        maxLength: 255
        example: 7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        API key created in the Remitflex Dashboard at dashboard.remitflex.io
        (`rmf_live_...` or `rmf_test_...`).

        Key management endpoints require a dashboard JWT and are not part of
        this reference.

````