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

# List capability requests

> List the capability requests of one sub-client, or of up to 100 at once, newest first. Send exactly one of `user_id` or `user_ids`.

The whole list comes back in one answer, with no paging.



## OpenAPI

````yaml /openapi/kira-api.2026-04-14.json get /v1/capability-requests
openapi: 3.1.0
info:
  title: Kira API
  version: '2026-04-14'
  description: >-
    REST API for users, KYC/KYB verification, virtual accounts, payouts,
    recipients, and webhooks. Every request except the token call needs a bearer
    access token (see Authentication). Pin your account to the recommended
    version before integrating (see [Versioning](/using-the-api/versioning)).
  contact:
    name: Kira API Support
    email: support@kirafin.ai
servers:
  - url: https://api.balampay.com
    description: Production
  - url: https://api.balampay.com/sandbox
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Versioning
  - name: Users
  - name: Virtual Accounts
  - name: Recipients
  - name: Quotations
  - name: Payouts
  - name: Ultimate Payors
  - name: Capabilities
  - name: Reference
  - name: RFIs
paths:
  /v1/capability-requests:
    get:
      tags:
        - Capabilities
      summary: List capability requests
      description: >-
        List the capability requests of one sub-client, or of up to 100 at once,
        newest first. Send exactly one of `user_id` or `user_ids`.


        The whole list comes back in one answer, with no paging.
      operationId: get_v1-capability-requests
      parameters:
        - in: header
          name: X-Api-Version
          required: false
          description: >-
            Version applied to this request. It wins over your account's pinned
            version — see [Versioning](/using-the-api/versioning).
          schema:
            type: string
            example: '2026-04-14'
        - in: query
          name: user_id
          required: false
          description: The sub-client whose requests you want.
          schema:
            type: string
            format: uuid
            example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        - in: query
          name: user_ids
          required: false
          description: >-
            Up to 100 sub-clients, comma-separated, to read in one call. A
            repeated id counts once.


            A sub-client that is not yours returns nothing, not an error.
          schema:
            type: string
            example: >-
              aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee,bbbbbbbb-cccc-dddd-eeee-ffffffffffff
        - in: query
          name: capability
          required: false
          description: >-
            Return only the requests for this capability — see
            [Values](/reference/capabilities/values#capability).
          schema:
            type: string
            example: pobo
        - in: query
          name: latest
          required: false
          description: >-
            `true` keeps only each sub-client's newest request per capability,
            which is the one that tells you where it stands.
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
      responses:
        '200':
          description: The requests, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilityRequestListResponse'
              example:
                requests:
                  - id: 5d2e8f14-7a3b-4c6d-9e1f-2a3b4c5d6e7f
                    user_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                    capability: pobo
                    status: requested
                    requirements_version: 850f14
                    verification_link: https://identity.example.com/websdk/p/aGVsbG8tdGhlcmU
                    verification_link_expires_at: '2026-11-14T14:03:22.418Z'
                    created_at: '2026-10-15T14:03:22.418Z'
                    submitted_at: null
                    decided_at: null
                total: 1
        '400':
          description: >-
            A query parameter is missing or invalid. `errors` holds one entry
            per problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilityRequestQueryValidationError'
              example:
                code: validation_error
                message: Invalid query parameters
                errors:
                  - field: user_ids
                    message: pass exactly one of user_id or user_ids
        '401':
          description: >-
            No valid bearer token came with the request. Get one from [Get
            access token](/api-reference/authentication/get-access-token) and
            send it as `Authorization: Bearer <token>`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: invalid_request
                message: >-
                  The request was not authenticated. Request a token at POST
                  /auth with your Client ID and your API key, then send it as
                  Authorization: Bearer <token>.
        '500':
          description: >-
            Something failed on our side. Retry, and if it keeps happening
            contact your Kira contact with the time of the call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: error
                message: Internal server error
      security:
        - bearerAuth: []
          apiKeyAuth: []
      servers:
        - url: https://api.balampay.com/sandbox
          description: Sandbox
        - url: https://api.balampay.com
          description: Production
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.balampay.com/sandbox/v1/capability-requests?user_ids=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee,bbbbbbbb-cccc-dddd-eeee-ffffffffffff&capability=pobo&latest=true' \
              --header 'Authorization: Bearer <token>' \
              --header 'x-api-key: <api-key>'
components:
  schemas:
    CapabilityRequestListResponse:
      type: object
      properties:
        requests:
          type: array
          description: The requests, newest first.
          items:
            $ref: '#/components/schemas/CapabilityRequest'
        total:
          type: integer
          description: How many requests are in `requests`.
    CapabilityRequestQueryValidationError:
      type: object
      properties:
        code:
          type: string
          description: Always `validation_error`.
        message:
          type: string
          description: Always `Invalid query parameters`.
        errors:
          type: array
          description: One entry per problem.
          items:
            type: object
            properties:
              field:
                type: string
                description: The parameter that was rejected.
              message:
                type: string
                description: What is wrong with it.
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        statusCode:
          type: number
        error:
          type: string
        timestamp:
          type: string
        path:
          type: string
        details: {}
      required:
        - message
    CapabilityRequest:
      type: object
      description: >-
        A request that a sub-client be enabled for a capability — see [The
        capability request
        object](/reference/capabilities/the-capability-request-object).
      properties:
        id:
          type: string
          format: uuid
          description: The request's identifier.
        user_id:
          type: string
          format: uuid
          description: The sub-client the request is for.
        capability:
          type: string
          description: >-
            The capability requested — see
            [Values](/reference/capabilities/values#capability).
        status:
          type: string
          description: >-
            Where the request stands. Available options: `requested`,
            `submitted`, `approved`, `rejected`, `cancelled` — see
            [Values](/reference/capabilities/values#request-status).
        requirements_version:
          type: string
          description: >-
            Identifies the list of requirements the request was opened against.
            It changes when that list changes.
        verification_link:
          type: string
          format: uri
          description: |-
            The link where the sub-client answers the requirements.

            Only while `status` is `requested`.
        verification_link_expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When `verification_link` stops working, ISO 8601. Request the
            capability again with [Request a
            capability](/api-reference/capabilities/request-a-capability) for a
            fresh link.
        evidence:
          type: object
          description: >-
            What the sub-client sent, once Kira has kept a copy of it. The
            answers and files themselves are never returned.
          properties:
            answers_sha256:
              type:
                - string
                - 'null'
              description: SHA-256 of the answers, to tell one submission from another.
            document_count:
              type: integer
              description: How many files the sub-client attached.
        review:
          type: object
          description: >-
            The latest review outcome. Absent until compliance has reviewed the
            request.
          properties:
            answer:
              type: string
              description: >-
                Available options: `GREEN`, `RED` — see
                [Values](/reference/capabilities/values#review-answer).
            reject_type:
              type: string
              description: >-
                On a `RED` answer. Available options: `RETRY`, `FINAL` — see
                [Values](/reference/capabilities/values#review-reject_type).
            labels:
              type: array
              description: Codes naming what the review found, when it named any.
              items:
                type: string
        grant:
          type: object
          description: The capability the approval granted. Only on an `approved` request.
          properties:
            event_uuid:
              type: string
              format: uuid
              description: The grant's identifier.
            status:
              type: string
              description: >-
                Whether the sub-client still holds the capability. Available
                options: `granted`, `revoked` — see
                [Values](/reference/capabilities/values#grant-status).
            created_at:
              type: string
              format: date-time
              description: When the grant reached this status, ISO 8601.
        cancel_reason:
          type: string
          description: >-
            Why the request was cancelled. Only on a `cancelled` request — see
            [Values](/reference/capabilities/values#cancel_reason).
        created_at:
          type: string
          format: date-time
          description: When the request was opened, ISO 8601.
        submitted_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the sub-client sent its answers, ISO 8601. `null` until then.
        decided_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the request was approved or rejected, ISO 8601. `null` until
            then.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The `data.access_token` value from [Get access
        token](/api-reference/authentication/get-access-token).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.