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

# Request Financial Information

> Use this API to initiate a secure request for a user's financial information after obtaining valid consent by passing the consent ID and required data scopes.
The request triggers a data-collection workflow and returns a request ID. Financial data is delivered via webhook or secure report once available.



## OpenAPI

````yaml post /aa/fi
openapi: 3.0.0
info:
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    email: developers@cashfree.com
    name: API Support
    url: https://discord.com/invite/QdZkNSxXsB
  title: Cashfree Verification API's.
  version: '2023-12-18'
  description: >-
    Cashfree's Verification APIs provide different types of verification to our
    merchants.
servers:
  - description: Sandbox Server
    url: https://sandbox.cashfree.com/verification
  - description: Production Server
    url: https://api.cashfree.com/verification
security: []
tags:
  - name: Aadhaar
    description: Operations related to Aadhaar verification.
  - name: BAV V2
    description: Operations related to Bank account verification v2.
  - name: PAN
    description: Operations related to PAN verification.
  - name: Digilocker
    description: Operations related to Digilocker verification.
  - name: E-sign
    description: Operations related to E-sign verification.
  - name: Reverse Penny Drop
    description: Operations related to Reverse Penny Drop verification.
  - name: UPI Penny Drop
    description: Operations related to UPI Penny Drop verification.
  - name: Mobile Penny Drop
    description: Operations related to Mobile Penny Drop verification.
  - name: IP
    description: Operation related to IP verification.
  - name: UPI
    description: Operations related to UPI verification.
  - name: Passport
    description: Operation related to Passport verification.
  - name: CIN
    description: Operation related to CIN verification.
  - name: Name Match
    description: Operation related to Name Match verification.
  - name: PAN to GSTIN
    description: Operation related to PAN to GSTIN.
  - name: Face Match
    description: Operation related to Face Match verification.
  - name: Voter ID
    description: Operation related to Voter ID verification.
  - name: Reverse Geocoding
    description: Operation related to Reverse Geocoding.
  - name: Vehicle RC
    description: Operation related to Vehicle RC verification.
  - name: Driving License
    description: Operation related to Driving License verification.
  - name: GSTIN
    description: Operation related to GSTIN verification.
  - name: Account Aggregator
    description: Operations related to Account aggregator.
  - name: OTPLess
    description: Operations related to OTPLess Verification.
  - name: 1-Click
    description: Operations related to 1-Click.
  - name: Smart OCR
    description: Operations related to Smart OCR.
  - name: Geocoding
    description: Operations related to Geocoding.
  - name: Udyam
    description: Operation related to Udyam verification.
  - name: PAN to Udyam
    description: Operation related to PAN to Udyam.
paths:
  /aa/fi:
    post:
      tags:
        - Account Aggregator
      summary: Request Financial Information
      description: >-
        Use this API to initiate a secure request for a user's financial
        information after obtaining valid consent by passing the consent ID and
        required data scopes.

        The request triggers a data-collection workflow and returns a request
        ID. Financial data is delivered via webhook or secure report once
        available.
      operationId: VrsAaRequestFi
      requestBody:
        $ref: '#/components/requestBodies/RequestFIRequest'
      responses:
        '200':
          $ref: '#/components/responses/RequestFiResponse'
        '400':
          $ref: '#/components/responses/Response400RequestFi'
        '401':
          $ref: '#/components/responses/Response401'
        '403':
          $ref: '#/components/responses/Response403'
        '409':
          $ref: '#/components/responses/Response409DuplicateIdRequestFi'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500V2'
        '502':
          $ref: '#/components/responses/Response502V2'
      security:
        - XClientID: []
          XClientSecret: []
