# PDF Insights API

The PDF Insights API supports three products.   Which product you have a license for determines how much of this API is accessible to you.
<ul> <li> <b>PDF Insights w/Thumbprint</b> - The full API is available. <li> <b>PDF Insights</b> - All endpoints are available but Thumbprint scores will not return. <li> <b>Thumbprint</b> - Only <a href=https://docs.moneythumb.com/pdf-insights/api-reference/other/authenticate>/authenticate</a> and <a href=https://docs.moneythumb.com/pdf-insights/api-reference/other/uploadpdfs>/uploadpdfs</a> endpoints are available. </ul>
<p>If this is your first time, we strongly encourage you to start with one of our Quickstarts.</p>


Version: 1.5

## Servers

Live Testing
```
https://insights.moneythumb.com/api/v1.0
```

## Download OpenAPI description

[PDF Insights API](https://docs.moneythumb.com/_spec/PDF%20Insights/@1.5/API%20Reference/index.yaml)

## Other

### Authenticate

 - [GET /authenticate](https://docs.moneythumb.com/pdf-insights/api-reference/other/authenticate.md): Authenticates with username/password and receive a session token for use on other API calls.  Requires  and  headers.   See Authentication page for further details.

### List applications

 - [GET /getapps](https://docs.moneythumb.com/pdf-insights/api-reference/other/getapps.md): Retrieves a list of all the applications available to the credentials submitted.

### Create application

 - [POST /new](https://docs.moneythumb.com/pdf-insights/api-reference/other/new.md): Create a new application or retrieve an existing one.

### Get scorecard

 - [POST /scorecard](https://docs.moneythumb.com/pdf-insights/api-reference/other/scorecard.md): Retrieve an application's scorecard.

### Get scorecard (Excel)

 - [POST /makexls](https://docs.moneythumb.com/pdf-insights/api-reference/other/makexls.md): Retrieve an application's scorecard.

### Retrieve signed scorecard URL

 - [POST /scorecard/signedUrl](https://docs.moneythumb.com/pdf-insights/api-reference/other/signedurl.md): Returns a signed URL that can be used in the browser to open the scorecard page without signing in. 

⚠️  In order to use this URL in an iframe, your domain will need to be whitelisted. Please contact support@moneythumb.com for assistance.

### Convert a document

 - [POST /makecsv](https://docs.moneythumb.com/pdf-insights/api-reference/other/makecsv.md): Convert one document and receive its results.

### Convert multiple documents

 - [POST /uploadpdfs](https://docs.moneythumb.com/pdf-insights/api-reference/other/uploadpdfs.md): 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  parameter, the following will occur:
 1. This call will return a .
 2. Once conversion is complete, Insights will call the provided webhook URL with the results.

Sychronous (deprecated): If the  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,  will be returned and you will need to use other endpoints to retrieve the results.

While not required, we recommend including the following parameters:
 *  - Specifies the type of document. You can also use to automatically pick up different types of documents.
 *  - (true/false) Includes the full underwriting scorecard in the results.
 *  - (true/false) Includes the full transaction list in the results.
 * format - Changes the structure of the JSON for the scorecard (if included).   is recommended.
 

### Update summary

 - [POST /updatesummary](https://docs.moneythumb.com/pdf-insights/api-reference/other/updatesummary.md): Updates the summary data of a statement.

### Update Google Sheets

 - [POST /googlesheets](https://docs.moneythumb.com/pdf-insights/api-reference/paths/~1googlesheets/post.md): Updates scorecard information on an existing Google sheet.

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

### Get transactions

 - [POST /transactions](https://docs.moneythumb.com/pdf-insights/api-reference/other/transactions.md): Retrieve the transactions, either as JSON (structured=true) or CSV (structured=false).

### Delete statement

 - [POST /deletestmt](https://docs.moneythumb.com/pdf-insights/api-reference/other/deletestmt.md): Deletes a statement.

### Get results

 - [POST /getresults](https://docs.moneythumb.com/pdf-insights/api-reference/other/getresults.md): Retrieve the results of a conversion.

### Get remaining

 - [GET /remaining](https://docs.moneythumb.com/pdf-insights/api-reference/other/remaining.md): Retrieve the number of remaining conversions on your account.

### Zip Archive

 - [POST /ziparchive](https://docs.moneythumb.com/pdf-insights/api-reference/other/ziparchive.md): Retrieves all PDFs in a zip archive file. Optionally, you can watermark these retrieved PDFs.