v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
Collection Intelligence

Collection Intelligence

Fetches collection intelligence using mobile, PAN, address and/or name. Either mobile or pan is required.

post/verify/collection_intelligence

Request body

client_ref_numstring

Optional client reference number

mobilestring

10-digit mobile number. Either mobile or pan is required.

panstring

PAN number. Either mobile or pan is required.

addressstring[]
namestring

Person name

Example request

{
  "client_ref_num": "REF12345",
  "mobile": "9876543210",
  "pan": "ABCDE1234F",
  "address": [
    "221B MG Road, Bengaluru"
  ],
  "name": "Rahul Sharma"
}

Response

Collection intelligence result

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"
}