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

# Credit Score Query

> Credit score API: query Nigerian customer credit score and risk signals for lending and underwriting.



## OpenAPI

````yaml POST /api/v1/merchant/risk/credit-score/query
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /api/v1/merchant/risk/credit-score/query:
    post:
      tags:
        - Risk
      summary: Credit Score Query
      description: >-
        Query customer credit score information using mobile number, ID number,
        and optional extended info.
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Request content type
          required: true
          schema:
            type: string
            enum:
              - application/json
          example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditScoreQueryRequest'
            examples:
              default:
                summary: Credit score query request
                value:
                  mobile_no: '08012345678'
                  id_number: '22123456789'
                  extend_info:
                    channel: web
                    product: consumer-loan
      responses:
        '200':
          description: Credit score query response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditScoreQueryResponse'
              examples:
                successfulQuery:
                  summary: Successful credit score query
                  value:
                    success: true
                    message: Credit score query completed successfully
                    data:
                      credit_score: '742'
                      version: v1.0
                      request_id: CSQ-20260402-0001
                    charges:
                      charged: false
                      charged_amount: '0.00'
        '402':
          description: >-
            Query could not be processed because the wallet balance is
            insufficient
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationPaymentErrorResponse'
              examples:
                insufficientBalance:
                  summary: Insufficient wallet balance
                  value:
                    success: false
                    message: >-
                      Your wallet balance is insufficient for this request.
                      Required 25.00, available 0. Please fund your wallet and
                      try again.
                    details:
                      - >-
                        Your wallet balance is insufficient for this request.
                        Required 25.00, available 0. Please fund your wallet and
                        try again.
      servers:
        - url: https://api.payvessel.com/kyc
        - url: https://sandbox.payvessel.com/kyc
components:
  schemas:
    CreditScoreQueryRequest:
      type: object
      required:
        - mobile_no
        - id_number
        - extend_info
      properties:
        mobile_no:
          type: string
          example: '08012345678'
        id_number:
          type: string
          example: '22123456789'
        extend_info:
          type: object
          additionalProperties: true
          example:
            channel: web
            product: consumer-loan
    CreditScoreQueryResponse:
      type: object
      required:
        - success
        - message
        - data
        - charges
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Credit score query completed successfully
        data:
          $ref: '#/components/schemas/CreditScoreQueryData'
        charges:
          $ref: '#/components/schemas/VerificationCharges'
    VerificationPaymentErrorResponse:
      type: object
      required:
        - success
        - message
        - details
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully
          example: false
        message:
          type: string
          description: Reason the request could not be processed
          example: >-
            Your wallet balance is insufficient for this request. Required
            25.00, available 0. Please fund your wallet and try again.
        details:
          type: array
          description: Detailed error messages returned by the API
          items:
            type: string
          example:
            - >-
              Your wallet balance is insufficient for this request. Required
              25.00, available 0. Please fund your wallet and try again.
    CreditScoreQueryData:
      type: object
      required:
        - credit_score
        - version
        - request_id
      properties:
        credit_score:
          type: string
          example: '742'
        version:
          type: string
          example: v1.0
        request_id:
          type: string
          example: CSQ-20260402-0001
    VerificationCharges:
      type: object
      required:
        - charged
        - charged_amount
      properties:
        charged:
          type: boolean
          description: Whether the verification request was billed
        charged_amount:
          type: string
          description: Amount charged for the verification request
          example: '0.00'

````