Bank Account Verification

6 endpoints · Core API

This API enables businesses to validate bank accounts swiftly and accurately. By leveraging this API, companies can ensure compliance with regulations, mitigate fraud risks, and streamline their customer onboarding processes effectively. Additionally, the API reduces manual errors, enhances operational efficiency, and improves overall customer experience.

Benefits

Compliance assurance
Fraud risk mitigation
Streamlined onboarding processes
Enhanced operational efficiency

What you can do

API for verifying bank account holder name using IFSC and account number as the basis

POST

/api/v1/Bank/account/verify

Get Bank account verify details

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v1-bank-account-verify

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
accountNumber
stringrequired
Required. Bank account number to verify, 9 to 18 digits (digits only, no spaces or hyphens).
minLength 1pattern ^\d{9,18}$default 123456789012
ifsc
stringrequired
Required. 11-character IFSC of the bank branch, in uppercase: 4 letters, the digit 0, then 6 letters or digits (for example SBIN0001234).
length 11pattern ^[A-Z]{4}0[A-Z0-9]{6}$default SBIN0001234

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
Response model containing the results of a lightweight bank account verification.
5 fields
- bankResponse
  stringoptional
  Gets or sets the response message from the bank.
  nullable
- accountName
  stringoptional
  Gets or sets the name associated with the bank account.
  nullable
- accountNumber
  stringoptional
  Gets or sets the verified bank account number.
  nullable
- ifsc
  stringoptional
  Gets or sets the IFSC code of the bank branch.
  nullable
- bankTxnStatus
  booleanoptional
  Gets or sets a value indicating whether the bank transaction was successful.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "bankResponse": "string", "accountName": "string", "accountNumber": "string", "ifsc": "string", "bankTxnStatus": false }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v1/Bank/account/verify' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }'

POST

/api/v1/Bank/account/verify/silent

Get Bank account verify details without penny drop

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v1-bank-account-verify-silent

Tries a check without a transfer first. If that check fails or returns no result, the call falls back to a ₹1 penny drop (the same check as account/verify), which sends real money to the account and returns no bank RRN.

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
accountNumber
stringrequired
Required. Bank account number to verify, 9 to 18 digits (digits only, no spaces or hyphens).
minLength 1pattern ^\d{9,18}$default 123456789012
ifsc
stringrequired
Required. 11-character IFSC of the bank branch, in uppercase: 4 letters, the digit 0, then 6 letters or digits (for example SBIN0001234).
length 11pattern ^[A-Z]{4}0[A-Z0-9]{6}$default SBIN0001234

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
Response model containing the results of a silent bank account verification.
6 fields
- bankResponse
  stringoptional
  Gets or sets the response message from the bank.
  nullable
- accountName
  stringoptional
  Gets or sets the name associated with the bank account.
  nullable
- accountNumber
  stringoptional
  Gets or sets the verified bank account number.
  nullable
- ifsc
  stringoptional
  Gets or sets the IFSC code of the bank branch.
  nullable
- bankRRN
  stringoptional
  Gets or sets the bank retrieval reference number for the transaction.
  nullable
- bankTxnStatus
  booleanoptional
  Gets or sets a value indicating whether the bank transaction was successful.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "bankResponse": "string", "accountName": "string", "accountNumber": "string", "ifsc": "string", "bankRRN": "string", "bankTxnStatus": false }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v1/Bank/account/verify/silent' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }'

POST

/api/v1/Bank/account/verify/advanced

Get Bank Account Verify Advanced details

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v1-bank-account-verify-advanced

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
accountNumber
stringrequired
Required. Bank account number to verify, 9 to 18 digits (digits only, no spaces or hyphens).
minLength 1pattern ^\d{9,18}$default 123456789012
ifsc
stringrequired
Required. 11-character IFSC of the bank branch, in uppercase: 4 letters, the digit 0, then 6 letters or digits (for example SBIN0001234).
length 11pattern ^[A-Z]{4}0[A-Z0-9]{6}$default SBIN0001234
accountHolderName
stringoptional
Optional. Account holder name to match against the bank record. When omitted or empty, no name match is performed.
nullable

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
Response model containing the results of an advanced bank account verification.
6 fields
- accountNumber
  stringoptional
  Gets or sets the verified bank account number.
  nullable
- ifsc
  stringoptional
  Gets or sets the IFSC code of the bank branch.
  nullable
- accountName
  stringoptional
  Gets or sets the name associated with the bank account.
  nullable
- bankResponse
  stringoptional
  Gets or sets the response message from the bank.
  nullable
- bankTxnStatus
  booleanoptional
  Gets or sets a value indicating whether the bank transaction was successful.
- bankRRN
  stringoptional
  Gets or sets the bank retrieval reference number for the transaction.
  nullable
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "accountNumber": "string", "ifsc": "string", "accountName": "string", "bankResponse": "string", "bankTxnStatus": false, "bankRRN": "string" }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v1/Bank/account/verify/advanced' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }'

POST

/api/v2/Bank/account/verify/advanced

Get Bank Account Verify Advance details (V2)

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v2-bank-account-verify-advanced

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Query parameters

api-version
stringoptional
No description.

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
accountNumber
stringrequired
Required. Bank account number to verify, 9 to 18 digits (digits only, no spaces or hyphens).
minLength 1pattern ^\d{9,18}$default 123456789012
ifsc
stringrequired
Required. 11-character IFSC of the bank branch, in uppercase: 4 letters, the digit 0, then 6 letters or digits (for example SBIN0001234).
length 11pattern ^[A-Z]{4}0[A-Z0-9]{6}$default SBIN0001234
accountHolderName
stringoptional
Optional. Account holder name to match against the bank record. When omitted or empty, no name match is performed.
nullable
isPennyDrop
booleanoptional
Optional. Set to true to verify with a Rs 1 penny drop transfer; false (the default) verifies without a transfer.

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
No description.
8 fields
- bank_ref_no
  stringoptional
  No description.
  nullable
- beneficiary_name
  stringoptional
  No description.
  nullable
