Skip to content
PDF Insights
/
/
Convert multiple document...

PDF Insights API (1.5)

The PDF Insights API supports three products. Which product you have a license for determines how much of this API is accessible to you.

  • PDF Insights w/Thumbprint - The full API is available.
  • PDF Insights - All endpoints are available but Thumbprint scores will not return.
  • Thumbprint - Only /authenticate and /uploadpdfs endpoints are available.

If this is your first time, we strongly encourage you to start with one of our Quickstarts.

Download OpenAPI description
index.json
index.yaml
Overview
MoneyThumb Support

support@moneythumb.com

Terms of Service

Languages
Servers
Live Testing

https://insights.moneythumb.com/api/v1.0/

Authenticate

Request

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.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
curl -i -X GET \
  https://insights.moneythumb.com/api/v1.0/authenticate

Responses

Request successful. The response body will be a session token.

Bodytext/plain
string

Session token

Response
No content

List applications

Request

Retrieves a list of all the applications available to the credentials submitted.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-data
limitinteger

Determines how many results are returned. The default is 20.

curl -i -X GET \
  https://insights.moneythumb.com/api/v1.0/getapps \
  -H 'Content-Type: multipart/form-data'

Responses

Request successful.

Bodyapplication/jsonArray [
appnumberstring

The unique application number assigned by the user.

appidinteger(int32)

The unique application ID assigned by the system.

naccountsinteger(int32)

The number of accounts.

ownerstring

Application owner

totalstatementsinteger(int32)

The number of statements in the application.

totalstatements_reconciledinteger(int32)

The number of statements that reconcile.

totaltaxformsinteger(int32)

The number of tax forms.

totaltaxreturnsinteger(int32)

The number of tax returns.

address1string

The first line of address.

address2string

The second line of address.

citystatestring

The city and state of address.

citystring

The city of the address.

statestring

The state of the address.

zipstring

The zip code of the address.

expfactorstring

Expense factor

accountlistArray of strings

List of accounts: account number statement date.

]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Create application

Request

Create a new application or retrieve an existing one.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appnumberstringrequired

Customer-assigned application identifier

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/new \
  -H 'Content-Type: multipart/form-data' \
  -F appnumber=string

Responses

Request successful.

Bodyapplication/json
appnumberstring

The unique application number assigned by the user.

appidinteger(int32)

The unique application ID assigned by the system.

naccountsinteger(int32)

The number of accounts.

ownerstring

Application owner

totalstatementsinteger(int32)

The number of statements in the application.

totalstatements_reconciledinteger(int32)

The number of statements that reconcile.

totaltaxformsinteger(int32)

The number of tax forms.

totaltaxreturnsinteger(int32)

The number of tax returns.

address1string

The first line of address.

address2string

The second line of address.

citystatestring

The city and state of address.

citystring

The city of the address.

statestring

The state of the address.

zipstring

The zip code of the address.

expfactorstring

Expense factor

accountlistArray of strings

List of accounts: account number statement date.

Response
application/json
{
  "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"
  ]
}

Get scorecard

Request

Retrieve an application's scorecard.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifer.

sectionsstring

The scorecard sections to return. This field can either contain a single section name or multiple section names. To have multiple sections returned, write each section name separated by commas. For a list of valid section names, see the object name of the section in the Scorecard Reference page. This overrides what is defined in the user profile.

Default ""
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/scorecard \
  -H 'Content-Type: multipart/form-data'

Responses

Request successful.

