# inscribe Documentation ## Guides - [Getting Started with Collect](https://docs.inscribe.ai/docs/getting-started-with-collect.md) - [How are Transactions Enriched?](https://docs.inscribe.ai/docs/how-are-transactions-enriched.md) - [FAQs](https://docs.inscribe.ai/docs/faqs.md): Frequently asked questions about Inscribe's Credit Analysis - [Documents classified by source bank name](https://docs.inscribe.ai/docs/documents-classified-by-bank-names.md): Bank statements classified by source institutions which we currently support - [Are the Endpoints Rate Limited?](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited.md) - [FAQs](https://docs.inscribe.ai/docs/faqs-1.md) - [Overview - Integrating with Inscribe via API](https://docs.inscribe.ai/docs/overview-integrating-with-inscribe-via-api.md): A visual overview of typical integrations with Inscribe - [Submitting Open Banking Data](https://docs.inscribe.ai/docs/submitting-open-banking-data.md): Guide to submitting open banking data in Inscribe - [Getting Started with Transaction Enrichment](https://docs.inscribe.ai/docs/getting-started-with-inscribe-transactions.md) - [Getting Started with Inscribe Webhooks](https://docs.inscribe.ai/docs/getting-started-with-inscribe-webhooks.md) ## API Reference - [Retrieve a Bank Account](https://docs.inscribe.ai/reference/getbankaccount.md): Retrieves the details of an existing customer's bank account. Supply the unique customer id and unique bank account id for that customer from the customer list and bank account list respectively. - [List Bank Accounts](https://docs.inscribe.ai/reference/getbankaccounts.md): Returns a list of bank accounts for a customer. The list is sorted by creation date, with the most recently created bank accounts appearing first. - [Add Document Requests](https://docs.inscribe.ai/reference/adddocumentrequest.md): Add a document request to a Collect Session - [Create Collect Session](https://docs.inscribe.ai/reference/createsession.md): Inscribe's Collect API allows you to automate each step of your document collection process, from customer contact to fraud checks and verification. In order to initiate a Collect Session, you will need to provide Inscribe with information about the user you wish to collect documents from, as well as the documents you need to collect from them. You will also need to provide your authentication details. - [Delete Document Request](https://docs.inscribe.ai/reference/deletedocumentrequest.md): Remove a collect session document request by its given UUID - [Retrieve a Collect Session](https://docs.inscribe.ai/reference/getcollectsession.md): Retrieve a collect session by UUID - [List all Collect Sessions](https://docs.inscribe.ai/reference/getcollectsessions.md): Retrieve a paginated list of collect sessions for your organization. - [Update Collect Session](https://docs.inscribe.ai/reference/updatecollectsession.md): Edit properties of a collect session. - [Retrieve Summary Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysis.md): Returns income and creditworthiness information derived from a submitted customer bank account. - [Retrieve Cashflow Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysiscashflowinsights.md): Returns cashflow and balance insights derived from a submitted customer bank account. - [Retrieve Expenditure Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysisexpenditureinsights.md): Returns expenditure insights derived from submitted customer documents and transactions.. - [Retrieve Income Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysisincomeinsights.md): Returns income insights derived from a submitted customer bank account. - [Retrieve Loan Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysisloaninsights.md): Returns loan insights derived from a submitted customer bank account. - [Retrieve Risk Insights (Bank Account)](https://docs.inscribe.ai/reference/getbankaccountcreditanalysisriskinsights.md): Returns risk insights derived from a submitted customer bank account. - [Retrieve Summary Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysis.md): Returns income and creditworthiness information extracted from transactions belonging to a specific customer. - [Retrieve Cashflow Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysiscashflowinsights.md): Returns cashflow and balance insights derived from submitted customer documents and transactions. - [Retrieve Expenditure Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysisexpenditureinsights.md): Returns expenditure insights derived from submitted customer documents and transactions. - [Retrieve Income Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysisincomeinsights.md): Returns income insights derived from submitted customer documents and transactions. - [Retrieve Loan Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysisloaninsights.md): Returns loan insights derived from submitted customer documents and transactions. - [Retrieve Risk Insights (Customer)](https://docs.inscribe.ai/reference/getcustomercreditanalysisriskinsights.md): Returns risk insights derived from submitted customer documents and transactions. - [Create a Customer](https://docs.inscribe.ai/reference/addcustomer.md): Creates a customer object to easily track and store documents. - [Delete a Customer](https://docs.inscribe.ai/reference/deletecustomer.md): Permanently deletes a customer and all documents associated with this customer. It cannot be undone. - [Retrieve a Customer](https://docs.inscribe.ai/reference/getcustomer.md): Retrieves the details of an existing customer. Supply the unique customer id from either a customer creation request or the customer list. - [List all Customers](https://docs.inscribe.ai/reference/getcustomers.md): Returns a paginated list of your customers based on optional query parameters. If the customer search query parameter is used, the list is sorted by relevance, otherwise, the customers are returned sorted by creation date, with the most recently created customers appearing first. - [Update a Customer](https://docs.inscribe.ai/reference/updatecustomer.md): Updates the specific customer by setting the values of the parameters passed. Any non-required parameters not provided will be left unchanged. - [Delete a Document](https://docs.inscribe.ai/reference/deletedocument.md): Delete document. This cannot be undone - [Retrieve a Document](https://docs.inscribe.ai/reference/getdocumentresults.md): Retrieve results and information of an existing document. Supply the unique customer id from either a customer creation request or the customer list, and the document id from either a document upload request or a list of documents from the customer. Inscribe will return the corresponding document overview when the document is in the PROCESSED state, until then some information will be unavailable. A webhook can be configured to receive PROCESSED document results in real-time. - [List all Documents](https://docs.inscribe.ai/reference/getdocuments.md): Returns a list of all of your documents for a customer. The list is sorted by creation date, with the most recently created documents appearing first. - [Update a Document](https://docs.inscribe.ai/reference/updatedocument.md): Update document. - [Upload Document(s)](https://docs.inscribe.ai/reference/uploaddocuments.md): Uploads document(s) to a customer. Once the document(s) are uploaded, they will be queued for processing by Inscribe's fraud detection, parsing, and optionally verification algorithms. The file size limit is 50 MB and the page limit for PDFs is 350. - [Delete Open Banking Data](https://docs.inscribe.ai/reference/deleteopenbankingdata.md): Permanently deletes an Open Banking Data, as well as all accounts and transactions associated with the data. It cannot be undone. - [Delete a Plaid Asset Report](https://docs.inscribe.ai/reference/deleteplaidassetreport.md): Permanently deletes a Plaid Asset Report, as well as all accounts and transactions associated with the data. It cannot be undone. **Warning** This endpoint is deprecated. The recommended endpoint is [Delete Open Banking Data](https://docs.inscribe.ai/reference/deleteopenbankingdata). - [List Open Banking Data](https://docs.inscribe.ai/reference/getopenbankingdata.md): Returns a paginated list of Open Banking Data related to an Inscribe customer. The list is sorted by creation date in ascending order, with the oldest data appearing first. - [List all Plaid Asset Reports](https://docs.inscribe.ai/reference/getplaidassetreport.md): Returns a paginated list of Plaid Asset Reports related to a customer. The list is sorted by creation date in ascending order, with the oldest data appearing first. **Warning** This endpoint is deprecated. The recommended endpoint is [Get Open Banking Data](https://docs.inscribe.ai/reference/getopenbankingdata). - [Upload Open Banking Data (Inscribe Financial Data Format) (BETA)](https://docs.inscribe.ai/reference/uploadinscribeopenbankingdata.md): Uploads Open Banking Data (Inscribe Financial Data Format) to an Inscribe customer (BETA). See our guide to submitting open banking data [here](https://docs.inscribe.ai/docs/submitting-open-banking-data). - [Upload Open Banking Data (MX Aggregated Data)](https://docs.inscribe.ai/reference/uploadmxaggregatedopenbankingdata.md): Uploads MX Aggregated Data to an Inscribe customer. MX Aggregated Data is a format made by combining the responses from various MX endpoint requests. Once the request is received, the MX Aggregated Data will be processed by Inscribe’s Credit Insights service. See our guide to submitting open banking data [here](https://docs.inscribe.ai/docs/submitting-open-banking-data). - [Upload Plaid Asset Report](https://docs.inscribe.ai/reference/uploadplaidassetreport.md): Uploads a Plaid Asset Report to a customer. Once a Plaid Asset Report is uploaded, it will be processed by Inscribe’s Credit Insights service which returns customer insights derived from the open banking data. **Warning** This endpoint is deprecated. The recommended endpoint is [Upload Plaid Asset Report Open Banking Data](https://docs.inscribe.ai/reference/uploadplaidassetreportopenbankingdata). - [Upload Open Banking Data (Plaid Assets Report)](https://docs.inscribe.ai/reference/uploadplaidassetreportopenbankingdata.md): Uploads open banking data in the format of a Plaid Asset Report to an Inscribe customer. Once the request is received, the open banking data will be processed by Inscribe’s Credit Insights service. See our guide to submitting open banking data [here](https://docs.inscribe.ai/docs/submitting-open-banking-data). - [Reachability Check](https://docs.inscribe.ai/reference/reachability-check-2.md): By querying this endpoint, you can check if it's possible to reach Inscribe's services from your own infrastructure. This endpoint does not require any authentication but is rate limited. It does not indicate that all services are working without an error. For those notifications, please subscribe to our status page at . - [List Transactions for a Bank Account](https://docs.inscribe.ai/reference/getbankaccounttransactions.md): Returns a list of transactions for a customer's bank account. The list is sorted by creation date, with the most recently created transactions appearing first. Most query parameters should be passed only once for filtering. However, there are two exceptions: - `category`: This parameter can be passed multiple times to filter transactions by category. - `data_source`: This parameter can also be passed multiple times to filter transactions by data source. Please refer to the individual parameter descriptions for more details on usage. - [List Transactions for a Customer](https://docs.inscribe.ai/reference/getcustomertransactions.md): Returns a list of transactions for a customer. The list is sorted by data source, with transactions from bank statements listed first, followed by transactions from open banking data. Within each of the data sources, the transactions are ordered by creation date, with the most recently created transactions appearing first. Most query parameters should be passed only once for filtering. However, there are two exceptions: - `category`: This parameter can be passed multiple times to filter transactions by category. - `data_source`: This parameter can also be passed multiple times to filter transactions by data source. Please refer to the individual parameter descriptions for more details on usage. - [List Inscribe Transaction Categories](https://docs.inscribe.ai/reference/gettransactioncategories.md): Retrieves the hierarchy of transaction categories that Inscribe uses in its transaction enrichment. Every uploaded transaction will be assigned one of these transaction categories (or null if no category is found). Inscribe categories are presented in the form of a hierarchy. More information is available via our [guides](https://docs.inscribe.ai/docs/how-are-transactions-enriched). - [Recategorize Transactions](https://docs.inscribe.ai/reference/recategorizetransactions.md): Assign a new category to a group of transaction ids - [Authentication](https://docs.inscribe.ai/reference/authentication.md) - [Overview](https://docs.inscribe.ai/reference/overview.md) ## Recipes - [Collect Session](https://docs.inscribe.ai/recipes/collect-session.md) - [Get Enriched Customer Transactions](https://docs.inscribe.ai/recipes/get-enriched-customer-transactions.md) - [Get Insights into a Customer's Creditworthiness](https://docs.inscribe.ai/recipes/get-insights-into-a-customers-creditworthiness.md) - [Quickstart](https://docs.inscribe.ai/recipes/quickstart-1.md) - [Transaction Parsing](https://docs.inscribe.ai/recipes/transaction-parsing.md) - [Verifying a Customer's Income](https://docs.inscribe.ai/recipes/verifying-a-customers-income.md)