Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
File Uploads

Import Plaid Asset Report

Import an Asset Report directly from Plaid and construct a <glossary:Document> from it.

With fully automated workflows in mind, Ocrolus and Plaid offer the ability to directly import the Asset Report of any customer who has provided Bank Account details via Plaid - without you having to explicitly download and handle the JSON report.

To achieve this, Plaid will ask you to share an Audit Copy of the Asset Report directly with Ocrolus.

Next, Ocrolus will use the provided audit_copy_token to extract the associated Audit Report from Plaid. This must be a production token, as Ocrolus does not support sandbox tokens.

Then, Ocrolus will import the Audit Report into the specified <glossary:Book>.

📘 Creating an Audit Copy Token

  • You can create an Audit Copy Token with Plaid using our auditor_id of ocrolus. Use this value when invoking the createAuditCopy function on the Plaid client object.

🚧 Due to masking of account numbers in Plaid data, we are unable to reconcile bank accounts across Plaid data and PDF bank statements. Mixing such uploads within the same book may result in duplicate bank accounts, periods and transactions.

post/v1/book/import/plaid/asset

Request body

pkinteger required

The <glossary:PK> of the <glossary:Book> that the constructed <glossary:Document> will be saved to.

audit_copy_tokenstring required

Asset Report copy token provided by Plaid.

form_typestring

The code identifying the type of <glossary:Document> that you're uploading.

doc_namestring

The name of the <glossary:Document> that will be created from the imported data. Defaults to audit_copy_token if not given.

Example request

{
  "pk": 30219565,
  "form_type": "PAYSTUB",
  "doc_name": "example_document"
}

Response

Success

OR

Example response

{
  "status": 200,
  "message": "OK",
  "response": {
    "uploaded_docs": [
      {
        "created_ts": "2023-03-03T04:36:31.000Z",
        "name": "78467b0b5f0bb818a30a6d7c361385",
        "checksum": "50a62f72f4b5b80b18f75fbed690dc47",
        "pk": 123,
        "uuid": 123
      }
    ]
  }
}