From Version 0.0

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

To get the most out of PDF Insights, we strongly recommend that you migrate to version 1.5 of our API.

Migrating to Version 1.5

To mitgrate from Version 0.0 to Version 1.5, follow the steps below.

Updating Your API Version

You can upgrade in three steps:

1. Change your URL from /webapi/<path>/<endpoint> to /api/v1.5/<endpoint> in all calls.
2. Switch to the header authentication method for all calls.
3. Update each individual API call by using steps 1 and 2.

Using Header Authentication

In Version 1.5, you now send authentication credentials in request headers instead of the body.

Username/Password

If you currently send username and password to /webapi/authenticate and then use the session token for the other API calls, do the following:

1. Log into PDF Insights to confirm your credentials work.

2. Remove the following fields from your calls:

   • username
   • password
   • product
   • token
   • customer-id

3. Make a first call to GET /api/v1.5/authenticate to receive a session token. Send two headers:

   • Authorization: Basic base64(username:password)
   • MT-Product: <pdfinsights or pdfinsightstp>

4. Make all other API calls with the headers

   • Authorization: Bearer <session token>
   • MT-Product: <pdfinsights or pdfinsightstp>

License Code

If you currently send a 96-digit license code with all API calls, do the following:

1. Remove the following fields from your calls:
   • username
   • password
   • product
   • token
   • customer-id
2. Send the following two headers with all your API calls:
   • Authorization: Bearer <license coce>
   • MT-Product: <pdfinsights or pdfinsightstp>

Note: We strongly recommend you to switch to username/password authentication (see above) as license codes are long-lived and hard to revoke.

For more information, see Authentication.

Update API Endpoints

Use the table below to find the equivalent v1.5 API call for each v0.0 call you make.

Next Steps

Once you migrated to version 1.5, explore these endpoints and features to get the most out of the latest version of PDF Insights.

Convert Multiple Files using One Endpoint

Instead of using /makecsv endpoint to convert one file at a time, you can now use the /uploadpdfs endpoint. This endpoint now allows you to authenticate, convert multiple files, and bring in Scorecard and Transaction data--all in one call.

For details, see Convert multiple documents.

Retrieve MoneyThumb Scorecard in Excel Format

You can now retrieve the MoneyThumb scorecard in an Excel format by using the /makexls endpoint. For details, see Get scorecard (Excel).

Retrieve a SignedURL to see MoneyThumb Scorecard

You can now retrieve a signedURL to see the MoneyThumb scorecard by using the /signedURL endpoint. For details, see Retrieve signed scorecard URL.

Update the MoneyThumb Scorecard in Google Sheets

You can now update the MoneyThumb Scorecard in Google Sheets by using the /googlesheets endpoint. For details, see Update Google Sheets.

See Conversion Results

To see the conversion results, use the /getresults endpoint. For details, see Get Results.

See Remaining Conversions

To see the remaining conversions, use the /getremaining endpoint. For details, see Get Remaining.

Update Summary Data in Statements

You can now update the summary data in statements by using the /updatesummary endpoint. For details, see Update summary.

Delete Statements

You can now delete a statement from your conversions by using the /deletestmt endpoint. For details, see Delete Statement.

New Way to Update Profile Information

The /profile/setvalue endpoint has been deprecated. So now, you can update all profile information for a user in the Underwriter Settings of the Insights UI.

Additional Enhancements

• When using the /uploadpdfs endpoint with a webhook parameter, there's a 202 response that says the file was accepted.
• Duplicate field names have been removed.
• Simplified the date format in the response. The dates are now in yyyy-mm-dd strings.
• Each transaction now has a unique id field in the response.
• Added an index number field (accountidx) for accounts and transactions in the response for the scorecard.
• All error messages now return in JSON format.
• The default format of the Scorecard JSON output was changed to replace spaces with underscores, # with num, and all apostrophes and slashes were removed.
• We've changed tpreasons to be text values of the ThumbPrint reasons instead of the previously used index numbers.
• For webhook calls made by MT, the HTTP User-Agent is now set to MoneyThumbWebhook/<version>. You might need to update your whitelist with the new MT User-Agent.