- transaction_remark
  stringoptional
  No description.
  nullable
- verification_status
  stringoptional
  No description.
  nullable
- name_match_score
  stringoptional
  No description.
  nullable
- is_name_match
  booleanoptional
  No description.
- is_penny_drop
  booleanoptional
  No description.
- ifscDetails
  objectoptional
  No description.
  16 fields
  ifsc
  stringoptional
  No description.
  nullable
  name
  stringoptional
  No description.
  nullable
  branch
  stringoptional
  No description.
  nullable
  center
  stringoptional
  No description.
  nullable
  district
  stringoptional
  No description.
  nullable
  state
  stringoptional
  No description.
  nullable
  address
  stringoptional
  No description.
  nullable
  contact
  stringoptional
  No description.
  nullable
  imps
  booleanoptional
  No description.
  rtgs
  booleanoptional
  No description.
  city
  stringoptional
  No description.
  nullable
  iso3166
  stringoptional
  No description.
  nullable
  neft
  booleanoptional
  No description.
  micr
  stringoptional
  No description.
  nullable
  upi
  booleanoptional
  No description.
  swift
  stringoptional
  No description.
  nullable
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "bank_ref_no": "string", "beneficiary_name": "string", "transaction_remark": "string", "verification_status": "string", "name_match_score": "string", "is_name_match": false, "is_penny_drop": false, "ifscDetails": { "ifsc": "string", "name": "string", "branch": "string", "center": "string", "district": "string", "state": "string", "address": "string", "contact": "string", "imps": false, "rtgs": false, "city": "string", "iso3166": "string", "neft": false, "micr": "string", "upi": false, "swift": "string" } }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v2/Bank/account/verify/advanced' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "accountNumber": "123456789012", "ifsc": "SBIN0001234" }'

POST

/api/v1/Bank/statement-analyser/corporate

Corporate Bank Statement Analyser

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v1-bank-statement-analyser-corporate

Submits a bank statement PDF for analysis and returns an orderId. The analysis runs in the background and usually takes a few minutes.

How to use it:

Call this API with the PDF as Base64 (file_base64), plus password if the PDF is protected.
Keep the orderId from the response.
After a few minutes, call Corporate Bank Statement Analyser Details with that orderId. While it is still processing, the response says so; call again later.
Once it is ready, the details call returns the report as JSON.

If the statement cannot be accepted (for example an unreadable file), the error is returned here and no orderId is created.

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
file_base64
stringrequired
Required. The bank statement PDF as a standard Base64 string (no "data:" prefix). Replace the sample with the real file content.
minLength 1pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2…default JVBERi0xLjQK
account_type
stringoptional
Optional. Account type (e.g. "savings", "current"). Leave empty when not known.
nullable
password
stringoptional
Optional. Password of the PDF. Leave it out or empty when the PDF is not protected.
nullable
webhook_url
stringoptional
Optional. Your HTTPS endpoint to receive a push notification when the analysis is ready. When provided, we post a JSON payload to this URL once the analysis is complete or has failed — so you do not need to poll the details API repeatedly. Payload: { "orderId": "...", "isProcessed": true/false, "message": "..." }
nullable

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "file_base64": "JVBERi0xLjQK" }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
Response of Corporate Bank Statement Analyser: the order to fetch the analysis with.
1 field
- orderId
  stringoptional
  The order id. Send it as `order_id` to the details API.
  nullable
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "orderId": "string" }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v1/Bank/statement-analyser/corporate' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "file_base64": "JVBERi0xLjQK" }'

POST

/api/v1/Bank/statement-analyser-details/corporate

Corporate Bank Statement Analyser Details

docs.signcare.io/core/api/bank-account/bank-account-verification/#post-api-v1-bank-statement-analyser-details-corporate

Call with the order_id returned by the analyser. While the statement is still being processed, the response says so and data is empty; call again later, or wait for your webhook.

Send response_type = "json": the full analysis comes back in analysis_json. Excel output is no longer supported; "excel" is rejected with 400, and base64 is ignored.

Headers

X-API-KEY
stringrequired
Your secret API key for the environment you are calling (Stage and Live use different keys).
X-API-APP-ID
stringrequired
The App ID issued together with the key.
Content-Type
stringrequired
application/json

Body parameters

application/json

consent
stringrequired
Required. The end user's consent to this verification. Send `Y`.
minLength 1default Y
consent_text
stringrequired
Required. The consent statement shown to the end user. Send the default text from the sample.
minLength 1default I hear by declare my consent agreeme…
request_id
stringoptional
Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
nullable
order_id
stringrequired
Required. The `orderId` returned by Corporate Bank Statement Analyser (a GUID). An unknown or malformed id returns 400.
minLength 1
response_type
stringrequired
Required. Must be "json" (not case sensitive): returns the full analysis in `analysis_json`. Excel output is no longer supported: "excel", or any other value, is rejected with 400.
minLength 1default json
base64
booleanoptional
Not used. It belonged to the Excel output, which is no longer supported; any value is ignored. Kept so existing requests that send it still work.
default false

Sample request body

{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "order_id": "string", "response_type": "json", "base64": false }

Responses

200OK

