Skip to content

Bankaccount Data API (2)

This API provides services to validate and to confirm bank account data, and to manage payment fraud cases

Overview
URL

https://www.cdq.ch/team

Sebastian Kaczmarski

sebastian.kaczmarski@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/

Production SOAP

https://api.corporate-data-league.ch/bankaccount-data/soap/v2/

Production

https://api.corporate-data-league.ch/bankaccount-data/

Whitelists

The Whitelists API provides endpoints to manage the whitelist entries.

Operations

Database Cleanup

Endpoints for cleaning up and resetting databases in test environments.

WARNING: These endpoints should ONLY be used in test/development environments. They permanently delete data and should never be exposed in production.

Use these endpoints to:

  • Clear test data between test runs
  • Reset database state for integration tests
  • Clean up test fixtures
Operations

Bank Account Storages Management

Gather endpoints that provide functionalities for managing bank account storages. These functionalities include creating a new storage for bank account data, reading the details of a specific bank account storage identified by its storage ID, modifying the details of an existing bank account storage, deleting an existing bank account storage, and removing all bank account data from a specific storage.

Operations

Bank Account Verification

Gather endpoints that provide functionalities for verifying bank account data. These functionalities include confirming the reliability of given bank account data by CDL Trust Scores provided by other companies for the given bank account, curating the given bank account, and uploading bank accounts for batch confirmation.

Operations

Bank Accounts

Gather endpoints that provide functionalities for managing bank accounts. These functionalities include reading bank account data, upserting bank account data, deleting bank account data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

Operations

Bank Data Lookup

Gather endpoints that provide functionalities for looking up bank information. These functionalities include looking up bank information based on the given bank data lookup request.

Operations

Fraud Case Management

Gather endpoints that provide functionalities for managing fraud cases. These functionalities include creating a new fraud case, reading the details of a specific fraud case identified by its case ID, modifying the details of an existing fraud case, deleting an existing fraud case, and removing all fraud case data from a specific storage.

Operations

System Bank Data Sources

Gather endpoints that provide functionalities for managing system bank data sources. These functionalities include creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

System Banks

Gather endpoints that provide functionalities for managing system banks. These functionalities include reading system banks, upserting system bank data, deleting system bank data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

Files

Gather endpoints that provide functionalities for managing files. These functionalities include uploading a file to S3.

Operations

Fraud Cases

Operations

Bank Data Sources

Operations

List bank data source

Request

List new bank data source.

Query
loadMetadataboolean

Determines if metadata needs to be loaded

Example: loadMetadata=true
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
limitinteger(int32)>= 1

Number of resources to be returned on the page.

Default 500
Example: limit=200
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/v2/bankdatasources

Responses

Created

Bodyapplication/json
valuesArray of objects(BankDataSource)
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
Response
application/json
{
  "values": [
    { … }
  ],
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67"
}

Create bank data source

Request

Create new bank data source.

Bodyapplication/jsonrequired
aleiPrefixstring(AleiPrefix)

Data source alei prefix

Example: "DE.GCB"
namestring(BankDataSourceName)

Name of the data source

Example: "German bank sort code register"
resourceobject(BankDataSourceResource)

Information required for processing resource

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/v2/bankdatasources \
  -H 'Content-Type: application/json' \
  -d '{
    "aleiPrefix": "DE.GCB",
    "name": "German bank sort code register",
    "resource": {
      "type": "FILE",
      "format": "CSV",
      "baseUri": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
      "website": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
      "scheduledAt": "0 0 * * 6,0",
      "fileSuffix": ".csv",
      "recordIdColumnName": "BIC",
      "urlPattern": "https://www\\.centralbankmalta\\.org/site/Payment-Systems/BIC-sort-codes\\.xlsx  ",
      "charset": "UTF-8",
      "delimiter": ";"
    }
  }'

Responses

Created

Bodyapplication/json
idstring(BankDataSourceId)

Data source id

Example: "507f1f77bcf86cd799439011"
aleiPrefixstring(AleiPrefix)

Data source alei prefix

Example: "DE.GCB"
namestring(BankDataSourceName)

Name of the data source

Example: "German bank sort code register"
descriptionstring(BankDataSourceDescription)

Description of the data source

Example: "Register of bank sort codes in Germany provided by Deutsche Bundesbank"
resourceobject(BankDataSourceResource)

Information required for processing resource

licenceobject(BankDataSourceLicence)

Licences of the data source

classificationobject(BankDataSourceClassification)

TBD

Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "aleiPrefix": "DE.GCB",
  "name": "German bank sort code register",
  "description": "Register of bank sort codes in Germany provided by Deutsche Bundesbank",
  "resource": {
    "type": "FILE",
    "format": "CSV",
    "baseUri": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "website": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "scheduledAt": "0 0 * * 6,0",
    "fileSuffix": ".csv",
    "recordIdColumnName": "BIC",
    "urlPattern": "https://www\\.centralbankmalta\\.org/site/Payment-Systems/BIC-sort-codes\\.xlsx  ",
    "charset": "UTF-8",
    "delimiter": ";"
  },
  "licence": {
    "url": "https://www.bundesbank.de/en/homepage/user-information/terms-of-use-642972",
    "legalApprovalAt": "2024-01-15T00:00:00.000Z"
  },
  "classification": {
    "ownership": "TBD",
    "completeness": "TBD"
  }
}

