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

# Submit KYC documents

> Submit up to 3 KYC documents for a customer.

**Test mode (`sk_test_*`):** Simulated verification — no real BVN/NIN lookup. BVN `22222222222` or NIN `12345678901` → success; BVN `11111111111` or NIN `10000000000` → failure. Passport/driver license with `id_front` always succeeds in test. See guides/kyc.



## OpenAPI

````yaml /openapi.json post /customers/{id}/documents
openapi: 3.0.0
info:
  title: Puplar Integrations API
  version: 1.0.0
  description: >-
    Public API for integrators using **secret keys** (`sk_test_*` /
    `sk_live_*`). Authenticated routes need only **`Authorization: Bearer
    <secret_key>`**. Test keys sandbox payments, virtual accounts, KYC, and bank
    resolve — see guides/test-vs-live for fixtures. Responses follow `{ message,
    data?, errors? }`. Includes customers, collections, payments, products,
    invoices, payouts, wallets, virtual accounts, crypto, refunds, and webhooks.
  contact:
    name: Puplar Support
    email: support@puplar.com
servers:
  - url: https://api.puplar.com
    description: Production
security: []
tags:
  - name: Customers
    description: Customer CRUD and KYC documents
  - name: Virtual accounts
    description: Funding instructions and test deposit simulation
  - name: Webhooks
    description: >-
      Webhook endpoints and delivery logs. Subscriber verification: HMAC-SHA256
      of raw body with webhook secret, header `X-Signature: sha256=<hex>`.
  - name: Payments
    description: One-time payment collection via hosted checkout links
  - name: Crypto
    description: EVM crypto wallet addresses and supported tokens
  - name: Collections
    description: Reusable checkout links
  - name: Products
    description: Catalog items for invoices. Amounts are minor units.
  - name: Invoices
    description: Draft → finalize → paid or void. Finalize returns a payment URL.
  - name: Payouts
    description: >-
      Send wallet funds to a bank account or crypto wallet. Duplicate
      `reference` returns 409.
  - name: Wallets
    description: >-
      Wallet balances per currency (available, pending, total). Amounts in minor
      units.
  - name: Misc
    description: >-
      Country-scoped bank list and account name lookup for payouts (e.g. `ng`
      for Nigeria).
  - name: Meta
    description: Health and service info
paths:
  /customers/{id}/documents:
    post:
      tags:
        - Customers
      summary: Submit KYC documents
      description: >-
        Submit up to 3 KYC documents for a customer.


        **Test mode (`sk_test_*`):** Simulated verification — no real BVN/NIN
        lookup. BVN `22222222222` or NIN `12345678901` → success; BVN
        `11111111111` or NIN `10000000000` → failure. Passport/driver license
        with `id_front` always succeeds in test. See guides/kyc.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Customer Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - documents
              properties:
                documents:
                  type: array
                  minItems: 1
                  maxItems: 3
                  items:
                    type: object
                    required:
                      - id_type
                      - id_number
                    properties:
                      id_type:
                        type: string
                        enum:
                          - bvn
                          - passport
                          - national_identity
                          - drivers_license
                      id_number:
                        type: string
                      id_front:
                        type: string
                        description: Base64-encoded JPEG or PNG (raw base64 or data URI).
                      id_back:
                        type: string
                        description: Base64-encoded JPEG or PNG (raw base64 or data URI).
                      country:
                        type: string
                        description: >-
                          ISO2. Required unless id_type is bvn or the customer
                          already has a country.
                      dob:
                        type: string
                        description: YYYY-MM-DD. Optional.
      responses:
        '200':
          description: Documents submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
        '400':
          description: Validation error or provider rejected a document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden (e.g. IP not allowed for this key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Schema validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Success:
      type: object
      properties:
        message:
          type: string
          example: Success
        data:
          type: object
          nullable: true
    Error:
      type: object
      properties:
        message:
          type: string
          example: Error message
        data:
          type: object
          nullable: true
        errors:
          type: object
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Secret key: `Authorization: Bearer sk_test_...` or `sk_live_...`.
        Business and live/test mode are inferred from the key.

````