success
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 200
message
stringoptional
No description.
nullabledefault XXXXX
data
objectoptional
Result of a completed corporate bank statement analysis. `analysis_json` is always returned, in the same shape for every order. `ts_analysis` (extended analytics) is optional: present only when the order produced it, so check for null before reading it. `tbx_details` is not returned at present.
3 fields
- analysis_json
  objectoptional
  Root of the bank statement analysis.
  2 fields
  analytics
  objectoptional
  No description.
  1 field
  consumer
  objectoptional
  No description.
  10 fields
  base
  objectoptional
  No description.
  1 field
  subject
  objectoptional
  The analysed person or business, across every connected account.
  4 fields
  subjectId
  stringoptional
  No description.
  nullable
  dataPeriod
  objectoptional
  Period a subject, connection or account covers.
  4 fields
  startDate
  stringoptional
  No description.
  nullable
  endDate
  stringoptional
  No description.
  nullable
  daysCount
  integer (int32)optional
  No description.
  nullable
  fullMonthCount
  integer (int32)optional
  No description.
  nullable
  kpi
  objectoptional
  No description.
  7 fields
  countriesCount
  integer (int32)optional
  No description.
  nullable
  providersCount
  integer (int32)optional
  No description.
  nullable
  accountsCount
  integer (int32)optional
  No description.
  nullable
  significantAccountsCount
  integer (int32)optional
  No description.
  nullable
  balance
  objectoptional
  No description.
  5 fields
  totalBalanceAmount
  number (double)optional
  No description.
  nullable
  averageBalanceAmount
  number (double)optional
  No description.
  nullable
  medianBalanceAmount
  number (double)optional
  No description.
  nullable
  minBalanceAmount
  number (double)optional
  No description.
  nullable
  maxBalanceAmount
  number (double)optional
  No description.
  nullable
  periodTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  monthlyTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  connections
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  connectionId
  stringoptional
  No description.
  nullable
  dataPeriod
  objectoptional
  Period a subject, connection or account covers.
  4 fields
  startDate
  stringoptional
  No description.
  nullable
  endDate
  stringoptional
  No description.
  nullable
  daysCount
  integer (int32)optional
  No description.
  nullable
  fullMonthCount
  integer (int32)optional
  No description.
  nullable
  kpi
  objectoptional
  No description.
  6 fields
  accountsCount
  integer (int32)optional
  No description.
  nullable
  significantAccountsCount
  integer (int32)optional
  No description.
  nullable
  maximumSignificanceIndex
  number (double)optional
  No description.
  nullable
  balance
  objectoptional
  No description.
  5 fields
  totalBalanceAmount
  number (double)optional
  No description.
  nullable
  averageBalanceAmount
  number (double)optional
  No description.
  nullable
  medianBalanceAmount
  number (double)optional
  No description.
  nullable
  minBalanceAmount
  number (double)optional
  No description.
  nullable
  maxBalanceAmount
  number (double)optional
  No description.
  nullable
  periodTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  monthlyTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  accounts
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  accountId
  stringoptional
  No description.
  nullable
  warnings
  objectoptional
  No description.
  1 field
  withoutTransactions
  booleanoptional
  No description.
  nullable
  dataPeriod
  objectoptional
  Period a subject, connection or account covers.
  4 fields
  startDate
  stringoptional
  No description.
  nullable
  endDate
  stringoptional
  No description.
  nullable
  daysCount
  integer (int32)optional
  No description.
  nullable
  fullMonthCount
  integer (int32)optional
  No description.
  nullable
  kpi
  objectoptional
  No description.
  7 fields
  balance
  objectoptional
  No description.
  5 fields
  totalBalanceAmount
  number (double)optional
  No description.
  nullable
  averageBalanceAmount
  number (double)optional
  No description.
  nullable
  medianBalanceAmount
  number (double)optional
  No description.
  nullable
  minBalanceAmount
  number (double)optional
  No description.
  nullable
  maxBalanceAmount
  number (double)optional
  No description.
  nullable
  periodTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  monthlyTransactionsCount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  income
  number (double)optional
  No description.
  nullable
  expenses
  number (double)optional
  No description.
  nullable
  significanceIndex
  number (double)optional
  No description.
  nullable
  newestTransactionDays
  integer (int32)optional
  No description.
  nullable
  oldestTransactionDays
  integer (int32)optional
  No description.
  nullable
  overdraft
  objectoptional
  No description.
  1 field
  flagCreditLimit
  booleanoptional
  No description.
  nullable
  identity
  objectoptional
  No description.
  2 fields
  verification
  stringoptional
  No description.
  nullable
  soleTrader
  booleanoptional
  No description.
  nullable
  risk
  objectoptional
  No description.
  2 fields
  indebtedness
  objectoptional
  No description.
  3 fields
  cardInstalment
  objectoptional
  Totals and monthly averages for one kind of transaction.
  4 fields
  periodTotalTransactionsAmount
  number (double)optional
  No description.
  nullable
  periodTotalTransactionsCount
  integer (int32)optional
  No description.
  nullable
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  total
  objectoptional
  Totals and monthly averages for one kind of transaction.
  4 fields
  periodTotalTransactionsAmount
  number (double)optional
  No description.
  nullable
  periodTotalTransactionsCount
  integer (int32)optional
  No description.
  nullable
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  incomeRatio
  number (double)optional
  No description.
  nullable
  cash
  objectoptional
  No description.
  1 field
  withdrawal
  objectoptional
  No description.
  7 fields
  periodTotalTransactionsAmount
  number (double)optional
  No description.
  nullable
  periodTotalTransactionsCount
  integer (int32)optional
  No description.
  nullable
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  regularity
  number (double)optional
  No description.
  nullable
  expensesRatio
  number (double)optional
  No description.
  nullable
  incomeRatio
  number (double)optional
  No description.
  nullable
  cashFlow
  objectoptional
  No description.
  3 fields
  monthlyAnalysis
  array<object>optional
  No description.
  nullable
  Each item: 11 fields
  month
  stringoptional
  Month as "yyyy-MM".
  nullable
  fullMonth
  booleanoptional
  False for a month the statement only partly covers.
  nullable
  incomeAmount
  number (double)optional
  No description.
  nullable
  incomeByCategory
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  code
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  expensesAmount
  number (double)optional
  No description.
  nullable
  expensesByCategory
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  code
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  savingAmount
  number (double)optional
  No description.
  nullable
  savingRatio
  number (double)optional
  No description.
  nullable
  incomeExpensesRatio
  number (double)optional
  No description.
  nullable
  overdraft
  objectoptional
  No description.
  1 field
  balanceBelowZeroDays
  integer (int32)optional
  No description.
  nullable
  balance
  objectoptional
  No description.
  6 fields
  openingBalanceAmount
  number (double)optional
  No description.
  nullable
  closingBalanceAmount
  number (double)optional
  No description.
  nullable
  averageBalanceAmount
  number (double)optional
  No description.
  nullable
  medianBalanceAmount
  number (double)optional
  No description.
  nullable
  minimumBalanceAmount
  number (double)optional
  No description.
  nullable
  maximumBalanceAmount
  number (double)optional
  No description.
  nullable
  periodAnalysis
  objectoptional
  No description.
  8 fields
  incomeAmount
  objectoptional
  No description.
  6 fields
  total
  number (double)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  minimum
  number (double)optional
  No description.
  nullable
  maximum
  number (double)optional
  No description.
  nullable
  consistency
  number (double)optional
  No description.
  nullable
  incomeByCategory
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  code
  stringoptional
  No description.
  nullable
  amount
  objectoptional
  No description.
  4 fields
  total
  number (double)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  stability
  number (double)optional
  No description.
  nullable
  count
  objectoptional
  No description.
  4 fields
  total
  integer (int32)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  regularity
  number (double)optional
  No description.
  nullable
  outlier
  objectoptional
  No description.
  2 fields
  transactionId
  stringoptional
  No description.
  nullable
  deviation
  number (double)optional
  No description.
  nullable
  expensesAmount
  objectoptional
  No description.
  6 fields
  total
  number (double)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  minimum
  number (double)optional
  No description.
  nullable
  maximum
  number (double)optional
  No description.
  nullable
  consistency
  number (double)optional
  No description.
  nullable
  expensesByCategory
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  code
  stringoptional
  No description.
  nullable
  amount
  objectoptional
  No description.
  4 fields
  total
  number (double)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  stability
  number (double)optional
  No description.
  nullable
  count
  objectoptional
  No description.
  4 fields
  total
  integer (int32)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  regularity
  number (double)optional
  No description.
  nullable
  outlier
  objectoptional
  No description.
  2 fields
  transactionId
  stringoptional
  No description.
  nullable
  deviation
  number (double)optional
  No description.
  nullable
  savingAmount
  objectoptional
  No description.
  3 fields
  total
  number (double)optional
  No description.
  nullable
  average
  number (double)optional
  No description.
  nullable
  median
  number (double)optional
  No description.
  nullable
  savingRatio
  number (double)optional
  No description.
  nullable
  incomeExpensesRatio
  number (double)optional
  No description.
  nullable
  monthsWithNegativeSavingCount
  integer (int32)optional
  No description.
  nullable
  insights
  objectoptional
  No description.
  7 fields
  recurringExpenses
  objectoptional
  No description.
  2 fields
  data
  array<object>optional
  No description.
  nullable
  Each item: 10 fields
  descriptionSource
  stringoptional
  No description.
  nullable
  monthlyAverageAmount
  number (double)optional
  No description.
  nullable
  matchedTransactions
  array<string>optional
  Ids of the matching transactions in `categorizedTransactions`.
  nullable
  matchedTransactionsCount
  integer (int32)optional
  No description.
  nullable
  averageGapDays
  number (double)optional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  consistency
  number (double)optional
  No description.
  nullable
  longevity
  number (double)optional
  No description.
  nullable
  fluctuationDays
  number (double)optional
  No description.
  nullable
  recurringOwner
  objectoptional
  No description.
  2 fields
  name
  stringoptional
  No description.
  nullable
  source
  stringoptional
  No description.
  nullable
  totalAmount
  number (double)optional
  No description.
  nullable
  bestAccountDirectDebit
  objectoptional
  Best account and day of month to schedule a direct debit.
  3 fields
  accountId
  stringoptional
  No description.
  nullable
  day
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  expensesRunwayMonths
  number (double)optional
  No description.
  nullable
  savingRunwayMonths
  number (double)optional
  No description.
  nullable
  currentMonth
  objectoptional
  No description.
  4 fields
  month
  stringoptional
  No description.
  nullable
  income
  objectoptional
  No description.
  2 fields
  expectedAmount
  number (double)optional
  No description.
  nullable
  actualAmount
  number (double)optional
  No description.
  nullable
  expenses
  objectoptional
  No description.
  2 fields
  expectedAmount
  number (double)optional
  No description.
  nullable
  actualAmount
  number (double)optional
  No description.
  nullable
  saving
  objectoptional
  No description.
  2 fields
  expectedAmount
  number (double)optional
  No description.
  nullable
  actualAmount
  number (double)optional
  No description.
  nullable
  forecast
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  month
  stringoptional
  No description.
  nullable
  incomeExpectedAmount
  number (double)optional
  No description.
  nullable
  expensesExpectedAmount
  number (double)optional
  No description.
  nullable
  savingExpectedAmount
  number (double)optional
  No description.
  nullable
  balanceExpectedAmount
  number (double)optional
  No description.
  nullable
  monthlyAffordableAmount
  number (double)optional
  No description.
  nullable
  marketing
  objectoptional
  No description.
  14 fields
  car
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  house
  objectoptional
  No description.
  2 fields
  houseLiving
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  tenant
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  creditCard
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  fashion
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  traveling
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  digital
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  telco
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  socialLife
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  health
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  investmentAndTrading
  objectoptional
  No description.
  2 fields
  income
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  expenses
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  tax
  objectoptional
  No description.
  2 fields
  monthlyAverageTransactionsAmount
  number (double)optional
  No description.
  nullable
  monthlyAverageTransactionsCount
  number (double)optional
  No description.
  nullable
  flagSalary
  booleanoptional
  No description.
  nullable
  flagPension
  booleanoptional
  No description.
  nullable
  flagSocialWelfare
  booleanoptional
  No description.
  nullable
  documentAuthenticity
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  fileName
  stringoptional
  No description.
  nullable
  suspiciousAuthorFlag
  booleanoptional
  No description.
  nullable
  dateModifiedFlag
  booleanoptional
  No description.
  nullable
  score
  objectoptional
  Transaction score, e.g. 690 / "Low" / tranche 4.
  3 fields
  transactionScore
  number (double)optional
  No description.
  nullable
  area
  stringoptional
  No description.
  nullable
  tranche
  integer (int32)optional
  No description.
  nullable
  statisticalAnalysis
  objectoptional
  No description.
  1 field
  accountAnalysis
  array<object>optional
  No description.
  nullable
  Each item: 2 fields
  accountId
  stringoptional
  No description.
  nullable
  kpi
  objectoptional
  No description.
  2 fields
  periodAnalysis
  objectoptional
  No description.
  10 fields
  balance
  objectoptional
  No description.
  3 fields
  averageBalanceAmount3M
  number (double)optional
  No description.
  nullable
  averageBalanceAmount6M
  number (double)optional
  No description.
  nullable
  averageBalanceAmount12M
  number (double)optional
  No description.
  nullable
  customBalance
  objectoptional
  No description.
  3 fields
  averageBalanceAmountCustom3M
  number (double)optional
  No description.
  nullable
  averageBalanceAmountCustom6M
  number (double)optional
  No description.
  nullable
  averageBalanceAmountCustom12M
  number (double)optional
  No description.
  nullable
  credit
  objectoptional
  No description.
  3 fields
  averageCreditAmount3M
  number (double)optional
  No description.
  nullable
  averageCreditAmount6M
  number (double)optional
  No description.
  nullable
  averageCreditAmount12M
  number (double)optional
  No description.
  nullable
  inwardReturnCount
  integer (int32)optional
  No description.
  nullable
  outwardReturnCount
  integer (int32)optional
  No description.
  nullable
  inwardReturnAmount
  number (double)optional
  No description.
  nullable
  outwardReturnAmount
  number (double)optional
  No description.
  nullable
  topBuyer
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  counterparty
  stringoptional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  topSupplier
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  counterparty
  stringoptional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  emiTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  monthlyAnalysis
  array<object>optional
  No description.
  nullable
  Each item: 19 fields
  month
  stringoptional
  Month as "yyyy-MM".
  nullable
  fullMonth
  booleanoptional
  No description.
  nullable
  balances
  objectoptional
  No description.
  4 fields
  averageDailyBalance
  number (double)optional
  No description.
  nullable
  averageBankBalanceWoLoan
  number (double)optional
  No description.
  nullable
  averageBalanceCustom
  array<object>optional
  Balance on fixed days of the month, keyed by day: "5", "10", "15", "20", "25", "30". The keys are numbers, so this is a dictionary rather than properties.
  nullable
  eodBalances
  objectoptional
  End-of-day balance statistics for the month.
  4 fields
  minimum
  number (double)optional
  No description.
  nullable
  maximum
  number (double)optional
  No description.
  nullable
  negativeCount
  integer (int32)optional
  No description.
  nullable
  monthlyAverageNegative
  number (double)optional
  No description.
  nullable
  upiCredits
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  day
  integer (int32)optional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  dailyBalances
  array<object>optional
  No description.
  nullable
  Each item: 2 fields
  day
  integer (int32)optional
  No description.
  nullable
  balance
  number (double)optional
  No description.
  nullable
  analysisData
  array<object>optional
  No description.
  nullable
  Each item: 15 fields
  creditTransactions
  objectoptional
  No description.
  7 fields
  totalCreditTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  netCreditTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  creditInternalTransfer
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  tradeCreditTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  nonTradeCreditTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  interestReceivedTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  incomeTransactions
  objectoptional
  No description.
  4 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  salaryAmount
  number (double)optional
  No description.
  nullable
  otherIncomeAmount
  number (double)optional
  No description.
  nullable
  debitTransactions
  objectoptional
  No description.
  7 fields
  totalDebitTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  netDebitTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  debitInternalTransfer
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  tradeDebitTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  nonTradeDebitTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  interestPaid
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  expenseTransaction
  objectoptional
  No description.
  3 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  averageBankExpense
  number (double)optional
  No description.
  nullable
  chequeTransactions
  objectoptional
  No description.
  7 fields
  chequeReturnCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chequeBounceInward
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chequeBounceOutward
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  technicalChequeBounce
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  nonTechnicalChequeBounce
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chequeIssue
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chequeDeposit
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  upiTransactions
  objectoptional
  No description.
  3 fields
  inwardUPITransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  outwardUPITransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  UPISettlement
  objectoptional
  No description.
  3 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  uniqueDays
  integer (int32)optional
  No description.
  nullable
  marketingTransactions
  objectoptional
  No description.
  3 fields
  liquor
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  onlineGaming
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  investment
  objectoptional
  Money put into investments (count/amount) and money coming back from them (income).
  3 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  income
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  cashTransactions
  objectoptional
  No description.
  2 fields
  cashWithdrawals
  objectoptional
  No description.
  3 fields
  totalCashWithdrawals
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  atmCashWithdrawals
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  atmWithdrawalAbove2000
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  cashDeposits
  objectoptional
  No description.
  4 fields
  totalCashDeposits
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  depositRange9to10L
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  depositRange40to50K
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  percentageOfTotalCredit
  number (double)optional
  No description.
  nullable
  paymentBounceTransactions
  objectoptional
  No description.
  4 fields
  inwardPaymentBounceCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  outwardPaymentBounceCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  paymentBounceCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  emiBounce
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  paymentTransactions
  objectoptional
  No description.
  3 fields
  ecsNachTransaction
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  achPayment
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  standingInstructionsPayment
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chargesTransactions
  objectoptional
  No description.
  3 fields
  penalCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  bankCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  minimumBalanceCharges
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  customerAndSystemTransactions
  objectoptional
  No description.
  2 fields
  systemInitiatedTransaction
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  customerInitiatedTransaction
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  reversalTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  emiTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  loanDisbursalTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  cardSettlementTransactions
  objectoptional
  Number and total value of one kind of transaction. The most common shape in this section.
  2 fields
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  overdraftTransactions
  objectoptional
  No description.
  7 fields
  averageUtilization
  objectoptional
  No description.
  1 field
  amount
  number (double)optional
  No description.
  nullable
  sanctionLimit
  objectoptional
  No description.
  1 field
  amount
  number (double)optional
  No description.
  nullable
  averageUtilizationPercentage
  objectoptional
  No description.
  1 field
  count
  number (double)optional
  No description.
  nullable
  peakUtilisationLimit
  objectoptional
  No description.
  1 field
  amount
  number (double)optional
  No description.
  nullable
  peakODCCUsage
  objectoptional
  No description.
  1 field
  amount
  number (double)optional
  No description.
  nullable
  overdrawnDays
  objectoptional
  No description.
  1 field
  count
  number (double)optional
  No description.
  nullable
  interestDelayedDays
  integer (int32)optional
  No description.
  nullable
  funds
  array<object>optional
  No description.
  nullable
  Each item: 2 fields
  fundsRemittance
  objectoptional
  No description.
  2 fields
  totalAmount
  number (double)optional
  No description.
  nullable
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  fundsReceived
  objectoptional
  No description.
  2 fields
  totalAmount
  number (double)optional
  No description.
  nullable
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  topBuyer
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  counterparty
  stringoptional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  topSupplier
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  counterparty
  stringoptional
  No description.
  nullable
  count
  integer (int32)optional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  chequeTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  excludedFromNetCreditDebitTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  internalTransferTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  achTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  standingInstructionsTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  paymentBounceTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  emiBounceTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  ecsNachTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  upiTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  emiTransactionsList
  array<object>optional
  No description.
  nullable
  Each item: 1 field
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  id
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  fraudIndicators
  array<object>optional
  No description.
  nullable
  Each item: 2 fields
  accountId
  stringoptional
  No description.
  nullable
  fraud
  array<object>optional
  No description.
  nullable
  Each item: 5 fields
  fraudId
  stringoptional
  No description.
  nullable
  fraudCategory
  stringoptional
  No description.
  nullable
  identified
  stringoptional
  No description.
  nullable
  fraudType
  stringoptional
  No description.
  nullable
  fraudDesc
  stringoptional
  No description.
  nullable
  customerProfile
  array<object>optional
  No description.
  nullable
  Each item: 11 fields
  accountId
  stringoptional
  No description.
  nullable
  bank
  stringoptional
  No description.
  nullable
  address
  stringoptional
  No description.
  nullable
  dob
  stringoptional
  No description.
  nullable
  accountType
  stringoptional
  No description.
  nullable
  name
  stringoptional
  No description.
  nullable
  mobile
  stringoptional
  No description.
  nullable
  accountOpeningDate
  stringoptional
  No description.
  nullable
  pan
  stringoptional
  No description.
  nullable
  ifsc
  stringoptional
  No description.
  nullable
  email
  stringoptional
  No description.
  nullable
  categorizedTransactions
  array<object>optional
  Every transaction of the statement with its category code, grouped by account.
  nullable
  Each item: 2 fields
  accountId
  stringoptional
  No description.
  nullable
  transactions
  array<object>optional
  No description.
  nullable
  Each item: 12 fields
  transactionId
  stringoptional
  No description.
  nullable
  status
  stringoptional
  No description.
  nullable
  bookingDate
  stringoptional
  No description.
  nullable
  valueDate
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  Negative for money out, positive for money in.
  nullable
  currency
  stringoptional
  No description.
  nullable
  description
  stringoptional
  No description.
  nullable
  category
  stringoptional
  Category code, e.g. "FD_00".
  nullable
  debtorName
  stringoptional
  No description.
  nullable
  creditorName
  stringoptional
  No description.
  nullable
  balance
  objectoptional
  No description.
  2 fields
  amount
  number (double)optional
  No description.
  nullable
  currency
  stringoptional
  No description.
  nullable
  additionalInformation
  stringoptional
  No description.
  nullable
