Bank statements

Set upload configuration

Changed on Feb 20, 2024

Use the Set upload configuration endpoint to create bank statement upload configuration for the specified data connection.

With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.

Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again.

post/companies/{companyId}/connections/{connectionId}/bankStatements/upload/configuration

Request

Base URL
https://api.codat.io
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/codatio/apis/lending/docs/companies/:companyId/connections/:connectionId/bankStatements/upload/configuration/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

source'codat'

The source of the banking data that determines its format

accountIdstring

The ID of the account in the third-party platform

providerIdstring

TrueLayer provider ID (only required if source is TrueLayer)

Response

Success