The PDF Insights API supports three products. Which product you have a license for determines how much of this API is accessible to you.
If this is your first time, we strongly encourage you to start with one of our Quickstarts.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/
Authenticates with username/password and receive a session token for use on other API calls. Requires Authorization
and MT-Product
headers. See Authentication page for further details.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/authenticate
curl -i -X GET \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/authenticate
No content
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/getapps
curl -i -X GET \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/getapps
[ { "appnumber": "string", "appid": 0, "naccounts": 0, "owner": "string", "totalstatements": 0, "totalstatements_reconciled": 0, "totaltaxforms": 0, "totaltaxreturns": 0, "address1": "string", "address2": "string", "citystate": "string", "city": "string", "state": "string", "zip": "string", "expfactor": "string", "accountlist": [ … ] } ]
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/new
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/new \
-H 'Content-Type: multipart/form-data' \
-F appnumber=string
{ "appnumber": "string", "appid": 0, "naccounts": 0, "owner": "string", "totalstatements": 0, "totalstatements_reconciled": 0, "totaltaxforms": 0, "totaltaxreturns": 0, "address1": "string", "address2": "string", "citystate": "string", "city": "string", "state": "string", "zip": "string", "expfactor": "string", "accountlist": [ "string" ] }
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/scorecard
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/scorecard \
-H 'Content-Type: multipart/form-data'
{ "_metadata": { "someTransactionsExcludedDueToValidationFailures": true, "numFileConversionsInProgress": 0, "warnings": "Section 'combinedsummary' encountered an error." }, "metrics": { "metricdata": [ … ] }, "accountslist": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "combinedsummary": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "truerev6mo": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "truerev12mo": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "taxscorelist": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "thumbprints": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "monthlymca": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "mcacompanies": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "recoverycompanies": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "dailybalance": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "dailycashflow": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "monthlycashflow": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "monthlynegativedays": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "monthlyrecovery": { "labels": [ … ], "columns": [ … ], "data": [ … ] }, "debittrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "creditcardaccountpayment": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "creditcardprocessortrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "combotrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "mcapayments": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "otherdebits": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "mobilepaymentsdebits": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nefariouswithdrawals": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "debtcollectortransactions": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "constructiondebits": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nonmcaloans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "atmwithdrawals": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "insurance": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "reptrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "mcatrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nsftrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "overtrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "credittrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "truecredittrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "untruecredittrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "xferitrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "xferotrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "largetrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "largecredittrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "returnedtrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "largeelectronictrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "xfertrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "truetrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "untruetrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "recoverytrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "casinotrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "investments": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "mobilepayments": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "paymentprocessortrans": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "healthcareclaims": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "factoring": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nefarioustransactions": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "alltransactions": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "otherfinancingtransactions": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nontransactionitems": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "payroll": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "tolls": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "nondescriptrevenue": { "columns": [ … ], "labels": [ … ], "data": [ … ] }, "chineseexposure": { "columns": [ … ], "labels": [ … ], "data": [ … ] } }
The desired structure of the scorecard section of the JSON reponse. 'default' is deprecated.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/makexls
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/makexls \
-H 'Content-Type: multipart/form-data' \
-F appid=123 \
-F format=default \
-F sections=
Returns a signed URL that can be used in the browser to open the scorecard page without signing in.
⚠️ Warning: In order to use this URL in an iframe, your domain will need to be whitelisted. Please contact support@moneythumb.com for assistance.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/scorecard/signedUrl
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/scorecard/signedUrl \
-H 'Content-Type: multipart/form-data'
{ "url": "https://insights.moneythumb.com/?token=abc" }
Customer-provided identifier for the application.
The file to upload. Accepts all supported file types, not just PDFs. This property may be repeated to upload multiple files at once. Either pdf-filename
or jsondata
is required.
A URL for Insights to call with the conversion results.
The type of document. The choices are Bank
, CCard
, MTJson
, Plaid
, applicationForm
or autoDetect
.
Use this field when sending a JSON text in Plaid Asset Report or MoneyThumb format. When setting this field, also set the accounttype
field to the appropriate corresponding value, Plaid
or MTJson
. Either pdf-filename
or jsondata
is required.
The language of a statement. Uses ISO abbreviations: en
, es
, fr
, de
, ln
, pt
, it
. Only needed when the statement isn't in English.
Reads US dates. Set to true
for US Date format (M-D-Y). Set to false
for D-M-Y.
Writes US dates. Set to true
for US Date format (M-D-Y). Set to false
for D-M-Y. Set to true
if you need Euro dates returned as US dates.
Sets the value for allowing small balance differences to be ignored. Default is 0
. A value such as 100
would mark the statement as reconciled if the balances were accurate within $100.00
.
Run OCR. Use with caution. Intended for manual use. Set to true
when initial processing of a statement does not return correct results.
Only set to true
to have an email sent at the completion of an OCR conversion.
For statements with multiple accounts, set which accounts to process. Set to -1
to process all accounts. To process a specific account, use the integer that corresponds to order of appearance for that account. For example, to process the 2nd account, use 2
.
For files with multiple statements, set which statement to process. Set to -1
to process all statements. To process a specific statement, use the integer that corresponds to order of appearance for that statement. For example, to process the 2nd statement, use 2
.
Use plaid
when running a Plaid JSON file. Required to get results for Plaid json files.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/makecsv
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/makecsv \
-H 'Content-Type: multipart/form-data' \
-F 'appnumber=ACME Widgets' \
-F pdf-filename=string \
-F webhook=https://yourdomain.com/webhook.php \
-F accounttype=Bank \
-F jsondata= \
-F language= \
-F schema= \
-F readUSdates=true \
-F writeUSdates=true \
-F firstpage=0 \
-F lastpage=0 \
-F yearoverride=0 \
-F alloweddiff=0 \
-F logtype=htm \
-F combinelines=false \
-F noneedalphas=false \
-F spacingfactor=1 \
-F doocrfile=false \
-F fixedcolumns=false \
-F neverocr=false \
-F asyncocr=true \
-F accountseqno=-1 \
-F monthseqno=-1 \
-F readempty=false \
-F finduntrue=false \
-F customerid=
Converts multiple documents, creating an application if one doesn't already exist. Results can be received in multiple ways:
Callback (preferred): If a URL is specified in the webhook
parameter, the following will occur:
202 ACCEPTED
.Sychronous (deprecated): If the webhook
parameter is not provided, one of the following will happen:
202 ACCEPTED
will be returned and you will need to use other endpoints to retrieve the results.While not required, we recommend including the following parameters:
accounttype
- Specifies the type of document. You can also use autodetect
to automatically pick up different types of documents.includescorecard
- (true/false) Includes the full underwriting scorecard in the results.includetransactions
- (true/false) Includes the full transaction list in the results.jsonobject
is recommended.Customer-provided identifier for the application.
The file to upload. Accepts all supported file types, not just PDFs. This property may be repeated to upload multiple files at once. Either pdf-filename
or jsondata
is required.
A URL for Insights to call with the conversion results.
Send the webhook only a completion notification (true) or the full results (false)
The type of document. The choices are Bank
, CCard
, MTJson
, Plaid
, applicationForm
or autoDetect
.
Use this field when sending a JSON text in Plaid Asset Report or MoneyThumb format. When setting this field, also set the accounttype
field to the appropriate corresponding value, Plaid
or MTJson
. Either pdf-filename
or jsondata
is required.
Set to true
to include the Scorecard data in the results. Please also include the 'format' property set to 'jsonobject'
Set to true
to include transactions data (JSON format) in results.
Set to true
to include the running balance for each transaction. Only use when includetransactions
is set to true
.
The desired structure of the scorecard section of the JSON reponse. 'default' is deprecated.
The language of a statement. Uses ISO abbreviations: en
, es
, fr
, de
, ln
, pt
, it
. Only needed when the statement isn't in English.
Reads US dates. Set to true
for US Date format (M-D-Y). Set to false
for D-M-Y.
Writes US dates. Set to true
for US Date format (M-D-Y). Set to false
for D-M-Y. Set to true
if you need Euro dates returned as US dates.
Sets the value for allowing small balance differences to be ignored. Default is 0
. A value such as 100
would mark the statement as reconciled if the balances were accurate within $100.00
.
Run OCR. Use with caution. Intended for manual use. Set to true
when initial processing of a statement does not return correct results.
Only set to true
to have an email sent at the completion of an OCR conversion.
For statements with multiple accounts, set which accounts to process. Set to -1
to process all accounts. To process a specific account, use the integer that corresponds to order of appearance for that account. For example, to process the 2nd account, use 2
.
For files with multiple statements, set which statement to process. Set to -1
to process all statements. To process a specific statement, use the integer that corresponds to order of appearance for that statement. For example, to process the 2nd statement, use 2
.
The scorecard sections to return. This overrides what is defined in the user profile.
Set to true
to show all transaction amounts as positive and include debit/credit in the type
field. Only use when includetransactions
is set to true
.
The owner or company name of the applicant. This is only used in combination with appnumber
.
The customer provided meta data to return with response. Must be valid JSON. Limited to 250 characters.
Use plaid
when running a Plaid JSON file. Required to get results for Plaid json files.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/uploadpdfs
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/uploadpdfs \
-H 'Content-Type: multipart/form-data' \
-F 'appnumber=ACME Widgets' \
-F appid=123 \
-F pdf-filename=string \
-F webhook=https://yourdomain.com/webhook.php \
-F whonlynotify=false \
-F accounttype=Bank \
-F jsondata= \
-F includescorecard=false \
-F includetransactions=false \
-F includebalance=false \
-F format=default \
-F language= \
-F schema= \
-F readUSdates=true \
-F writeUSdates=true \
-F firstpage=0 \
-F lastpage=0 \
-F yearoverride=0 \
-F alloweddiff=0 \
-F logtype=htm \
-F combinelines=false \
-F noneedalphas=false \
-F spacingfactor=1 \
-F doocrfile=false \
-F fixedcolumns=false \
-F neverocr=false \
-F asyncocr=true \
-F accountseqno=-1 \
-F monthseqno=-1 \
-F readempty=false \
-F finduntrue=false \
-F sections= \
-F showtranstype=false \
-F customerid= \
-F 'owner=ACME Widgets' \
-F userdata=
{ "statement_summaries": [ { … } ], "appinfo": { "appnumber": "string", "appid": 0, "naccounts": 0, "owner": "string", "totalstatements": 0, "totalstatements_reconciled": 0, "totaltaxforms": 0, "totaltaxreturns": 0, "address1": "string", "address2": "string", "citystate": "string", "city": "string", "state": "string", "zip": "string", "expfactor": "string", "accountlist": [ … ] }, "scorecard": { "_metadata": { … }, "metrics": { … }, "accountslist": { … }, "combinedsummary": { … }, "truerev6mo": { … }, "truerev12mo": { … }, "taxscorelist": { … }, "thumbprints": { … }, "monthlymca": { … }, "mcacompanies": { … }, "recoverycompanies": { … }, "dailybalance": { … }, "dailycashflow": { … }, "monthlycashflow": { … }, "monthlynegativedays": { … }, "monthlyrecovery": { … }, "debittrans": { … }, "creditcardaccountpayment": { … }, "creditcardprocessortrans": { … }, "combotrans": { … }, "mcapayments": { … }, "otherdebits": { … }, "mobilepaymentsdebits": { … }, "nefariouswithdrawals": { … }, "debtcollectortransactions": { … }, "constructiondebits": { … }, "nonmcaloans": { … }, "atmwithdrawals": { … }, "insurance": { … }, "reptrans": { … }, "mcatrans": { … }, "nsftrans": { … }, "overtrans": { … }, "credittrans": { … }, "truecredittrans": { … }, "untruecredittrans": { … }, "xferitrans": { … }, "xferotrans": { … }, "largetrans": { … }, "largecredittrans": { … }, "returnedtrans": { … }, "largeelectronictrans": { … }, "xfertrans": { … }, "truetrans": { … }, "untruetrans": { … }, "recoverytrans": { … }, "casinotrans": { … }, "investments": { … }, "mobilepayments": { … }, "paymentprocessortrans": { … }, "healthcareclaims": { … }, "factoring": { … }, "nefarioustransactions": { … }, "alltransactions": { … }, "otherfinancingtransactions": { … }, "nontransactionitems": { … }, "payroll": { … }, "tolls": { … }, "nondescriptrevenue": { … }, "chineseexposure": { … } }, "transactions": [ { … } ] }
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/updatesummary
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/updatesummary \
-H 'Content-Type: multipart/form-data' \
-F appid=0 \
-F tid=string \
-F startbalance=0 \
-F debits=0 \
-F credits=0 \
-F endbalance=0
Updates scorecard information on an existing Google sheet.
⚠️ Warning: Contact support@moneythumb.com for assistance to configure Google Sheets for your account.
Customer-provided identifier for the application.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/googlesheets
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/googlesheets \
-H 'Content-Type: multipart/form-data' \
-F 'appnumber=ACME Widgets' \
-F sheetid=string
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/transactions
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/transactions \
-H 'Content-Type: multipart/form-data'
{ "Account Name": "string", "Account Number": "string", "Statements": [ { … } ] }
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/deletestmt
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/deletestmt \
-H 'Content-Type: multipart/form-data' \
-F appid=0 \
-F tid=string
Set to true
to include the Scorecard data in the results. Please also include the format
property set to jsonobject
.
Set to true
to include transactions data (JSON format) in results.
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/getresults
curl -i -X POST \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/getresults \
-H 'Content-Type: multipart/form-data' \
-F appid=0 \
-F includescorecard=false \
-F includetransactions=false \
-F format=default
{ "statement_summaries": [ { … } ], "appinfo": { "appnumber": "string", "appid": 0, "naccounts": 0, "owner": "string", "totalstatements": 0, "totalstatements_reconciled": 0, "totaltaxforms": 0, "totaltaxreturns": 0, "address1": "string", "address2": "string", "citystate": "string", "city": "string", "state": "string", "zip": "string", "expfactor": "string", "accountlist": [ … ] }, "scorecard": { "_metadata": { … }, "metrics": { … }, "accountslist": { … }, "combinedsummary": { … }, "truerev6mo": { … }, "truerev12mo": { … }, "taxscorelist": { … }, "thumbprints": { … }, "monthlymca": { … }, "mcacompanies": { … }, "recoverycompanies": { … }, "dailybalance": { … }, "dailycashflow": { … }, "monthlycashflow": { … }, "monthlynegativedays": { … }, "monthlyrecovery": { … }, "debittrans": { … }, "creditcardaccountpayment": { … }, "creditcardprocessortrans": { … }, "combotrans": { … }, "mcapayments": { … }, "otherdebits": { … }, "mobilepaymentsdebits": { … }, "nefariouswithdrawals": { … }, "debtcollectortransactions": { … }, "constructiondebits": { … }, "nonmcaloans": { … }, "atmwithdrawals": { … }, "insurance": { … }, "reptrans": { … }, "mcatrans": { … }, "nsftrans": { … }, "overtrans": { … }, "credittrans": { … }, "truecredittrans": { … }, "untruecredittrans": { … }, "xferitrans": { … }, "xferotrans": { … }, "largetrans": { … }, "largecredittrans": { … }, "returnedtrans": { … }, "largeelectronictrans": { … }, "xfertrans": { … }, "truetrans": { … }, "untruetrans": { … }, "recoverytrans": { … }, "casinotrans": { … }, "investments": { … }, "mobilepayments": { … }, "paymentprocessortrans": { … }, "healthcareclaims": { … }, "factoring": { … }, "nefarioustransactions": { … }, "alltransactions": { … }, "otherfinancingtransactions": { … }, "nontransactionitems": { … }, "payroll": { … }, "tolls": { … }, "nondescriptrevenue": { … }, "chineseexposure": { … } }, "transactions": [ { … } ] }
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/remaining
curl -i -X GET \
https://docs.moneythumb.com/_mock/pdf-insights/api-reference/remaining
{ "Remaining": 0 }