- ts_analysis
  objectoptional
  No description.
  17 fields
  monthly_average_balance_summary
  objectoptional
  No description.
  4 fields
  last_month_average
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  Year
  integer (int32)optional
  No description.
  nullable
  Month
  integer (int32)optional
  No description.
  nullable
  Average_Balance_After_Transaction
  number (double)optional
  No description.
  nullable
  Month_Year
  stringoptional
  No description.
  nullable
  last_3_months_average
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  Year
  integer (int32)optional
  No description.
  nullable
  Month
  integer (int32)optional
  No description.
  nullable
  Average_Balance_After_Transaction
  number (double)optional
  No description.
  nullable
  Month_Year
  stringoptional
  No description.
  nullable
  last_6_months_average
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  Year
  integer (int32)optional
  No description.
  nullable
  Month
  integer (int32)optional
  No description.
  nullable
  Average_Balance_After_Transaction
  number (double)optional
  No description.
  nullable
  Month_Year
  stringoptional
  No description.
  nullable
  whole_data_average
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  Year
  integer (int32)optional
  No description.
  nullable
  Month
  integer (int32)optional
  No description.
  nullable
  Average_Balance_After_Transaction
  number (double)optional
  No description.
  nullable
  Month_Year
  stringoptional
  No description.
  nullable
  inflow_summary
  objectoptional
  No description.
  nullable
  outflow_summary
  objectoptional
  No description.
  nullable
  fraud_summary
  objectoptional
  No description.
  5 fields
  result
  objectoptional
  No description.
  nullable
  Fraud Counts
  objectoptional
  No description.
  nullable
  Fraud Check Amount
  objectoptional
  No description.
  nullable
  edited_statement
  booleanoptional
  No description.
  nullable
  overview
  objectoptional
  No description.
  5 fields
  total
  integer (int32)optional
  No description.
  nullable
  found
  integer (int32)optional
  No description.
  nullable
  notFound
  integer (int32)optional
  No description.
  nullable
  foundRatio
  number (double)optional
  No description.
  nullable
  notFoundRatio
  number (double)optional
  No description.
  nullable
  top_5_credit
  objectoptional
  No description.
  nullable
  top_5_debit
  objectoptional
  No description.
  nullable
  monthly_credit_and_debit_expense_ratio_analysis
  objectoptional
  No description.
  9 fields
  last_credit_debit_month_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Credit
  number (double)optional
  No description.
  nullable
  Debit
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Credit_Percentage
  number (double)optional
  No description.
  nullable
  Debit_Percentage
  number (double)optional
  No description.
  nullable
  Expense_Ratio
  number (double)optional
  No description.
  nullable
  last_3_credit_debit_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Credit
  number (double)optional
  No description.
  nullable
  Debit
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Credit_Percentage
  number (double)optional
  No description.
  nullable
  Debit_Percentage
  number (double)optional
  No description.
  nullable
  Expense_Ratio
  number (double)optional
  No description.
  nullable
  last_6_credit_debit_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Credit
  number (double)optional
  No description.
  nullable
  Debit
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Credit_Percentage
  number (double)optional
  No description.
  nullable
  Debit_Percentage
  number (double)optional
  No description.
  nullable
  Expense_Ratio
  number (double)optional
  No description.
  nullable
  last_all_credit_debit_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Credit
  number (double)optional
  No description.
  nullable
  Debit
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Credit_Percentage
  number (double)optional
  No description.
  nullable
  Debit_Percentage
  number (double)optional
  No description.
  nullable
  Expense_Ratio
  number (double)optional
  No description.
  nullable
  overall_ratio
  number (double)optional
  No description.
  nullable
  last_month_ratio
  number (double)optional
  No description.
  nullable
  last_3_months_ratio
  number (double)optional
  No description.
  nullable
  last_6_months_ratio
  number (double)optional
  No description.
  nullable
  all_months_ratio
  number (double)optional
  No description.
  nullable
  EOD_balance
  objectoptional
  No description.
  2 fields
  transaction_mismatch_found
  booleanoptional
  No description.
  nullable
  end_of_day_balance
  objectoptional
  No description.
  nullable
  monthlyOverview
  objectoptional
  No description.
  nullable
  balance_overview
  objectoptional
  No description.
  nullable
  salaryData
  array<object>optional
  No description.
  nullable
  loanData
  objectoptional
  No description.
  7 fields
  totalBorrowedLoanAmount
  number (double)optional
  No description.
  nullable
  totalBorrowedLoanCount
  integer (int32)optional
  No description.
  nullable
  totalRepaidLoanAmount
  number (double)optional
  No description.
  nullable
  totalRepaidLoanCount
  integer (int32)optional
  No description.
  nullable
  borrowed_list
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  company_name
  stringoptional
  No description.
  nullable
  total_amount
  number (double)optional
  No description.
  nullable
  month_wise
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  date
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  balance
  number (double)optional
  No description.
  nullable
  narration
  stringoptional
  No description.
  nullable
  repaid_list
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  company_name
  stringoptional
  No description.
  nullable
  total_amount
  number (double)optional
  No description.
  nullable
  month_wise
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  date
  stringoptional
  No description.
  nullable
  amount
  number (double)optional
  No description.
  nullable
  balance
  number (double)optional
  No description.
  nullable
  narration
  stringoptional
  No description.
  nullable
  list
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  borrowedLoanAmount
  number (double)optional
  No description.
  nullable
  repaidLoanAmount
  number (double)optional
  No description.
  nullable
  date_time
  stringoptional
  No description.
  nullable
  emi_transactions
  objectoptional
  No description.
  nullable
  salary_to_EMI_ratio
  objectoptional
  No description.
  8 fields
  last_EMI_ratio_month_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  last_3_EMI_ratio_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  last_6_EMI_ratio_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  all_EMI_ratio_month_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  last_inflow_to_EMI_ratio_month_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  last_3_inflow_EMI_ratio_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  last_6_inflow_EMI_ratio_months_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  all_inflow_EMI_ratio_month_df
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Month-Year
  stringoptional
  No description.
  nullable
  Inflow
  number (double)optional
  No description.
  nullable
  EMI
  number (double)optional
  No description.
  nullable
  Total
  number (double)optional
  No description.
  nullable
  Inflow_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Percentage
  number (double)optional
  No description.
  nullable
  EMI_Ratio
  number (double)optional
  No description.
  nullable
  recurring_expense_overview
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  Date
  stringoptional
  No description.
  nullable
  Category
  stringoptional
  No description.
  nullable
  Sub_Category
  stringoptional
  No description.
  nullable
  Amount
  number (double)optional
  No description.
  nullable
  Narration
  stringoptional
  No description.
  nullable
  Type
  stringoptional
  No description.
  nullable
  Balance
  number (double)optional
  No description.
  nullable
  bounce_transactions
  objectoptional
  No description.
  nullable
  credit_card_transactions
  objectoptional
  No description.
  nullable