Bodyapplication/json
One of:
_metadataobject(Metadata)
metricsobject
accountslistobject(Statements_Summary_Default)
combinedsummaryobject(Combined_Summary_Default)
truerev6moobject(TrueRevenue_Default)
truerev12moobject(TrueRevenue_Default)
taxscorelistobject
thumbprintsobject
monthlymcaobject
mcacompaniesobject
recoverycompaniesobject
dailybalanceobject
declinelistobject
dailycashflowobject
monthlycashflowobject
monthlynegativedaysobject
monthlyrecoveryobject
debittransobject(InsightsScoreCardTransactionSectionObject_Default)
creditcardaccountpaymentobject(InsightsScoreCardTransactionSectionObject_Default)
lifeinsuranceobject(InsightsScoreCardTransactionSectionObject_Default)
investmentdebitsobject(InsightsScoreCardTransactionSectionObject_Default)
mcarefundobject(InsightsScoreCardTransactionSectionObject_Default)
mcanorefundsobject(InsightsScoreCardTransactionSectionObject_Default)
creditcardprocessortransobject(InsightsScoreCardTransactionSectionObject_Default)
installmentpaymentobject(InsightsScoreCardTransactionSectionObject_Default)
ecommercetransobject(InsightsScoreCardTransactionSectionObject_Default)
autofinancepaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
studentloanpaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
mortgagepaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
personalloanpaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
combotransobject(InsightsScoreCardTransactionSectionObject_Default)
mcapaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
otherdebitsobject(InsightsScoreCardTransactionSectionObject_Default)
mobilepaymentsdebitsobject(InsightsScoreCardTransactionSectionObject_Default)
nefariouswithdrawalsobject(InsightsScoreCardTransactionSectionObject_Default)
debtcollectortransactionsobject(InsightsScoreCardTransactionSectionObject_Default)
constructiondebitsobject(InsightsScoreCardTransactionSectionObject_Default)
nonmcaloansobject(InsightsScoreCardTransactionSectionObject_Default)
atmwithdrawalsobject(InsightsScoreCardTransactionSectionObject_Default)
insuranceobject(InsightsScoreCardTransactionSectionObject_Default)
reptransobject(InsightsScoreCardTransactionSectionObject_Default)
mcatransobject(InsightsScoreCardTransactionSectionObject_Default)
mcafeesobject(InsightsScoreCardTransactionSectionObject_Default)
nsftransobject(InsightsScoreCardTransactionSectionObject_Default)
overtransobject(InsightsScoreCardTransactionSectionObject_Default)
credittransobject(InsightsScoreCardTransactionSectionObject_Default)
truecredittransobject(InsightsScoreCardTransactionSectionObject_Default)
untruecredittransobject(InsightsScoreCardTransactionSectionObject_Default)
xferitransobject(InsightsScoreCardTransactionSectionObject_Default)
xferotransobject(InsightsScoreCardTransactionSectionObject_Default)
largetransobject(InsightsScoreCardTransactionSectionObject_Default)
largecredittransobject(InsightsScoreCardTransactionSectionObject_Default)
returnedtransobject(InsightsScoreCardTransactionSectionObject_Default)
largeelectronictransobject(InsightsScoreCardTransactionSectionObject_Default)
xfertransobject(InsightsScoreCardTransactionSectionObject_Default)
truetransobject(InsightsScoreCardTransactionSectionObject_Default)
untruetransobject(InsightsScoreCardTransactionSectionObject_Default)
recoverytransobject(InsightsScoreCardTransactionSectionObject_Default)
casinotransobject(InsightsScoreCardTransactionSectionObject_Default)
investmentsobject(InsightsScoreCardTransactionSectionObject_Default)
mobilepaymentsobject(InsightsScoreCardTransactionSectionObject_Default)
paymentprocessortransobject(InsightsScoreCardTransactionSectionObject_Default)
healthcareclaimsobject(InsightsScoreCardTransactionSectionObject_Default)
factoringobject(InsightsScoreCardTransactionSectionObject_Default)
nefarioustransactionsobject(InsightsScoreCardTransactionSectionObject_Default)
alltransactionsobject(InsightsScoreCardTransactionSectionObject_Default)
otherfinancingtransactionsobject(InsightsScoreCardTransactionSectionObject_Default)
nontransactionitemsobject(InsightsScoreCardTransactionSectionObject_Default)
payrollobject(InsightsScoreCardTransactionSectionObject_Default)
tollsobject(InsightsScoreCardTransactionSectionObject_Default)
nondescriptrevenueobject(InsightsScoreCardTransactionSectionObject_Default)
chineseexposureobject(InsightsScoreCardTransactionSectionObject_Default)
Response
application/json
{
  "_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": [ … ]
  },
  "declinelist": {
    "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": [ … ]
  },
  "lifeinsurance": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "investmentdebits": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "mcarefund": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "mcanorefunds": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "creditcardprocessortrans": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "installmentpayment": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "ecommercetrans": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "autofinancepayments": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "studentloanpayments": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "mortgagepayments": {
    "columns": [ … ],
    "labels": [ … ],
    "data": [ … ]
  },
  "personalloanpayments": {
    "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": [ … ]
  },
  "mcafees": {
    "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": [ … ]
  }
}

Get scorecard (Excel)

