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

# Get verification call history

> Returns the authenticated client's paginated KYC verification call history.



## OpenAPI

````yaml /openapi.json get /kyc/history
openapi: 3.0.0
info:
  description: |-
    Hyparrow payment gateway API. Authenticate server-to-server
    requests with your API key credentials.
  title: Hyparrow API
  termsOfService: https://hyparrow.cloud/terms
  contact:
    name: Hyparrow Support
    email: support@hyparrow.com
  version: '1.0'
servers:
  - url: https://api.hyparrow.cloud/api/v1
    description: Production
  - url: https://sandbox.hyparrow.cloud/api/v1
    description: Sandbox - simulated providers, test keys only, no real money
security: []
paths:
  /kyc/history:
    get:
      tags:
        - KYC
      summary: Get verification call history
      description: >-
        Returns the authenticated client's paginated KYC verification call
        history.
      parameters:
        - description: Page number (default 1)
          name: page
          in: query
          schema:
            type: integer
        - description: Items per page (default 20, max 100)
          name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/internal_handlers.KYCCallHistoryEntry'
        '401':
          description: Missing or invalid API credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_handlers.KYCErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    internal_handlers.KYCCallHistoryEntry:
      type: object
      properties:
        amountCharged:
          type: number
          example: 0
        apiCode:
          description: >-
            The API that was called, matching the keys in a plan's `quotas` and
            in

            GET /kyc/pricing.
          type: string
          example: bvn_basic
        billingType:
          description: |-
            "sub" when the call drew from subscription quota, "payg" when it was
            charged to the wallet.
          type: string
          example: sub
        clientId:
          type: string
          example: c0ffee00-0000-0000-0000-000000000001
        createdAt:
          type: string
          example: '2026-07-28T10:05:11Z'
        group:
          description: >-
            Which documented endpoint group served the call: "identity",
            "verify" or

            "nuban". Deliberately not the supplier's name.
          type: string
          example: identity
        id:
          type: string
          example: f0e1d2c3-0000-1111-2222-333344445555
        status:
          description: '"success" or "failed". A failed call is always refunded.'
          type: string
          example: success
        subId:
          type: string
          example: a1b2c3d4-0000-1111-2222-333344445555
    internal_handlers.KYCErrorResponse:
      type: object
      properties:
        code:
          description: |-
            Stable machine-readable classification, e.g. INSUFFICIENT_BALANCE or
            QUOTA_EXCEEDED.
          type: string
          example: INSUFFICIENT_BALANCE
        error:
          type: string
          example: Insufficient verification balance
        success:
          type: boolean
          example: false
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Server-to-server auth. Send your API key in the "X-API-Key" header and
        your API secret in the "X-API-Secret" header.
      type: apiKey
      name: X-API-Key
      in: header

````