Bank Statement PDF

Fetch bank statement PDF report

Fetches a processed bank statement report for a completed session. The response may be JSON or downloadable file content depending on report_type.

post/verify/bank_statement_pdf/report

Request

  • Base URL
    https://prod.idto.ai
  • URL
    https://prod.idto.ai/verify/bank_statement_pdf/report
  • Auth
    API key in header X-API-KEY and API key in header X-Client-ID

Request body

session_idstring uuid required

IDTO bank statement session ID

report_type'json' | 'xlsx'

Report format. Supported values are json and xlsx.

report_subtype'type1' | 'type2' | 'type3'

Optional report subtype. JSON supports type1, type2, and type3. XLSX supports type3.

Example request

{
  "report_type": "json",
  "report_subtype": "type1"
}

Response

Report returned as JSON or file content

statusstring

Result status, usually success or failed

messagestring

Human-readable result message

resultobject
dataobject
error_codestring nullable

Provider or IDTO error code

tranx_idstring nullable

Transaction identifier

timestampstring date-time nullable

Response timestamp

chargeblestring

Billing flag returned by existing APIs

user_consentstring

Consent flag returned by existing APIs

Example response

{
  "status": "success",
  "message": "Verification completed successfully",
  "error_code": "IDTO_400",
  "chargeble": "true",
  "user_consent": "true"
}

Changes

No recorded changes to this operation across all 1 revision of this API.