Request

Retrieve an application's scorecard.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-generated identifier for the application.

Example: 123
formatstring

The desired structure of the scorecard section of the JSON reponse. default is deprecated.

Default "default"
Enum"default""jsonobject"
sectionsstring

The scorecard sections to return. This field can either contain a single section name or multiple section names. To have multiple sections returned, write each section name separated by commas. For a list of valid section names, see the object name of the section in the Scorecard Reference page. This overrides what is defined in the user profile.

Default ""
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/makexls \
  -H 'Content-Type: multipart/form-data' \
  -F appid=123 \
  -F format=default \
  -F sections=

Responses

Request successful.

Bodyapplication/vnd.ms-excel
string(binary)
Response
No content

Retrieve signed scorecard URL

Request

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.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifer.

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/scorecard/signedUrl \
  -H 'Content-Type: multipart/form-data'

Responses

Signed Scorecard URL.

Bodyapplication/json
urlstring
Example: "https://insights.moneythumb.com/?token=abc"
Response
application/json
{
  "url": "https://insights.moneythumb.com/?token=abc"
}

Convert a document

Request

Convert one document and receive its results.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appnumberstringrequired

Customer-provided identifier for the application.

Default ""
Example: "ACME Widgets"
pdf-filenamestring(byte)

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.

webhookstring

A URL for Insights to call with the conversion results.

Example: "https://yourdomain.com/webhook.php"
accounttypestring

The type of document. The choices are Bank, CCard, MTJson, Plaid, applicationForm or autoDetect.

Default "Bank"
Enum"Bank""CCard""MTJson""Plaid""applicationForm""autoDetect"
jsondatastring

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.

Default ""
languagestring

The language of a statement. Uses ISO abbreviations: en, es, fr, de, ln, pt, it. Only needed when the statement isn't in English.

Default ""
readUSdatesboolean

Reads US dates. Set to true for US Date format (M-D-Y). Set to false for D-M-Y.

Default true
writeUSdatesboolean

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.

Default true
firstpageinteger

The first page number to process (if not page 1).

lastpageinteger

The last page number to process (if not the last page in document).

yearoverrideinteger

Sets the year of the statement.

alloweddiffinteger

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.

Default 0
logtypestring

Sets the type of log to create. The choices are txt, htm or none.

Default "htm"
combinelinesboolean

Combines description lines into one long description.

Default false
noneedalphasboolean

Recognizes strictly numeric transaction descriptions.

Default false
spacingfactornumber

Adjusts how much distance is considered a space.

Default 1
doocrfileboolean

Run OCR. Use with caution. Intended for manual use. Set to true when initial processing of a statement does not return correct results.

Default false
neverocrboolean

Never runs OCR. Set to true to never run OCR.

Default false
asyncocrboolean

Only set to true to have an email sent at the completion of an OCR conversion.

Default true
accountseqnointeger(int32)

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.

Default -1
monthseqnointeger

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.

Default -1
reademptyboolean

Set to true to show statements with no transactions.

Default false
finduntrueboolean

Set to true to automatically find untrue transactions.

Default false
customeridstring

TODP The reseller customer ID.

Default ""
schemastringDeprecated

Use plaid when running a Plaid JSON file. Required to get results for Plaid json files.

Default ""
fixedcolumnsbooleanDeprecated

Sets whether standard CSV columns are used. If not set, then the columns will appear in the same order found in the PDF file.

Default false
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/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=

Responses

Request successful.

Bodyapplication/json
appnumberstring

Customer-provided identifier for the application.

Default ""
Example: "ACME Widgets"
pdf-filenamestring(byte)

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.

webhookstring

A URL for Insights to call with the conversion results.

Example: "https://yourdomain.com/webhook.php"
accounttypestring

The type of document. The choices are Bank, CCard, MTJson, Plaid, applicationForm or autoDetect.

Default "Bank"
Enum"Bank""CCard""MTJson""Plaid""applicationForm""autoDetect"
jsondatastring

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.

Default ""
languagestring

The language of a statement. Uses ISO abbreviations: en, es, fr, de, ln, pt, it. Only needed when the statement isn't in English.

Default ""
readUSdatesboolean

Reads US dates. Set to true for US Date format (M-D-Y). Set to false for D-M-Y.

Default true
writeUSdatesboolean

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.

Default true
firstpageinteger

The first page number to process (if not page 1).

