openapi: 3.0.0
info:
  title: Okra API
  description: >-
    # Hello there!


    Welcome to the API reference for Okra's financial APIs!


    ## About Okra


    Okra provides the infrastructure layer that powers the next wave of
    financial innovation by unlocking the power of Open Finance. Okra connects
    to thousands of banks using a secure open API, removing the complexity and
    enabling seamless access to financial information and payment
    infrastructure.


    ## About the API reference


    The API documentation is stored in an [OpenAPI v3.0
    specification](https://swagger.io/specification/) file, using JSON format.


    ## Resources


    To learn more about Okra's APIs and how you can integrate with them, check
    out the [documentation](https://docs.okra.ng/).
  version: 1.0.0
servers:
  - url: http://{{baseurl}}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
security:
  - bearerAuth: []
tags:
  - name: Account
    description: |
      Okra API endpoints for Accounts
  - name: Auth
    description: Okra API endpoints for authentication
  - name: Balance
    description: |
      Okra API endpoints for Balance
  - name: Bank
    description: |
      Okra API endpoints for Bank
  - name: Customer
    description: |
      Okra API endpoints for Customer
  - name: Identity
    description: >-
      The Okra Identity API helps you verify users' identities by retrieving KYC
      information from their banks.<p> Check out the [Identity API
      overview](/reference/identity-api) for more details.
  - name: Transactions
    description: |
      Okra API endpoints for Transactions
  - name: Payments
    description: |
      Okra API endpoints for Payments
  - name: Wallet
    description: >-
      Check out the [Wallet API overview](/reference/wallet) to understand how
      Okra uses wallets to handle payments for the services and products that
      you use, and how you can manage your wallets.
  - name: Sandbox
    description: API endpoints to manage test customers in the Sandbox environment.
paths:
  /accounts/getAccountDetails:
    post:
      tags:
        - Account
      summary: Get account details
      description: |-
        API endpoint to *Get account details*
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                account:
                  type: string
                  description: (Required) Account ID of a user
                  example: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  _id: <string>
                  name: <string>
                  nuban: <string>
                  bank:
                    _id: <string>
                    name: <string>
                    slug: <string>
                    colors:
                      primary: <string>
                      accent: <string>
                      bg: <string>
                      button: <string>
                      icon: <string>
                    icon: <string>
                    inverted_logo: <string>
                    v2_icon: <string>
                    v2_logo: <string>
                    status: <boolean>
                    isMFA: <boolean>
                    mfaType: <string>
                    corp: <boolean>
                  type: <string>
                  customer: <string>
                  env: <string>
                  created_at: <string>
                  last_updated: <string>
                  __v: <integer>
                  balance: <string>
                  projects:
                    - <string>
                    - <string>
                  manual: <boolean>
                  currency: <string>
  /accounts/getByCustomer:
    post:
      tags:
        - Account
      summary: Get account by customer
      description: |-
        API endpoint to *Get account* by customer
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  account:
                    - owner:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      connected:
                        - <string>
                        - <string>
                      _id: <string>
                      name: <string>
                      nuban: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      balance: <string>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: degraded
                        v2_icon: <string>
                        v2_logo: <string>
                    - owner:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      connected:
                        - <string>
                        - <string>
                      _id: <string>
                      name: <string>
                      nuban: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      balance: <string>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: healthy
                        v2_icon: <string>
                        v2_logo: <string>
  /auth/getById:
    post:
      tags:
        - Auth
      summary: Get Auth by id
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances when available using the id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: degraded
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: dead
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
  /auth/getByCustomer:
    post:
      tags:
        - Auth
      summary: Get Auth by Customer
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances using the `customer ID`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
  /auth/getByDate:
    post:
      tags:
        - Auth
      summary: Get Auth by date
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances within a specified date range.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          bg: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          bg: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
  /auth/getByBank:
    post:
      tags:
        - Auth
      summary: Get Auth by bank
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances using the bank Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                bank: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: down
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        icon: <string>
                        logo: <string>
                        name: <string>
                        slug: <string>
                        status: degraded
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
  /auth/getByCustomerDate:
    post:
      tags:
        - Auth
      summary: Get Auth by customer date
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances within a specified date range.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
                customer: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
                    - _id: <string>
                      record: <string>
                      __v: <integer>
                      bank:
                        colors:
                          primary: <string>
                          accent: <string>
                          button: <string>
                        icon: <string>
                        logo: <string>
                        name: <string>
                        status: <string>
                        v2_icon: <string>
                        v2_logo: <string>
                      created_at: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      owner: <string>
                      validated: <boolean>
                      id: <string>
  /products/auths:
    post:
      tags:
        - Auth
      summary: Fetch Auths
      description: >-
        This endpoint allows you retrieve the bank account associated with a
        record's current, savings, and domiciliary accounts, along with
        high-level account data and balances.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  total: <integer>
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  auths:
                    - id: <string>
                      validated: <boolean>
                      record:
                        _id: <string>
                        env: <string>
                        owner:
                          _id: <string>
                          name: <string>
                          app_name: <string>
                        customer:
                          _id: <string>
                          name: <string>
                      created_at: <string>
                      last_updated: <string>
                    - id: <string>
                      validated: <boolean>
                      record:
                        _id: <string>
                        env: <string>
                        owner:
                          _id: <string>
                          name: <string>
                          app_name: <string>
                        customer:
                          _id: <string>
                          name: <string>
                      created_at: <string>
                      last_updated: <string>
  /balance/getByCustomer:
    post:
      tags:
        - Balance
      summary: Get balance by customer
      description: >-
        This endpoint allows you retrieve the bank account balance associated
        with a record's current, savings, and domiciliary accounts using the
        customer id
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer:
                  type: string
                  description: >-
                    (Required) The `customer.id` you want to get detailed
                    information about.
                  example: <string>
                page:
                  type: string
                  description: (Required) A page number within the paginated result set.
                  example: <integer>
                limit:
                  type: string
                  description: >-
                    (Required) This limits the number of records returned based
                    on a limit value
                  example: <integer>
                includePeriodic:
                  type: string
                  description: >-
                    The `includePeriodic` is a boolean optional input that can
                    take true or false values

                    When the request body includes `includePeriodic` with a
                    false value, the periodic field will NOT be included in the
                    response

                    When the request body does NOT include includePeriodic ,
                    then by default the periodic filed will be included (the
                    default behavior is includePeriodic is true)
                  example: <boolean>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  balance:
                    - _id: <string>
                      account:
                        _id: <string>
                        name: <string>
                        nuban: <string>
                      __v: <integer>
                      available_balance: <integer>
                      created_at: <string>
                      currency: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      ledger_balance: <number>
                      owner:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      connected:
                        - <string>
                        - <string>
                      id: <string>
                    - _id: <string>
                      account:
                        _id: <string>
                        name: <string>
                        nuban: <string>
                      __v: <integer>
                      available_balance: <integer>
                      created_at: <string>
                      currency: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      env: <string>
                      last_updated: <string>
                      ledger_balance: <number>
                      owner:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      connected:
                        - <string>
                        - <string>
                      id: <string>
  /balance/getByAccount:
    post:
      tags:
        - Balance
      summary: Get balance by account
      description: >-
        This endpoint allows you retrieve the bank account balance associated
        with a record's current, savings, and domiciliary accounts using the
        account id
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                account:
                  type: string
                  description: >-
                    (Required) The account.id you want to get detailed
                    information about.
                  example: <string>
                page:
                  type: string
                  description: A page number within the paginated result set.
                  example: <integer>
                limit:
                  type: string
                  description: >-
                    This limits the number of records returned based on a limit
                    value
                  example: <integer>
                includePeriodic:
                  type: string
                  description: >-
                    The `includePeriodic` is a boolean optional input that can
                    take true or false values

                    When the request body includes `includePeriodic` with a
                    false value, the periodic field will NOT be included in the
                    response

                    When the request body does NOT include includePeriodic ,
                    then by default the periodic filed will be included (the
                    default behavior is includePeriodic is true)
                  example: <boolean>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  balance:
                    - _id: <string>
                      account:
                        _id: <string>
                        name: <string>
                        nuban: <string>
                      env: <string>
                      __v: <integer>
                      available_balance: <number>
                      created_at: <string>
                      currency: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      last_updated: <string>
                      ledger_balance: <number>
                      owner:
                        - <string>
                        - <string>
                      record:
                        - _id: <string>
                          status:
                            process:
                              running: <boolean>
                              completed: <boolean>
                        - _id: <string>
                          status:
                            process:
                              running: <boolean>
                              completed: <boolean>
                      periodic:
                        available_balance:
                          - _id: <string>
                            amount: <number>
                          - _id: <string>
                            amount: <number>
                      connected:
                        - <string>
                        - <string>
                    - _id: <string>
                      account:
                        _id: <string>
                        name: <string>
                        nuban: <string>
                      env: <string>
                      __v: <integer>
                      available_balance: <number>
                      created_at: <string>
                      currency: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      last_updated: <string>
                      ledger_balance: <number>
                      owner:
                        - <string>
                        - <string>
                      record:
                        - _id: <string>
                          status:
                            process:
                              running: <boolean>
                              completed: <boolean>
                        - _id: <string>
                          status:
                            process:
                              running: <boolean>
                              completed: <boolean>
                      periodic:
                        available_balance:
                          - _id: <string>
                            amount: <number>
                          - _id: <string>
                            amount: <number>
                      connected:
                        - <string>
                        - <string>
  /banks/list:
    get:
      tags:
        - Bank
      summary: Get list of banks
      description: >-
        This endpoint allows you retrieve the list of all institutions currently
        supported by Okra.
      security:
        - bearerAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Date:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Set-Cookie:
              schema:
                type: string
                example: ''
            Server:
              schema:
                type: string
                example: ''
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            x-documentation-url:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  banks:
                    - id: <string>
                      name: <string>
                      slug: <string>
                      icon: <string>
                      v2_icon: <string>
                      v2_logo: <string>
                      products:
                        - <string>
                        - <string>
                      colors:
                        primary: <string>
                        accent: <string>
                        bg: <string>
                        button: <string>
                        icon: <string>
                      secret_question_or_otp: <boolean>
                      secret_question_or_otp_mobile: <boolean>
                      secret_question_or_otp_corp: <boolean>
                      payments:
                        ind:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        corp:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        mobile:
                          exists: <boolean>
                          sso: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        ussd:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        secret: <boolean>
                        web:
                          recurring: <boolean>
                      ussd: <boolean>
                      countries:
                        - <string>
                        - <string>
                      corporate: <boolean>
                      status: <string>
                      individual: <boolean>
                      created_at: <string>
                      last_updated: <string>
                    - id: <string>
                      name: <string>
                      slug: <string>
                      icon: <string>
                      v2_icon: <string>
                      v2_logo: <string>
                      products:
                        - <string>
                        - <string>
                      colors:
                        primary: <string>
                        accent: <string>
                        bg: <string>
                        button: <string>
                        icon: <string>
                      secret_question_or_otp: <boolean>
                      secret_question_or_otp_mobile: <boolean>
                      secret_question_or_otp_corp: <boolean>
                      payments:
                        ind:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        corp:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        mobile:
                          exists: <boolean>
                          sso: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        ussd:
                          exists: <boolean>
                          recurring: <boolean>
                          save_bene: <boolean>
                        secret: <boolean>
                        web:
                          recurring: <boolean>
                      ussd: <boolean>
                      countries:
                        - <string>
                        - <string>
                      corporate: <boolean>
                      status: <string>
                      individual: <boolean>
                      created_at: <string>
                      last_updated: <string>
                  credentials: <string>
  /banks/getById:
    get:
      tags:
        - Bank
      summary: Get bank by id
      description: Get the details of a specific institution.
      security:
        - bearerAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
        - name: id
          in: query
          schema:
            type: string
          description: >-
            (Required) The unique ID of a bank. Visit Okra's
            [Coverage](https://docs.okra.ng/get-started/coverage) page for the
            list of bank IDs.
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  colors:
                    primary: <string>
                    accent: <string>
                    bg: <string>
                    button: <string>
                    icon: <string>
                  keyboards:
                    web_username_placeholder: <string>
                    web_password_placeholder: <string>
                    mobile_username_placeholder: <string>
                    mobile_password_placeholder: <string>
                    web_corp_username_placeholder: <string>
                    web_corp_password_placeholder: <string>
                    mobile_corp_username_placeholder: <string>
                    mobile_corp_password_placeholder: <string>
                    token_corp_placeholder: <string>
                    token_ind_placeholder: <string>
                    username: <string>
                    password: <string>
                  payments:
                    ind:
                      exists: <boolean>
                      recurring: <boolean>
                      save_bene: <boolean>
                    corp:
                      exists: <boolean>
                      recurring: <boolean>
                      save_bene: <boolean>
                    mobile:
                      exists: <boolean>
                      sso: <boolean>
                      recurring: <boolean>
                      save_bene: <boolean>
                    ussd:
                      exists: <boolean>
                      recurring: <boolean>
                      save_bene: <boolean>
                  countries:
                    - <string>
                    - <string>
                  sso: <boolean>
                  dual: <boolean>
                  sso_corp: <boolean>
                  products:
                    - <string>
                    - <string>
                  keywords:
                    - <string>
                    - <string>
                  uuid: <boolean>
                  hasWeb: <boolean>
                  only_token: <boolean>
                  only_mobile: <boolean>
                  ussd: <boolean>
                  square_logo: <boolean>
                  secret_question_or_otp: <boolean>
                  multi_login:
                    - <string>
                    - <string>
                  _id: <string>
                  __v: <integer>
                  active: <boolean>
                  created_at: <string>
                  icon: <string>
                  individual: <boolean>
                  inverted_logo: <string>
                  logo: <string>
                  name: <string>
                  old_icon: <string>
                  old_logo: <string>
                  reset_link: <string>
                  reset_link_corp: <string>
                  slug: <string>
                  sortcode: <integer>
                  status: <string>
                  token_ind: <boolean>
                  v2_icon: <string>
                  v2_logo: <string>
                  corporate: <boolean>
                  png_logo: <string>
  /customers/list:
    post:
      tags:
        - Customer
      summary: List of Customers
      description: |-
        API endpoint to *List of Customers*
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                page:
                  type: string
                  description: (Required) Use can specify any page eg, 1
                  example: <string>
                limit:
                  type: string
                  description: (Required) Use can specify the limit of data you want eg, 1
                  example: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Date:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Set-Cookie:
              schema:
                type: string
                example: ''
            Server:
              schema:
                type: string
                example: ''
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            x-documentation-url:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  customers:
                    - _id: <string>
                      credentials:
                        - bank:
                            _id: <string>
                            colors:
                              accent: <string>
                              primary: <string>
                              button: <string>
                              icon: <string>
                            icon: <string>
                            logo: <string>
                            name: <string>
                            v2_icon: <string>
                            v2_logo: <string>
                          nuban: <string>
                          accountName: <string>
                          connected: <boolean>
                        - bank:
                            _id: <string>
                            colors:
                              accent: <string>
                              primary: <string>
                              button: <string>
                              icon: <string>
                            icon: <string>
                            logo: <string>
                            name: <string>
                            v2_icon: <string>
                            v2_logo: <string>
                          nuban: <string>
                          accountName: <string>
                          connected: <boolean>
                      record:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      blocked: <boolean>
                      linkLater:
                        - <string>
                        - <string>
                      debitLater:
                        - <string>
                        - <string>
                      otherInfo: <string>
                      unconnected: <boolean>
                      manual: <boolean>
                      name: <string>
                      env: <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      last_login: <string>
                      projects:
                        - <string>
                        - <string>
                      identity: <string>
                      merged: <boolean>
                      merged_ids:
                        - <string>
                        - <string>
                      current_project: <string>
                      options: {}
                      id: <string>
                    - _id: <string>
                      credentials:
                        - bank:
                            _id: <string>
                            colors:
                              accent: <string>
                              primary: <string>
                              button: <string>
                              icon: <string>
                            icon: <string>
                            logo: <string>
                            name: <string>
                            v2_icon: <string>
                            v2_logo: <string>
                          nuban: <string>
                          accountName: <string>
                          connected: <boolean>
                        - bank:
                            _id: <string>
                            colors:
                              accent: <string>
                              primary: <string>
                              button: <string>
                              icon: <string>
                            icon: <string>
                            logo: <string>
                            name: <string>
                            v2_icon: <string>
                            v2_logo: <string>
                          nuban: <string>
                          accountName: <string>
                          connected: <boolean>
                      record:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      blocked: <boolean>
                      linkLater:
                        - <string>
                        - <string>
                      debitLater:
                        - <string>
                        - <string>
                      otherInfo: <string>
                      unconnected: <boolean>
                      manual: <boolean>
                      name: <string>
                      env: <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      last_login: <string>
                      projects:
                        - <string>
                        - <string>
                      identity: <string>
                      merged: <boolean>
                      merged_ids:
                        - <string>
                        - <string>
                      current_project: <string>
                      options: {}
                      id: <string>
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
  /customers/find-customers-by:
    post:
      tags:
        - Customer
      summary: Find Customers By
      description: |-
        API endpoint to *Find Customers* by model keys and values
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                key:
                  type: string
                  description: >-
                    (Required) You can specify the email of the customer as the
                    key
                  example: <string>
                value:
                  type: string
                  description: >-
                    (Required) Input the actual email of the client you want to
                    find
                  example: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            X-Powered-By:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  _id: <string>
                  email:
                    - <string>
                    - <string>
                  phone:
                    - <string>
                    - <string>
                  blocked: <boolean>
                  last_login: <string>
                  name: <string>
                  env: <string>
                  created_at: <string>
                  last_updated: <string>
                  __v: <integer>
  /customers/flag:
    post:
      tags:
        - Customer
      summary: Flag Customer
      description: |-
        API endpoint to *Flag Customer*
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                bank:
                  type: string
                  description: (Required) The bank id
                  example: <string>
                customer:
                  type: string
                  description: (Required) The customer id
                  example: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /customers/unflag:
    post:
      tags:
        - Customer
      summary: UnFlag Customer
      description: |-
        API endpoint to *UnFlag Customer*
        > A successful request will return a *HTTP 200*  status code
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                bank: <string>
                customer: <string>
                unflag: <boolean>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /customers/remove:
    post:
      tags:
        - Customer
      summary: Remove Customer
      description: API endpoint to remove a customer.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  success: <boolean>
                  msg: <string>
  /identity/getById:
    post:
      tags:
        - Identity
      summary: Get identity by id
      description: >-
        This operation enables you to retrieve an already verified user’s
        identity profile using the identity profile's record `ID`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  identity:
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /identity/getByBvn:
    post:
      tags:
        - Identity
      summary: Get identity by BVN
      description: >-
        This operation enables you to retrieve an already verified user’s
        identity profile using their BVN.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                bvn: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  id: <string>
                  firstname: <string>
                  middlename: <string>
                  lastname: <string>
                  fullname: <string>
                  dob: <string>
                  bvn: <string>
                  gender: <string>
                  customer:
                    _id: <string>
                    name: <string>
                  verification_country: <string>
                  env: <string>
                  aliases:
                    - <string>
                    - <string>
                  phone:
                    - <string>
                    - <string>
                  email:
                    - <string>
                    - <string>
                  address:
                    - <string>
                    - <string>
                  nationality: <string>
                  lga_of_origin: <string>
                  lga_of_residence: <string>
                  state_of_origin: <string>
                  state_of_residence: <string>
                  marital_status: <string>
                  mothers_maiden: <string>
                  next_of_kins:
                    - <string>
                    - <string>
                  score: <number>
                  watch_listed: <boolean>
                  dti: <float>
                  rc_number: <string>
                  nin: <string>
                  photo_id:
                    _id: <string>
                    url: <string>
                    image_type: <string>
                    bank: <string>
                  created_at: <string>
                  last_updated: <string>
                  enrollment:
                    bank: <string>
                    branch: <string>
                    registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /identity/getByNuban:
    post:
      tags:
        - Identity
      summary: Get identity by NUBAN
      description: >-
        This operation enables you to retrieve an already verified user’s
        identity profile using their NUBAN.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                bank: <string>
                nuban: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  id: <string>
                  firstname: <string>
                  middlename: <string>
                  lastname: <string>
                  fullname: <string>
                  dob: <string>
                  bvn: <string>
                  gender: <string>
                  customer:
                    _id: <string>
                    name: <string>
                  verification_country: <string>
                  env: <string>
                  aliases:
                    - <string>
                    - <string>
                  phone:
                    - <string>
                    - <string>
                  email:
                    - <string>
                    - <string>
                  address:
                    - <string>
                    - <string>
                  nationality: <string>
                  lga_of_origin: <string>
                  lga_of_residence: <string>
                  state_of_origin: <string>
                  state_of_residence: <string>
                  marital_status: <string>
                  mothers_maiden: <string>
                  next_of_kins:
                    - <string>
                    - <string>
                  score: <number>
                  watch_listed: <boolean>
                  dti: <float>
                  rc_number: <string>
                  nin: <string>
                  photo_id:
                    _id: <string>
                    url: <string>
                    image_type: <string>
                    bank: <string>
                  created_at: <string>
                  last_updated: <string>
                  enrollment:
                    bank: <string>
                    branch: <string>
                    registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - status: <string>
                  message: <string>
                  data: <string>
                - status: <string>
                  message: <string>
                  data: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /identity/getByCustomer:
    post:
      tags:
        - Identity
      summary: Get identity by customer
      description: >-
        This operation enables you to retrieve an already verified user’s
        identity profiles using their customer `ID`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  identity:
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /identity/getByDate:
    post:
      tags:
        - Identity
      summary: Get identity by date
      description: >-
        This operation enables you to retrieve identity profiles for **all
        users** in a given date range. The dates you specify in your request
        filter results based on each identity profile's `created_at` value.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  identity:
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /identity/getByCustomerDate:
    post:
      tags:
        - Identity
      summary: Get identity by customer date
      description: >-
        This operation enables you to retrieve an already verified user’s
        identity profiles using their customer `ID` and a given date range. The
        dates you specify in your request filter results based on each identity
        profile's `created_at` value.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
                customer: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  identity:
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
                    - id: <string>
                      firstname: <string>
                      middlename: <string>
                      lastname: <string>
                      fullname: <string>
                      dob: <string>
                      bvn: <string>
                      gender: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      verification_country: <string>
                      env: <string>
                      aliases:
                        - <string>
                        - <string>
                      phone:
                        - <string>
                        - <string>
                      email:
                        - <string>
                        - <string>
                      address:
                        - <string>
                        - <string>
                      nationality: <string>
                      lga_of_origin: <string>
                      lga_of_residence: <string>
                      state_of_origin: <string>
                      state_of_residence: <string>
                      marital_status: <string>
                      mothers_maiden: <string>
                      next_of_kins:
                        - <string>
                        - <string>
                      score: <number>
                      watch_listed: <boolean>
                      dti: <float>
                      rc_number: <string>
                      nin: <string>
                      photo_id:
                        _id: <string>
                        url: <string>
                        image_type: <string>
                        bank: <string>
                      created_at: <string>
                      last_updated: <string>
                      enrollment:
                        bank: <string>
                        branch: <string>
                        registration_date: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /products/kyc/customer-verify:
    post:
      tags:
        - Identity
      summary: Verify customer
      description: >-
        This operation enables you to retrieve a user’s identity profile using
        their customer `ID`. Okra suggests using this operation for customers
        who already connected their accounts, but do not have a verified
        identity yet. This operation requires the user’s BVN to be available in
        the user’s profile.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  id: <string>
                  firstname: <string>
                  middlename: <string>
                  lastname: <string>
                  fullname: <string>
                  dob: <string>
                  bvn: <string>
                  gender: <string>
                  customer: <string>
                  verification_country: <string>
                  aliases:
                    - <string>
                    - <string>
                  phone:
                    - <string>
                    - <string>
                  email:
                    - <string>
                    - <string>
                  address:
                    - <string>
                    - <string>
                  nationality: <string>
                  lga_of_origin: <string>
                  lga_of_residence: <string>
                  state_of_origin: <string>
                  state_of_residence: <string>
                  marital_status: <string>
                  next_of_kins:
                    - <string>
                    - <string>
                  nin: <string>
                  photo_id:
                    _id: <string>
                    url: <string>
                    image_type: <string>
                    bank: <string>
                  enrollment:
                    bank: <string>
                    branch: <string>
                    registration_date: <string>
                  record: <uuid>
                  receipt:
                    status: <string>
                    msg: <string>
                    data:
                      adjustment:
                        receipts:
                          - <string>
                          - <string>
                      charge_breakdown:
                        vat: <integer>
                      breakdown:
                        discount: <integer>
                        billable_product:
                          effective_credits: <integer>
                          credits: <float>
                          status: <boolean>
                          addon_products:
                            - <string>
                            - <string>
                          product: <string>
                        billable_products:
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                        source: integration
                        limit: <string>
                      billingStatus: <boolean>
                      adjusted: <date>
                      adjusted_receipt: <boolean>
                      adjusted_type: duplicate-unbilled
                      paid: <boolean>
                      payment_amount: <number>
                      method: card
                      charge: <integer>
                      wallet_balance: <number>
                      addons:
                        - reconciliation
                        - premium-support
                      archived: <boolean>
                      micro_lending: <boolean>
                      ussd_pricing: <boolean>
                      ussd_pricing_discount: <integer>
                      micro_lending_discount: <integer>
                      _id: <string>
                      term: postpaid
                      owner: <string>
                      type: deposit
                      currency: NGN
                      record: <string>
                      created_at: <string>
                      last_updated: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /products/kyc/nuban-verify:
    post:
      tags:
        - Identity
      summary: Nuban Verify
      description: >-
        This operation enables you to retrieve a user’s KYC profile using their
        Nigerian Uniform Bank Account Number.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                nuban: <string>
                bank: <string>
                refresh: <boolean>
                testing: <boolean>
                success: <boolean>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  identity:
                    id: <string>
                    firstname: <string>
                    middlename: <string>
                    lastname: <string>
                    fullname: <string>
                    dob: <string>
                    bvn: <string>
                    gender: <string>
                    customer: <string>
                    verification_country: <string>
                    aliases:
                      - <string>
                      - <string>
                    phone:
                      - <string>
                      - <string>
                    email:
                      - <string>
                      - <string>
                    address:
                      - <string>
                      - <string>
                    nationality: <string>
                    lga_of_origin: <string>
                    lga_of_residence: <string>
                    state_of_origin: <string>
                    state_of_residence: <string>
                    marital_status: <string>
                    next_of_kins:
                      - <string>
                      - <string>
                    nin: <string>
                    photo_id:
                      _id: <string>
                      url: <string>
                      image_type: <string>
                      bank: <string>
                    enrollment:
                      bank: <string>
                      branch: <string>
                      registration_date: <string>
                    record: <uuid>
                    receipt:
                      status: <string>
                      msg: <string>
                      data:
                        adjustment:
                          receipts:
                            - <string>
                            - <string>
                        charge_breakdown:
                          vat: <integer>
                        breakdown:
                          discount: <integer>
                          billable_product:
                            effective_credits: <integer>
                            credits: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                          billable_products:
                            - archived: <boolean>
                              _id: <string>
                              effective_credits: <integer>
                              cost: <float>
                              status: <boolean>
                              addon_products:
                                - <string>
                                - <string>
                              product: <string>
                            - archived: <boolean>
                              _id: <string>
                              effective_credits: <integer>
                              cost: <float>
                              status: <boolean>
                              addon_products:
                                - <string>
                                - <string>
                              product: <string>
                          source: api
                          limit: <string>
                        billingStatus: <boolean>
                        adjusted: <date>
                        adjusted_receipt: <boolean>
                        adjusted_type: validated
                        paid: <boolean>
                        payment_amount: <number>
                        method: bank_transfer
                        charge: <integer>
                        wallet_balance: <number>
                        addons:
                          - reconciliation
                          - premium-support
                        archived: <boolean>
                        micro_lending: <boolean>
                        ussd_pricing: <boolean>
                        ussd_pricing_discount: <integer>
                        micro_lending_discount: <integer>
                        _id: <string>
                        term: postpaid
                        owner: <string>
                        type: refund
                        currency: Okra Credits
                        record: <string>
                        created_at: <string>
                        last_updated: <string>
                  account: <string>
                  bank:
                    _id: <string>
                    slug: <string>
                  customer: <string>
                  record: <uuid>
                  receipt:
                    status: <string>
                    msg: <string>
                    data:
                      adjustment:
                        receipts:
                          - <string>
                          - <string>
                      charge_breakdown:
                        vat: <integer>
                      breakdown:
                        discount: <integer>
                        billable_product:
                          effective_credits: <integer>
                          credits: <float>
                          status: <boolean>
                          addon_products:
                            - <string>
                            - <string>
                          product: <string>
                        billable_products:
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                        source: link
                        limit: <string>
                      billingStatus: <boolean>
                      adjusted: <date>
                      adjusted_receipt: <boolean>
                      adjusted_type: validated
                      paid: <boolean>
                      payment_amount: <number>
                      method: bank_transfer
                      charge: <integer>
                      wallet_balance: <number>
                      addons:
                        - premium-support
                        - premium-support
                      archived: <boolean>
                      micro_lending: <boolean>
                      ussd_pricing: <boolean>
                      ussd_pricing_discount: <integer>
                      micro_lending_discount: <integer>
                      _id: <string>
                      term: prepaid
                      owner: <string>
                      type: withdrawal
                      currency: NGN
                      record: <string>
                      created_at: <string>
                      last_updated: <string>
        '204':
          description: No Content
          content:
            text/plain:
              schema:
                type: string
              example: null
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /products/kyc/nuban-name-verify:
    post:
      tags:
        - Identity
      summary: Nuban Name Verify
      description: >-
        This operation enables you to retrieve a user’s full name using their
        NUBAN. This operation is ideal for use cases where a complete KYC
        profile is not necessary.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                nuban: <string>
                bank: <string>
                success: <boolean>
                no_bvn: <boolean>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  identity:
                    name: <string>
                    nuban: <string>
                    bvn: <string>
                    isBvnVerified: <boolean>
                  bank:
                    _id: <string>
                    slug: <string>
                  customer: <string>
                  record:
                    - <uuid>
                    - <uuid>
                  receipt:
                    status: <string>
                    msg: <string>
                    data:
                      adjustment:
                        receipts:
                          - <string>
                          - <string>
                      charge_breakdown:
                        vat: <integer>
                      breakdown:
                        discount: <integer>
                        billable_product:
                          effective_credits: <integer>
                          credits: <float>
                          status: <boolean>
                          addon_products:
                            - <string>
                            - <string>
                          product: <string>
                        billable_products:
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                          - archived: <boolean>
                            _id: <string>
                            effective_credits: <integer>
                            cost: <float>
                            status: <boolean>
                            addon_products:
                              - <string>
                              - <string>
                            product: <string>
                        source: api
                        limit: <string>
                      billingStatus: <boolean>
                      adjusted: <date>
                      adjusted_receipt: <boolean>
                      adjusted_type: validated
                      paid: <boolean>
                      payment_amount: <number>
                      method: wallet
                      charge: <integer>
                      wallet_balance: <number>
                      addons:
                        - reconciliation
                        - premium-support
                      archived: <boolean>
                      micro_lending: <boolean>
                      ussd_pricing: <boolean>
                      ussd_pricing_discount: <integer>
                      micro_lending_discount: <integer>
                      _id: <string>
                      term: prepaid
                      owner: <string>
                      type: deposit
                      currency: USD
                      record: <string>
                      created_at: <string>
                      last_updated: <string>
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
                total: <string>
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <string>
                status: <string>
                message: <string>
                extra: <string>
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data: <string>
        '503':
          description: Service Unavailable
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
  /transactions/getById:
    post:
      tags:
        - Transactions
      summary: Get transaction by id
      description: >-
        This endpoint allows you retrieve a paginated list of a specific
        transaction of a customer.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  transaction:
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <number>
                      ref: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <number>
                      ref: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
  /transactions/getByAccount:
    post:
      tags:
        - Transactions
      summary: Get transaction by account
      description: >-
        This endpoint allows you retrieve a paginated list of a specific
        transaction of a customer using the `accountId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                account: <string>
                page: <string>
                limit: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  transaction:
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <number>
                      ref: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <number>
                      ref: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
  /transactions/getByDate:
    post:
      tags:
        - Transactions
      summary: Get transaction by date
      description: >-
        This endpoint allows you retrieve a paginated list of a specific
        transaction of a customer within a specific date range.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  transaction:
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
  /transactions/getByCustomerDate:
    post:
      tags:
        - Transactions
      summary: Get transaction by customer date
      description: >-
        This endpoint allows you retrieve a paginated list of a specific
        transaction of a customer within a specific customer date range.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: <string>
                to: <string>
                page: <integer>
                limit: <integer>
                customer_id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  transaction:
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
  /transactions/getByNuban:
    post:
      tags:
        - Transactions
      summary: Get transaction by nuban
      description: >-
        This endpoint allows you retrieve a paginated list of a specific
        transaction of a customer by passing the nuban account of that customer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                nuban: <string>
                page: <integer>
                limit: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
                  transaction:
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <string>
                      credit: <number>
                      ref: <string>
                      branch: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
                    - _id: <string>
                      notes:
                        actions:
                          - <string>
                          - <string>
                        desc: <string>
                        people:
                          - <string>
                          - <string>
                        places:
                          - <string>
                          - <string>
                        prepositions:
                          - <string>
                          - <string>
                        subjects:
                          - <string>
                          - <string>
                        topics:
                          - <string>
                          - <string>
                      manual: <boolean>
                      reconciled: <boolean>
                      fetched:
                        - <string>
                        - <string>
                      record:
                        - <string>
                        - <string>
                      actions:
                        - <string>
                        - <string>
                      trans_date: <string>
                      cleared_date: <string>
                      unformatted_trans_date: <string>
                      unformatted_cleared_date: <string>
                      debit: <string>
                      credit: <number>
                      ref: <string>
                      branch: <string>
                      customer:
                        _id: <string>
                        name: <string>
                      account:
                        _id: <string>
                        name: <string>
                      env: <string>
                      checked:
                        - <string>
                        - <string>
                      created_at: <string>
                      last_updated: <string>
                      __v: <integer>
                      id: <string>
  /pay/link/create:
    post:
      tags:
        - Payments
      summary: Create payment link
      description: This endpoint allows you create a payment link.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                amount: <integer>
                name: <string>
                currency: <string>
                type: one-time
                note: <string>
                countries: NG
                account: <string>
                filter:
                  banks:
                    - <string>
                    - <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  _id: <string>
                  schedule:
                    startDate: <string>
                    endDate: <string>
                  amount: <integer>
                  currency: <string>
                  type: <string>
                  debitLater: <boolean>
                  countries:
                    - <string>
                    - <string>
                  unique_views:
                    - <string>
                    - <string>
                  billable_products:
                    - <string>
                    - <string>
                  data: <boolean>
                  archived: <boolean>
                  corporate: <boolean>
                  projects:
                    - <string>
                    - <string>
                  note: <string>
                  count: <integer>
                  created_by: <string>
                  url: <string>
                  surl: <string>
                  qr: <string>
                  short_url: <string>
                  name: <string>
                  env: <string>
                  account: <string>
                  created_at: <string>
                  last_updated: <string>
                  __v: <integer>
                  filter:
                    banks:
                      - <string>
                      - <string>
                  preselect_bank:
                    bank: <string>
                    type: <string>
                    platform: <string>
                    login: <string>
                  support_email: <string>
                  current_project: <string>
                  color: <string>
                  logo: <string>
  /pay/verify:
    post:
      tags:
        - Payments
      summary: Verify Payment
      description: This endpoint allows you verify the status of a payment initiated
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                payment_id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  payment_status:
                    _id: <string>
                    amount: <integer>
                    error: <string>
                    currency: <string>
                    customer: <string>
                    link:
                      _id: <string>
                      url: <string>
                      surl: <string>
                      short_url: <string>
                    status: <string>
  /pay/list:
    post:
      tags:
        - Payments
      summary: Get all Payments
      description: >-
        This endpoint allows you retrieve all the payment transactions in your
        Okra account.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                payment_id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  payment:
                    _id: <string>
                    record: <string>
                    __v: <integer>
                    amount: <integer>
                    created_at: <string>
                    credit_account: <string>
                    currency: <string>
                    customer: <string>
                    debit_account: <string>
                    email: <string>
                    env: <string>
                    error: {}
                    last_updated: <string>
                    link:
                      _id: <string>
                      url: <string>
                      surl: <string>
                      short_url: <string>
                    meta: <string>
                    ref: <string>
                    source: <string>
                    status: <string>
                    current_project: <string>
                    projects:
                      - <string>
                      - <string>
                    response_status: <string>
  /pay/get/id:
    post:
      tags:
        - Payments
      summary: Get  Payments by id
      description: >-
        This endpoint allows you retrieve a specific the payment transactions in
        your Okra account.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                payment_id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json; charset=utf-8
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Content-Security-Policy:
              schema:
                type: string
                example: ''
            X-DNS-Prefetch-Control:
              schema:
                type: string
                example: ''
            Expect-CT:
              schema:
                type: string
                example: ''
            X-Frame-Options:
              schema:
                type: string
                example: ''
            Strict-Transport-Security:
              schema:
                type: string
                example: ''
            X-Download-Options:
              schema:
                type: string
                example: ''
            X-Content-Type-Options:
              schema:
                type: string
                example: ''
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
                example: ''
            Referrer-Policy:
              schema:
                type: string
                example: ''
            X-XSS-Protection:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: ''
            Access-Control-Allow-Credentials:
              schema:
                type: string
                example: ''
            Content-Length:
              schema:
                type: string
                example: ''
            ETag:
              schema:
                type: string
                example: ''
            Date:
              schema:
                type: string
                example: ''
            Connection:
              schema:
                type: string
                example: ''
            Keep-Alive:
              schema:
                type: string
                example: ''
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  payment:
                    _id: <string>
                    record: <string>
                    __v: <integer>
                    amount: <integer>
                    created_at: <string>
                    credit_account: <string>
                    currency: <string>
                    customer: <string>
                    debit_account: <string>
                    email: <string>
                    env: <string>
                    error: {}
                    last_updated: <string>
                    link:
                      _id: <string>
                      url: <string>
                      surl: <string>
                      short_url: <string>
                    meta: <string>
                    ref: <string>
                    source: <string>
                    status: <string>
                    current_project: <string>
                    projects:
                      - <string>
                      - <string>
                    response_status: <string>
  /pay/verifyByOptions:
    post:
      tags:
        - Payments
      summary: Get payments by options
      description: >-
        This endpoint allows you verify the payments via the metadata or
        options.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                options:
                  type: string
                  description: (Required) Verify the payment by passing options
                  example: <string>
                page:
                  type: string
                  description: A page number within the paginated result set.
                  example: <integer>
                limit:
                  type: string
                  description: >-
                    This limits the number of records returned based on a limit
                    value
                  example: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /wallet/get:
    post:
      tags:
        - Wallet
      summary: Get wallet
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                nullable: true
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  wallet:
                    _id: <boolean>
                    notifications:
                      available_balance:
                        status: <boolean>
                        min: <number>
                        schedule: hourly
                        emails:
                          - <string>
                          - <string>
                    credits: <float>
                    auto_topup:
                      status: <boolean>
                      currency: <string>
                      available_balance_threshold: <number>
                      topup_amount: <number>
                      amount: <number>
                      payment_method: <uuid>
                    created_at: <string>
                    last_updated: <string>
                    payment_wallet: <number>
                    current_project: <string>
                    current_project_name: <string>
  /wallet/list:
    post:
      tags:
        - Wallet
      summary: List wallets
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                page: <integer>
                limit: <integer>
                project: <string>
                id: <string>
                term: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: <string>
                message: <string>
                data:
                  wallets:
                    - wallet:
                        _id: <string>
                        current_project: <string>
                        current_project_name: <string>
                        notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: four_daily
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        company:
                          _id: <string>
                          name: <string>
                        credits: <float>
                        payment_wallet: <string>
                    - wallet:
                        _id: <string>
                        current_project: <string>
                        current_project_name: <string>
                        notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: daily
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        company:
                          _id: <string>
                          name: <string>
                        credits: <float>
                        payment_wallet: <string>
                  total: <string>
                  pagination:
                    totalDocs: <integer>
                    limit: <integer>
                    hasPrevPage: <boolean>
                    hasNextPage: <boolean>
                    page: <integer>
                    totalPages: <integer>
                    pagingCounter: <integer>
                    prevPage: <string>
                    nextPage: <string>
  /wallet/balance/check:
    post:
      tags:
        - Wallet
      summary: Check wallet balance
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                project: <string>
                id: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - status: <string>
                  message: <string>
                  data:
                    balance:
                      - notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: daily
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        credits: <float>
                        payment_wallet: <string>
                        current_project: <string>
                        current_project_name: <string>
                        last_updated: <string>
                      - notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: daily
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        credits: <float>
                        payment_wallet: <string>
                        current_project: <string>
                        current_project_name: <string>
                        last_updated: <string>
                - status: <string>
                  message: <string>
                  data:
                    balance:
                      - notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: hourly
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        credits: <float>
                        payment_wallet: <string>
                        current_project: <string>
                        current_project_name: <string>
                        last_updated: <string>
                      - notifications:
                          available_balance:
                            status: <boolean>
                            min: <number>
                            schedule: twice_daily
                            emails:
                              - <string>
                              - <string>
                        auto_topup:
                          status: <boolean>
                          currency: <string>
                          available_balance_threshold: <number>
                          topup_amount: <number>
                          amount: <number>
                          payment_method: <uuid>
                        credits: <float>
                        payment_wallet: <string>
                        current_project: <string>
                        current_project_name: <string>
                        last_updated: <string>
  /sandbox/customers/create:
    post:
      tags:
        - Sandbox
      summary: Create Sandbox Customers
      description: >-
        This operation enables you to create sandbox customers and manually
        define their details.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - noOfAccount: <integer>
                  name: <string>
                  bank: <string>
                  username: <string>
                  password: <string>
                  type: corp
                  volume: high
                  identity: <integer>
                  internetSpeed: <integer>
                - noOfAccount: <integer>
                  name: <string>
                  bank: <string>
                  username: <string>
                  password: <string>
                  type: corp
                  volume: low
                  identity: <integer>
                  internetSpeed: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /sandbox/customers/list:
    post:
      tags:
        - Sandbox
      summary: List Sandbox Customers
      description: >-
        This operation lists all sandbox customers in your project. You do not
        need to add any parameters to your request.
      requestBody:
        content: {}
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /sandbox/customers/get:
    post:
      tags:
        - Sandbox
      summary: Get Sandbox Customer
      description: >-
        This operation enables you to a sandbox customer using their customer
        `ID`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customer: <string>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
  /sandbox/customers/generate:
    post:
      tags:
        - Sandbox
      summary: Autogenerate Sandbox Customers
      description: This operation enables you to auto-generate sandbox customers.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                create: <boolean>
                number: <integer>
      security:
        - bearerAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
              example: null