components:
  requestBodies:
    RequestFIRequest:
      description: Find the request parameters to request FI for AA.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestFiRequestSchema'
          example:
            fi_verification_id: Fi_12345
            consent_verification_id: abc12345
            fi_from: '2023-01-01T00:00:00Z'
            fi_to: '2023-12-31T23:59:59Z'
  responses:
    RequestFiResponse:
      description: Consent created successfully.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FiResponseSchema'
          example:
            fi_verification_id: Fi_12345
            consent_verification_id: abc12345
            fi_ref_id: 12462
            fi_from: '2023-01-01T00:00:00Z'
            fi_to: '2023-12-31T23:59:59Z'
            status: PENDING
            fi_data: []
    Response400RequestFi:
      description: Validation errors for Request FI API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Verification ID missing:
              $ref: '#/components/examples/RequestFiVerificationIdMissing'
            Verification ID has special characters:
              $ref: >-
                #/components/examples/RequestFiVerificationIdWithSpecialCharacter
            Client ID/Client Secret Missing:
              $ref: '#/components/examples/XClientIdMissing'
            Using-Test-Credentials-in-Prod:
              $ref: '#/components/examples/UsingTestCredentialsInProd'
    Response401:
      description: Invalid client ID and client secret combination.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Invalid client ID and client secret combination:
              value:
                type: authentication_error
                code: authentication_failed
                message: Invalid clientId and clientSecret combination
    Response403:
      description: Authentication error (IP not whitelisted).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            IP not whitelisted:
              value:
                type: authentication_error
                code: ip_validation_failed
                message: >-
                  IP not whitelisted your current ip is 106.51.91.104.For IP
                  whitelisting assistance, visit our guide at
                  https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification
            x-cf-signature header missing:
              value:
                type: validation_error
                code: authentication_failed
                message: x-cf-signature missing in the request header
    Response409DuplicateIdRequestFi:
      description: Conflict error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Conflict Error:
              value:
                type: validation_error
                code: fi_verification_id_already_exists
                message: fi verification ID already exists
    Response422:
      description: >-
        Validation error because of insufficient balance to process this
        request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Insufficient balance:
              value:
                type: validation_error
                code: insufficient_balance
                message: Insufficient balance to process this request
    Response429:
      description: Rate limit exceed error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Rate limit error per operation:
              value:
                type: rate_limit_error
                code: too_many_requests_per_operation
                message: Too many requests for this operation, rate limit reached
            Rate limit error per IP:
              value:
                type: rate_limit_error
                code: too_many_requests_per_ip
                message: Too many requests from the IP, rate limit reached
    Response500V2:
      description: Internal error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Internal Server Error:
              value:
                type: internal_error
                code: verification_failed
                message: something went wrong
    Response502V2:
      description: Gateway error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Bad Gateway:
              value:
                type: internal_error
                code: verification_failed
                message: verification attempt failed
  schemas:
    RequestFiRequestSchema:
      required:
        - fi_verification_id
        - consent_verification_id
        - fi_from
        - fi_to
      type: object
      properties:
        fi_verification_id:
          type: string
          example: ''
          description: >-
            It is the unique ID you create to identify the financial information
            request. The maximum character limit is 50. Only alphaumeric, period
            (.), hyphen (-), and underscore ( _ ) are allowed.
        consent_verification_id:
          type: string
          example: ''
          description: >-
            It is the unique ID you created in the Request Consent API to
            identify the consent request.
        fi_from:
          type: string
          format: date-time
          description: >-
            It is the beginning date and time of the financial information you
            require.
          example: '2023-01-01T00:00:00Z'
        fi_to:
          type: string
          format: date-time
          description: >-
            It is the ending date and time of the financial information you
            require.
          example: '2023-12-31T23:59:59Z'
    FiResponseSchema:
      type: object
      properties:
        fi_verification_id:
          type: string
          example: abc123
          description: >-
            It is the unique ID you create to identify the financial information
            request. The maximum character limit is 50. Only alphaumeric, period
            (.), hyphen (-), and underscore ( _ ) are allowed.
        consent_verification_id:
          type: string
          example: def456
          description: >-
            It is the unique ID you created in the Request Consent API to
            identify the consent request.
        fi_ref_id:
          type: number
          example: 123456
          description: >-
            It displays the unique ID created by Cashfree Payments for reference
            purpose.
        status:
          type: string
          example: ACTIVE
          description: |-
            It displays the status of the financial information request.
                Possible values are

                - `SUCCESS`
                - `ACTIVE`
                - `FAILED`
                - `EXPIRED`
                - `PENDING`
        fi_from:
          type: string
          format: date-time
          description: >-
            It is the beginning date and time of the financial information you
            require.
          example: '2024-01-01T00:00:00Z'
        fi_to:
          type: string
          format: date-time
          description: >-
            It is the ending date and time of the financial information you
            require.
          example: '2024-12-31T23:59:59Z'
        fi_data:
          type: array
          items:
            $ref: '#/components/schemas/FIData'
    ErrorResponseSchema:
      type: object
      properties:
        code:
          type: string
          example: x-client-id_missing
        error:
          type: object
          example:
            ref_id: 102
        message:
          type: string
          example: x-client-id is missing in the request.
          description: It displays the outcome of the error.
        type:
          type: string
          example: validation_error
          description: It displays the type of error.
    FIData:
      type: object
      properties:
        fip_id:
          type: string
          example: FIP_1
          description: It displays the unique ID to identify the financial provider.
        accounts:
          type: array
          description: It displays the bank account information of the individual.
          items:
            $ref: '#/components/schemas/FiAccount'
    FiAccount:
      type: object
      properties:
        link_ref_number:
          type: string
          example: b2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b
          description: >-
            It displays the unique identifier associated to specific
            transactions.
        masked_acc_number:
          type: string
          example: XXXXXX4363
          description: It displays the masked bank account number of the individual.
        status:
          type: string
          example: DELIVERED
          description: |-
            It displays the status of the financial information request.

               Possible values are
               - `READY`
               - `DENIED`
               - `PENDING`
               - `DELIVERED`
               - `TIMEOUT`
        data:
          type: object
          nullable: true
          properties:
            account:
              $ref: '#/components/schemas/FiAccountData'
    FiAccountData:
      type: object
      properties:
        type:
          type: string
          example: DEPOSIT
        profile:
          type: object
          properties:
            holders:
              type: object
              properties:
                type:
                  type: string
                  example: SINGLE
                holder:
                  type: object
                  properties:
                    address:
                      type: string
                      example: >-
                        729, 2nd main 2nd Cross, 8th Block, Kormangala,
                        Bangalore - 560095
                    ckyc_compliance:
                      type: string
                      example: 'true'
                    dob:
                      type: string
                      example: '1960-08-15'
                    email:
                      type: string
                      example: dummymail@mail.com
                    landline:
                      type: string
                      example: ''
                    mobile:
                      type: string
                      example: '9876543219'
                    name:
                      type: string
                      example: Vinay Kumar
                    nominee:
                      type: string
                      example: REGISTERED
                    pan:
                      type: string
                      example: DUMPY0000A
        summary:
          type: object
          description: >-
            It contains the summary of the financial information of the
            individual.
          properties:
            current_balance:
              type: string
              example: '666.33'
            currency:
              type: string
              example: INR
            branch:
              type: string
              example: Kormangala 8th Block
            balance_date_time:
              type: string
              format: date-time
              example: '2020-06-22T07:50:00+00:00'
            current_od_limit:
              type: string
              example: '0'
            drawing_limit:
              type: string
              example: '0'
            exchange_rate:
              type: string
              example: ' '
            facility:
              type: string
              example: OD
            ifsc_code:
              type: string
              example: ICIC0004444
            micr_code:
              type: string
              example: '5898240246'
            opening_date:
              type: string
              example: '2002-07-06'
            status:
              type: string
              example: ACTIVE
            type:
              type: string
              example: SAVINGS
            pending:
              type: object
              properties:
                transaction_type:
                  type: string
                  example: DEBIT
                amount:
                  type: string
                  example: '0'
        transactions:
          type: object
          description: It contains the transactional information of the individual.
          properties:
            start_date:
              type: string
              example: '2022-04-01'
            end_date:
              type: string
              example: '2022-08-30'
            transaction:
              type: array
              items:
                type: object
                properties:
                  amount:
                    type: string
                    example: '129'
                  current_balance:
                    type: string
                    example: '567.25'
                  mode:
                    type: string
                    example: UPI
                  narration:
                    type: string
                    example: UPI/9876543219/getsimpl/simpl@axisbank/Axis Bank
                  reference:
                    type: string
                    example: RFN00076583
                  transaction_timestamp:
                    type: string
                    format: date-time
                    example: '2021-04-01T13:20:14+05:30'
                  txn_id:
                    type: string
                    example: M3256752
                  type:
                    type: string
                    example: DEBIT
                  value_date:
                    type: string
                    example: '2022-04-01'
  examples:
    RequestFiVerificationIdMissing:
      value:
        type: validation_error
        code: fi_verification_id_missing
        message: fi_verification_id is missing in the request.
    RequestFiVerificationIdWithSpecialCharacter:
      value:
        type: validation_error
        code: fi_verification_id_value_invalid
        message: >-
          fi_verification_id can include only alphanum, dot, hyphen and
          underscores.
    XClientIdMissing:
      value:
        type: validation_error
        code: x-client-id_missing
        message: x-client-id is missing in the request.
    UsingTestCredentialsInProd:
      value:
        type: validation_error
        code: x-client-secret_value_invalid
        message: Client secret belongs to test environment
  securitySchemes:
    XClientID:
      type: apiKey
      in: header
      name: x-client-id
      description: >-
        Your unique client identifier issued by Cashfree. You can find this in
        your [Merchant
        Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).
    XClientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: >-
        The secret key associated with your client ID. Use this to authenticate
        your API requests. You can find this in your [Merchant
        Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).

````