lastpageinteger

The last page number to process (if not the last page in document).

yearoverrideinteger

Sets the year of the statement.

alloweddiffinteger

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.

Default 0
logtypestring

Sets the type of log to create. The choices are txt, htm or none.

Default "htm"
combinelinesboolean

Combines description lines into one long description.

Default false
noneedalphasboolean

Recognizes strictly numeric transaction descriptions.

Default false
spacingfactornumber

Adjusts how much distance is considered a space.

Default 1
doocrfileboolean

Run OCR. Use with caution. Intended for manual use. Set to true when initial processing of a statement does not return correct results.

Default false
neverocrboolean

Never runs OCR. Set to true to never run OCR.

Default false
asyncocrboolean

Only set to true to have an email sent at the completion of an OCR conversion.

Default true
accountseqnointeger(int32)

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.

Default -1
monthseqnointeger

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.

Default -1
reademptyboolean

Set to true to show statements with no transactions.

Default false
finduntrueboolean

Set to true to automatically find untrue transactions.

Default false
customeridstring

TODP The reseller customer ID.

Default ""
schemastringDeprecated

Use plaid when running a Plaid JSON file. Required to get results for Plaid json files.

Default ""
fixedcolumnsbooleanDeprecated

Sets whether standard CSV columns are used. If not set, then the columns will appear in the same order found in the PDF file.

Default false
Response
application/json
{
  "appnumber": "ACME Widgets",
  "pdf-filename": "string",
  "webhook": "https://yourdomain.com/webhook.php",
  "accounttype": "Bank",
  "jsondata": "",
  "language": "",
  "schema": "",
  "readUSdates": true,
  "writeUSdates": true,
  "firstpage": 0,
  "lastpage": 0,
  "yearoverride": 0,
  "alloweddiff": 0,
  "logtype": "htm",
  "combinelines": false,
  "noneedalphas": false,
  "spacingfactor": 1,
  "doocrfile": false,
  "fixedcolumns": false,
  "neverocr": false,
  "asyncocr": true,
  "accountseqno": -1,
  "monthseqno": -1,
  "readempty": false,
  "finduntrue": false,
  "customerid": ""
}

Convert multiple documents

Request

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:

  1. This call will return a 202 ACCEPTED.
  2. Once conversion is complete, Insights will call the provided webhook URL with the results.

Sychronous (deprecated): If the webhook parameter is not provided, one of the following will happen:

  • If the file is text-based, the results will be returned in the response.
  • If the file requires OCR, 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 autodetectto 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.
  • format - Changes the structure of the JSON for the scorecard (if included). jsonobject is recommended.
Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appnumberstringrequired

Customer-provided identifier for the application.

Default ""
Example: "ACME Widgets"
pdf-filenamestring(byte)

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.

webhookstring

A URL for Insights to call with the conversion results.

Example: "https://yourdomain.com/webhook.php"
whonlynotifyboolean

Send the webhook only a completion notification (true) or the full results (false)

Default false
accounttypestring

The type of document. The choices are Bank, CCard, MTJson, Plaid, applicationForm or autoDetect.

Default "Bank"
Enum"Bank""CCard""MTJson""Plaid""applicationForm""autoDetect"
jsondatastring

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.

Default ""
includescorecardboolean

Set to true to include the Scorecard data in the results. Please also include the 'format' property set to 'jsonobject'

Default false
includetransactionsboolean

Set to true to include transactions data (JSON format) in results.

Default false
includebalanceboolean

Set to true to include the running balance for each transaction. Only use when includetransactions is set to true.

Default false
formatstring

The desired structure of the scorecard section of the JSON reponse. default is deprecated.

Default "default"
Enum"default""jsonobject"
languagestring

The language of a statement. Uses ISO abbreviations: en, es, fr, de, ln, pt, it. Only needed when the statement isn't in English.

Default ""
readUSdatesboolean

Reads US dates. Set to true for US Date format (M-D-Y). Set to false for D-M-Y.

Default true
writeUSdatesboolean

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.

Default true
firstpageinteger

The first page number to process (if not page 1).

lastpageinteger

The last page number to process (if not the last page in document).

yearoverrideinteger

Sets the year of the statement.

alloweddiffinteger

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.

Default 0
logtypestring

Sets the type of log to create. The choices are txt, htm or none.

Default "htm"
combinelinesboolean

