This API is a request to upload a JSON file containing a Plaid Asset and Transaction data to a Book.
Notes
- This is an Upload endpoint and requires a payload of Content-Type
multipart/form-data. For details on how to encode request bodies in the platform of your choice, refer to our guide on multipart/form-data Payloads.- You can upload multiple JSON files at a time using this endpoint.
This endpoint can take the JSON output from Plaid's /transactions/get or /asset_report/get endpoints. To know more, see /transactions/get and /asset_report/get endpoints.
Having unusual problems?
Users have reported issues with accessing these endpoints from older versions of Plaid's Python and Ruby client libraries. If possible, use the latest versions available. We encourage you to open a ticket with Plaid if you believe you've discovered a bug. In the meantime, you can use an all-purpose HTTP request library as a workaround.
Plaid Asset Reports do not provide Statement Periods. Ocrolus must construct Statement Periods during document analysis. For each Account, Statement Periods are bound by the date of the earliest and latest Transaction in a given month. If an Asset Report JSON file contains transactions from Jan 15th, 2019 to April 4th, 2019, the Statement Periods are:
- Jan 15th - Jan 31st.
- Feb 1st - Feb 28th.
- March 1st - March 31st.
- April 1st - April 4th.
Where should you upload JSON?
We recommend that you create a separate Book to process each Plaid Asset Report. Try to avoid uploading JSON files alongside PDF statements, as the two are unlikely to reconcile.