Bank Statement PDF

Start bank statement PDF upload

Initializes a bank statement PDF upload session and returns an IDTO session_id used by the remaining bank statement APIs.

post/verify/bank_statement_pdf/start_upload

Request

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

Request body

client_ref_numstring

Optional merchant reference number

txn_completed_cburlstring uri

Callback URL for transaction completion

institution_idstring

Institution ID selected from the institutions API

start_monthstring

Statement start month

end_monthstring

Statement end month

acceptance_policystring

Vendor acceptance policy

relaxation_daysstring

Relaxation days accepted by provider

employer_namestring

Employer name for salary analysis

Example request

{
  "client_ref_num": "BS-REF-001",
  "txn_completed_cburl": "https://example.com/bank-statement/callback",
  "institution_id": "101",
  "start_month": "2024-01",
  "end_month": "2024-06",
  "acceptance_policy": "atLeastOneTransactionInRange",
  "relaxation_days": "5",
  "employer_name": "Example Pvt Ltd"
}

Response

Upload session initialized

statusstring
messagestring
chargeblestring
user_consentstring

Example response

{
  "status": "success",
  "message": "Upload session initialized",
  "data": {
    "status": "started"
  },
  "chargeble": "true",
  "user_consent": "true"
}

Changes

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