Combines description lines into one long description.

Default false
noneedalphasboolean

Recognizes strictly numeric transaction descriptions.

Default false
spacingfactornumber

Adjusts how much distance is considered a space.

Default 1
doocrfileboolean

Run OCR. Use with caution. Intended for manual use. Set to true when initial processing of a statement does not return correct results.

Default false
neverocrboolean

Never runs OCR. Set to true to never run OCR.

Default false
asyncocrboolean

Only set to true to have an email sent at the completion of an OCR conversion.

Default true
accountseqnointeger(int32)

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.

Default -1
monthseqnointeger

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.

Default -1
reademptyboolean

Set to true to show statements with no transactions.

Default false
finduntrueboolean

Set to true to automatically find untrue transactions.

Default false
sectionsstring

The scorecard sections to return. This field can either contain a single section name or multiple section names. To have multiple sections returned, write each section name separated by commas. For a list of valid section names, see the object name of the section in the Scorecard Reference page. This overrides what is defined in the user profile.

Default ""
showtranstypeboolean

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.

Default false
customeridstring

The reseller customer ID.

Default ""
ownerstring

The owner or company name of the applicant. This is only used in combination with appnumber.

Default ""
Example: "ACME Widgets"
userdatastring

The customer provided meta data to return with response. Must be valid JSON. Limited to 250 characters.

Default ""
appidintegerDeprecated

Insights-generated identifier for the application.

Example: 123
schemastringDeprecated

Use plaid when running a Plaid JSON file. Required to get results for Plaid json files.

Default ""
fixedcolumnsbooleanDeprecated

Sets whether standard CSV columns are used. If not set, then the columns will appear in the same order found in the PDF file.

Default false
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/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=

Responses

Request successful.

Bodyapplication/json
One of:

Multi-File Results Object

statement_summariesArray of objects(FileConversionResult)
appinfoobject(ApplicationInfo)
scorecardobject(ScoreCardObject_Default)
transactionsArray of objects(AccountJSON)
Response
application/json
{
  "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": { … },
    "declinelist": { … },
    "dailycashflow": { … },
    "monthlycashflow": { … },
    "monthlynegativedays": { … },
    "monthlyrecovery": { … },
    "debittrans": { … },
    "creditcardaccountpayment": { … },
    "lifeinsurance": { … },
    "investmentdebits": { … },
    "mcarefund": { … },
    "mcanorefunds": { … },
    "creditcardprocessortrans": { … },
    "installmentpayment": { … },
    "ecommercetrans": { … },
    "autofinancepayments": { … },
    "studentloanpayments": { … },
    "mortgagepayments": { … },
    "personalloanpayments": { … },
    "combotrans": { … },
    "mcapayments": { … },
    "otherdebits": { … },
    "mobilepaymentsdebits": { … },
    "nefariouswithdrawals": { … },
    "debtcollectortransactions": { … },
    "constructiondebits": { … },
    "nonmcaloans": { … },
    "atmwithdrawals": { … },
    "insurance": { … },
    "reptrans": { … },
    "mcatrans": { … },
    "mcafees": { … },
    "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": [
    { … }
  ]
}

Callbacks

Conversion Results
post
Result Id data will be sent, notifying the receiving end that processing has finished for files uploaded to the application.
post

Update summary

Request

Updates the summary data of a statement.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifier.

tidstringrequired

Insights-assigned statement identifier.

startbalancenumber

New starting balance.

debitsnumber

New total debits.

creditsnumber

New total credits.

endbalancenumber

New ending balance.

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/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

Responses

Request successful.

Response
No content

Update Google Sheets

Request

Updates scorecard information on an existing Google sheet.

⚠️ Warning: Contact support@moneythumb.com for assistance to configure Google Sheets for your account.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appnumberstringrequired

Customer-provided identifier for the application.

Default ""
Example: "ACME Widgets"
sheetidstringrequired

The unique ID of the Google Sheet to update.

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/googlesheets \
  -H 'Content-Type: multipart/form-data' \
  -F 'appnumber=ACME Widgets' \
  -F sheetid=string

Responses

Everything worked ok and sheet has been updated.

Response
No content

Get transactions

Request

Retrieve the transactions, either as JSON (structured=true) or CSV (structured=false).

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifier

structuredstring

Determines return format, either JSON (true) or CSV (false).

Default false
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/transactions \
  -H 'Content-Type: multipart/form-data'