Read bank data source

Request

Read new bank data source.

Path
aleiPrefixstringrequired

Alei Prefix

Example: DE.GCB
Query
loadMetadataboolean

Determines if metadata needs to be loaded

Example: loadMetadata=true
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/v2/bankdatasources/DE.GCB

Responses

Found

Bodyapplication/json
idstring(BankDataSourceId)

Data source id

Example: "507f1f77bcf86cd799439011"
aleiPrefixstring(AleiPrefix)

Data source alei prefix

Example: "DE.GCB"
namestring(BankDataSourceName)

Name of the data source

Example: "German bank sort code register"
descriptionstring(BankDataSourceDescription)

Description of the data source

Example: "Register of bank sort codes in Germany provided by Deutsche Bundesbank"
resourceobject(BankDataSourceResource)

Information required for processing resource

licenceobject(BankDataSourceLicence)

Licences of the data source

classificationobject(BankDataSourceClassification)

TBD

Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "aleiPrefix": "DE.GCB",
  "name": "German bank sort code register",
  "description": "Register of bank sort codes in Germany provided by Deutsche Bundesbank",
  "resource": {
    "type": "FILE",
    "format": "CSV",
    "baseUri": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "website": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "scheduledAt": "0 0 * * 6,0",
    "fileSuffix": ".csv",
    "recordIdColumnName": "BIC",
    "urlPattern": "https://www\\.centralbankmalta\\.org/site/Payment-Systems/BIC-sort-codes\\.xlsx  ",
    "charset": "UTF-8",
    "delimiter": ";"
  },
  "licence": {
    "url": "https://www.bundesbank.de/en/homepage/user-information/terms-of-use-642972",
    "legalApprovalAt": "2024-01-15T00:00:00.000Z"
  },
  "classification": {
    "ownership": "TBD",
    "completeness": "TBD"
  }
}

Update bank data source

Request

Update new bank data source.

Path
aleiPrefixstringrequired

Alei Prefix

Example: DE.GCB
Bodyapplication/jsonrequired
namestring(BankDataSourceName)

Name of the data source

Example: "German bank sort code register"
resourceobject(BankDataSourceResource)

Information required for processing resource

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/v2/bankdatasources/DE.GCB \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "German bank sort code register",
    "resource": {
      "type": "FILE",
      "format": "CSV",
      "baseUri": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
      "website": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
      "scheduledAt": "0 0 * * 6,0",
      "fileSuffix": ".csv",
      "recordIdColumnName": "BIC",
      "urlPattern": "https://www\\.centralbankmalta\\.org/site/Payment-Systems/BIC-sort-codes\\.xlsx  ",
      "charset": "UTF-8",
      "delimiter": ";"
    }
  }'

Responses

Updated

Bodyapplication/json
idstring(BankDataSourceId)

Data source id

Example: "507f1f77bcf86cd799439011"
aleiPrefixstring(AleiPrefix)

Data source alei prefix

Example: "DE.GCB"
namestring(BankDataSourceName)

Name of the data source

Example: "German bank sort code register"
descriptionstring(BankDataSourceDescription)

Description of the data source

Example: "Register of bank sort codes in Germany provided by Deutsche Bundesbank"
resourceobject(BankDataSourceResource)

Information required for processing resource

licenceobject(BankDataSourceLicence)

Licences of the data source

classificationobject(BankDataSourceClassification)

TBD

Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "aleiPrefix": "DE.GCB",
  "name": "German bank sort code register",
  "description": "Register of bank sort codes in Germany provided by Deutsche Bundesbank",
  "resource": {
    "type": "FILE",
    "format": "CSV",
    "baseUri": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "website": "https://www.bundesbank.de/resource/blob/926192/78739d2ee16e22585dcf714900e479f3/472B63F073F071307366337C94F8C870/blz-aktuell-csv-data.csv",
    "scheduledAt": "0 0 * * 6,0",
    "fileSuffix": ".csv",
    "recordIdColumnName": "BIC",
    "urlPattern": "https://www\\.centralbankmalta\\.org/site/Payment-Systems/BIC-sort-codes\\.xlsx  ",
    "charset": "UTF-8",
    "delimiter": ";"
  },
  "licence": {
    "url": "https://www.bundesbank.de/en/homepage/user-information/terms-of-use-642972",
    "legalApprovalAt": "2024-01-15T00:00:00.000Z"
  },
  "classification": {
    "ownership": "TBD",
    "completeness": "TBD"
  }
}

Delete bank data source

Request

Delete new bank data source.

Bodyapplication/jsonrequired
aleiPrefixesArray of strings(AleiPrefix)[ 1 .. 500 ] items

Bank Data Sources to delete

Example: ["DE.GCB"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/v2/bankdatasources/delete \
  -H 'Content-Type: application/json' \
  -d '{
    "aleiPrefixes": [
      "DE.GCB"
    ]
  }'

Responses

Deleted

Bodyapplication/json
resultsArray of objects(BankDataSourceDeleteResult)

Bank Data Sources deletion results

Response
application/json
{
  "results": [
    { … }
  ]
}

Bank Address Curation

Operations

Bank Account Storages

Operations

Processing logs

Operations

Bank Account Storage Data Monitors

Operations