# 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/api/pdf-insights/api-reference/other/authenticate>/authenticate</a> and <a href=https://docs.moneythumb.com/api/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>
<p>For details on our Privacy Policy, go <a href=https://www.moneythumb.com/privacy-policy/> here</a>.</p>

Version: 1.5

## Servers

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

## Download OpenAPI description

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

 - [GET /authenticate](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/authenticate.md): Authenticates with username/password and receive a session token for use on other API calls. Requires `Authorization` and `MT-Product` headers. See [Authentication](https://docs.moneythumb.com/api/
 - [GET /getapps](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/getapps.md): Retrieves a list of all the applications available to the credentials submitted.
 - [POST /new](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/new.md): Creates a new application or retrieves an existing one. **Note:** If you're using `appnumber` field in `/uploadpdfs` or `/makecsv`, you don't need to use this endpoint.
 - [POST /scorecard](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/scorecard.md): Retrieve an application's [scorecard](https://docs.moneythumb.com/api/pdf-insights/scorecard).
 - [POST /makexls](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/makexls.md): Retrieve an application's [scorecard](https://docs.moneythumb.com/api/pdf-insights/scorecard).
 - [POST /scorecard/signedUrl](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/signedurl.md): Returns a signed URL that can be used in the browser to open the [scorecard](https://docs.moneythumb.com/api/pdf-insights/scorecard) page without signing in. ⚠️ **Warning:** In order to use this URL i
 - [POST /makecsv](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/makecsv.md): Convert one document and receive its results.
 - [POST /uploadpdfs](https://docs.moneythumb.com/api/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 `webhook` parameter, the
 - [POST /updatesummary](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/updatesummary.md): Updates the summary data of a statement.
 - [POST /googlesheets](https://docs.moneythumb.com/api/pdf-insights/api-reference/paths/~1googlesheets/post.md): Updates scorecard information on an existing Google sheet. ⚠️ **Warning:** Contact [support@moneythumb.com](https://www.moneythumb.com/support/) for assistance to configure Google Sheets for your acco
 - [POST /transactions](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/transactions.md): Retrieve the transactions, either as JSON (structured=true) or CSV (structured=false).
 - [POST /deletestmt](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/deletestmt.md): Deletes a statement.
 - [POST /deletestatement](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/deletestatement.md): Deletes a statement by its statement ID.
 - [POST /getresults](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/getresults.md): Returns the original results of the document conversion for a specified application. Any changes made to the data won't be reflected in the results data.
 - [POST /checkprogress](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/checkprogress.md): Checks the progress of a conversion. 💡 **Tip:** If you don't have a webhook, we recommend using [/makecsv](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/makecsv).
 - [GET /remaining](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/remaining.md): Retrieve the number of remaining conversions on your account.
 - [POST /creditreport](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/creditreport.md): Returns the results a soft credit pull on an application form. ⚠️ **Warning:** Before you run this endpoint, make sure you run [/makecsv](/api/pdf-insights/api-reference/other/makecsv) or [/uploadpdfs
 - [POST /ziparchive](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/ziparchive.md): Retrieves all PDFs in a zip archive file. Optionally, you can watermark these retrieved PDFs.
 - [GET /briefcase/connections](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/connections.md): Retrieves the information about a Briefcase connection.
 - [POST /briefcase/share](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/share.md): Shares documents in an application with the receiving party. When you share, this sends the webhook to the receiver party.
 - [POST /briefcase/respond](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/respond.md): The receiving party's response to the sender. When you respond, it sends the webhook to the sender party. ⚠️ **Warning:** To retrieve the key needed to accept or reject, enable your webhook.
 - [POST /briefcase/update](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/update.md): Notifies the receiving party about the files in an application. Use this whenever you add or replace documents in an application. When you update, it sends the webhook to the receiving party. Once the
 - [GET /briefcase/history](https://docs.moneythumb.com/api/pdf-insights/api-reference/other/history.md): Returns an array of all shared applications that were offered within the last 30 days.