Responses

Request successful.

Body
Account Namestring

The name for the account.

Account Numberstring

The number of the account.

StatementsArray of objects(StatementJSON)
Response
{
  "Account Name": "string",
  "Account Number": "string",
  "Statements": [
    { … }
  ]
}

Delete statement

Request

Deletes a statement.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifier

tidstringrequired

Insights-assigned statement identifier

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/deletestmt \
  -H 'Content-Type: multipart/form-data' \
  -F appid=0 \
  -F tid=string

Responses

Request successful.

Response
No content

Get results

Request

Retrieve the results of a conversion.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifier.

includescorecardboolean

Set to true to include the Scorecard data in the results. Please also include the format property set to jsonobject.

Default false
includetransactionsboolean

Set to true to include transactions data (JSON format) in results.

Default false
formatstring

The desired structure of the scorecard section of the JSON reponse. default is deprecated.

Default "default"
Enum"default""jsonobject"
curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/getresults \
  -H 'Content-Type: multipart/form-data' \
  -F appid=0 \
  -F includescorecard=false \
  -F includetransactions=false \
  -F format=default

Responses

Request successful.

Bodyapplication/json
One of:

Multi-File Results Object

statement_summariesArray of objects(FileConversionResult)
appinfoobject(ApplicationInfo)
scorecardobject(ScoreCardObject_Default)
transactionsArray of objects(AccountJSON)
Response
application/json
{
  "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": { … },
    "declinelist": { … },
    "dailycashflow": { … },
    "monthlycashflow": { … },
    "monthlynegativedays": { … },
    "monthlyrecovery": { … },
    "debittrans": { … },
    "creditcardaccountpayment": { … },
    "lifeinsurance": { … },
    "investmentdebits": { … },
    "mcarefund": { … },
    "mcanorefunds": { … },
    "creditcardprocessortrans": { … },
    "installmentpayment": { … },
    "ecommercetrans": { … },
    "autofinancepayments": { … },
    "studentloanpayments": { … },
    "mortgagepayments": { … },
    "personalloanpayments": { … },
    "combotrans": { … },
    "mcapayments": { … },
    "otherdebits": { … },
    "mobilepaymentsdebits": { … },
    "nefariouswithdrawals": { … },
    "debtcollectortransactions": { … },
    "constructiondebits": { … },
    "nonmcaloans": { … },
    "atmwithdrawals": { … },
    "insurance": { … },
    "reptrans": { … },
    "mcatrans": { … },
    "mcafees": { … },
    "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": [
    { … }
  ]
}

Get remaining

Request

Retrieve the number of remaining conversions on your account.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
curl -i -X GET \
  https://insights.moneythumb.com/api/v1.0/remaining

Responses

Request successful.

Bodyapplication/json
Remaininginteger

The number of remaining conversions.

Response
application/json
{
  "Remaining": 0
}

Zip Archive

Request

Retrieves all PDFs in a zip archive file. Optionally, you can watermark these retrieved PDFs.

Path
versionstringrequired

The version of the API.

Enum"1.0""1.1""1.2""1.3""1.4""1.5"
Example: 1.0
Bodymultipart/form-datarequired
appidintegerrequired

Insights-assigned application identifier.

watermarkLogostring

Creates the watermark logo. When you create a watermark logo, we recommend the following:

  • JPG, PNG, or GIF file formats.
  • Square dimensions no larger than 1200 pixels on one side.
  • No larger than 3MB in file size.
watermarkTextstring

Places an opaque text across the PDF, so you can still read the statement.

watermarkIdTextstring

Places small amount of text in the bottom left of the PDF. You can use this watermarkIdText to uniquely identify the PDF.

watermarkIsFlattenboolean

When set to True, this turns each page of the PDF into an image, making it difficult to remove the watermark.

Default false
watermarkUrlstring

Converts a URL to a QR code and placed in the bottom right of the PDF.

curl -i -X POST \
  https://insights.moneythumb.com/api/v1.0/ziparchive \
  -H 'Content-Type: multipart/form-data' \
  -F appid=0 \
  -F watermarkLogo=string \
  -F watermarkText=string \
  -F watermarkIdText=string \
  -F watermarkIsFlatten=false \
  -F watermarkUrl=string

Responses

Request successful.

Bodyapplication/vnd.ms-excel
string(binary)
Response
No content