- tbx_details
  objectoptional
  Report metadata. Not returned at present; see `tbx_details`.
  3 fields
  tracking_id
  stringoptional
  Tracking ID for this analysis job.
  nullable
  xlsx_url
  stringoptional
  Pre-signed link to the Excel report. Expires in 5 minutes — use immediately.
  nullable
  json_url
  stringoptional
  Pre-signed link to the raw JSON report. Expires in 5 minutes — use immediately.
  nullable
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
isBillable
booleanoptional
Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.

Example

{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "analysis_json": { "analytics": { "consumer": { "base": { "subject": { "subjectId": null, "dataPeriod": null, "kpi": null, "connections": null } }, "identity": { "verification": "string", "soleTrader": false }, "risk": { "indebtedness": { "cardInstalment": null, "total": null, "incomeRatio": null }, "cash": { "withdrawal": null } }, "cashFlow": { "monthlyAnalysis": [], "periodAnalysis": { "incomeAmount": null, "incomeByCategory": null, "expensesAmount": null, "expensesByCategory": null, "savingAmount": null, "savingRatio": null, "incomeExpensesRatio": null, "monthsWithNegativeSavingCount": null }, "insights": { "recurringExpenses": null, "bestAccountDirectDebit": null, "expensesRunwayMonths": null, "savingRunwayMonths": null, "currentMonth": null, "forecast": null, "monthlyAffordableAmount": null } }, "marketing": { "car": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "house": { "houseLiving": null, "tenant": null }, "creditCard": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "fashion": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "traveling": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "digital": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "telco": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "socialLife": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "health": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "investmentAndTrading": { "income": null, "expenses": null }, "tax": { "monthlyAverageTransactionsAmount": null, "monthlyAverageTransactionsCount": null }, "flagSalary": false, "flagPension": false, "flagSocialWelfare": false }, "documentAuthenticity": [ { "fileName": null, "suspiciousAuthorFlag": null, "dateModifiedFlag": null } ], "score": { "transactionScore": 0, "area": "string", "tranche": 0 }, "statisticalAnalysis": { "accountAnalysis": [] }, "fraudIndicators": [ { "accountId": null, "fraud": null } ], "customerProfile": [ { "accountId": null, "bank": null, "address": null, "dob": null, "accountType": null, "name": null, "mobile": null, "accountOpeningDate": null, "pan": null, "ifsc": null, "email": null } ] } }, "categorizedTransactions": [ { "accountId": "string", "transactions": [ { "transactionId": null, "status": null, "bookingDate": null, "valueDate": null, "amount": null, "currency": null, "description": null, "category": null, "debtorName": null, "creditorName": null, "balance": null, "additionalInformation": null } ] } ] }, "ts_analysis": { "monthly_average_balance_summary": { "last_month_average": [ { "Year": 0, "Month": 0, "Average_Balance_After_Transaction": 0, "Month_Year": "string" } ], "last_3_months_average": [ { "Year": 0, "Month": 0, "Average_Balance_After_Transaction": 0, "Month_Year": "string" } ], "last_6_months_average": [ { "Year": 0, "Month": 0, "Average_Balance_After_Transaction": 0, "Month_Year": "string" } ], "whole_data_average": [ { "Year": 0, "Month": 0, "Average_Balance_After_Transaction": 0, "Month_Year": "string" } ] }, "inflow_summary": {}, "outflow_summary": {}, "fraud_summary": { "result": {}, "Fraud Counts": {}, "Fraud Check Amount": {}, "edited_statement": false, "overview": { "total": 0, "found": 0, "notFound": 0, "foundRatio": 0, "notFoundRatio": 0 } }, "top_5_credit": {}, "top_5_debit": {}, "monthly_credit_and_debit_expense_ratio_analysis": { "last_credit_debit_month_df": [ { "Month-Year": "string", "Credit": 0, "Debit": 0, "Total": 0, "Credit_Percentage": 0, "Debit_Percentage": 0, "Expense_Ratio": 0 } ], "last_3_credit_debit_months_df": [ { "Month-Year": "string", "Credit": 0, "Debit": 0, "Total": 0, "Credit_Percentage": 0, "Debit_Percentage": 0, "Expense_Ratio": 0 } ], "last_6_credit_debit_months_df": [ { "Month-Year": "string", "Credit": 0, "Debit": 0, "Total": 0, "Credit_Percentage": 0, "Debit_Percentage": 0, "Expense_Ratio": 0 } ], "last_all_credit_debit_months_df": [ { "Month-Year": "string", "Credit": 0, "Debit": 0, "Total": 0, "Credit_Percentage": 0, "Debit_Percentage": 0, "Expense_Ratio": 0 } ], "overall_ratio": 0, "last_month_ratio": 0, "last_3_months_ratio": 0, "last_6_months_ratio": 0, "all_months_ratio": 0 }, "EOD_balance": { "transaction_mismatch_found": false, "end_of_day_balance": {} }, "monthlyOverview": {}, "balance_overview": {}, "salaryData": [ {} ], "loanData": { "totalBorrowedLoanAmount": 0, "totalBorrowedLoanCount": 0, "totalRepaidLoanAmount": 0, "totalRepaidLoanCount": 0, "borrowed_list": [ { "company_name": "string", "total_amount": 0, "month_wise": [] } ], "repaid_list": [ { "company_name": "string", "total_amount": 0, "month_wise": [] } ], "list": [ { "borrowedLoanAmount": 0, "repaidLoanAmount": 0, "date_time": "string" } ] }, "emi_transactions": {}, "salary_to_EMI_ratio": { "last_EMI_ratio_month_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "last_3_EMI_ratio_months_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "last_6_EMI_ratio_months_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "all_EMI_ratio_month_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "last_inflow_to_EMI_ratio_month_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "last_3_inflow_EMI_ratio_months_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "last_6_inflow_EMI_ratio_months_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ], "all_inflow_EMI_ratio_month_df": [ { "Month-Year": "string", "Inflow": 0, "EMI": 0, "Total": 0, "Inflow_Percentage": 0, "EMI_Percentage": 0, "EMI_Ratio": 0 } ] }, "recurring_expense_overview": [ { "Date": "string", "Category": "string", "Sub_Category": "string", "Amount": 0, "Narration": "string", "Type": "string", "Balance": 0 } ], "bounce_transactions": {}, "credit_card_transactions": {} }, "tbx_details": { "tracking_id": "string", "xlsx_url": "string", "json_url": "string" } }, "messages": [ "string" ], "request_id": "string", "isBillable": false }

400Bad Request

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 400

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }

401Unauthorized

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 401

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }

500Internal Server Error

data
objectoptional
No description.
messages
array<string>optional
No description.
nullable
request_id
stringoptional
No description.
nullable
success
booleanoptional
No description.
default false
message
stringoptional
No description.
nullabledefault XXXXX
isBillable
booleanoptional
No description.
statusCode
integer (int32)optional
No description.
default 500

Example

{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }

Code samplescurl · Node.js · Python

Stage: uat-ext.signcare.io

curl -X POST 'https://uat-ext.signcare.io/api/v1/Bank/statement-analyser-details/corporate' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "order_id": "string", "response_type": "json", "base64": false }'

All Bank Account Verification pages