This Quickstart applies to:
- PDF Insights
- PDF Insights w/Thumbprint
Verify that you can log into the Insights UI using your username and password.
Call GET https://insights.moneythumb.com/api/v1.5/authenticate
.
Include the following headers:
Header | Value |
---|---|
Authorization | Basic [base64-encoded username:password] |
MT-Product | Eitherpdfinsights (PDF Insights), or pdfinsightstp (PDF Insights w/Thumbprint) |
No request body is required.
You should receive a 200 OK
response with a session token in the response body.
For further details, see:
Call POST https://insights.moneythumb.com/api/v1.5/uploadpdfs
.
Include the following headers:
Header | Value |
---|---|
Authorization | Bearer [session token] |
MT-Product | Eitherpdfinsights (PDF Insights), or pdfinsightstp (PDF Insights w/Thumbprint) |
Content-Type | multipart/form-data |
Include the following form-data fields in the body:
Name | Type | Value |
---|---|---|
appnumber | string | Any string to identify this application. |
pdf-filename | blob | The file (i.e., bank statement) to upload. |
You should receive a 200 OK
response with a reponse body matching this structure:
{
statement_summmaries: [],
appinfo: {}
}
For details, see the /uploadpdfs endpoint.
Note: You should now be able to see this deal in the UI.
Repeat the same /uploadpdfs
call from Step 3, but now add three additional form-data fields:
Name | Type | Value |
---|---|---|
includescorecard | string | true |
includetransactions | string | true |
format | string | jsonobject |
You should receive a 200 OK
response with a reponse body matching this structure:
{
statement_summmaries: [],
appinfo: {},
scorecard: {},
transactions: []
}
Image documents are converted asynchronously and their results returned by callback (aka webhook). We strongly encourage you to use this approach for all documents.
Either use a third-party service or create your own endpoint to receive the callback. The body of the callback request will match the output you received from /uploadpdfs
in Step 4.
Repeat the same /uploadpdfs
call from Step 4, but add one additional form-data field:
Name | Type | Value |
---|---|---|
webhook | string | The URL to which the results should be sent. It should be in the format https://www.mydomain.com/my-endpoint |
You should receive a 202 ACCEPTED
response.
A few seconds to a few minutes later (depending on the size and format of the file), your callback endpoint should receive a request. The request body should match this structure:
{
statement_summmaries: [],
appinfo: {},
scorecard: {},
transactions: []
}
- Explore the /uploadpdfs documentation.
- Set the
finduntrue
form-data field totrue
to automatically identify untrue transactions. - Try converting multiple files at once (include as many
pdf-filename
form-data fields as you like). - Customize which scorecard sections you want returned with the
sections
form-data field. - Add retry logic to your API calls (but please include a retry limit).