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

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Mock server

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

Production

https://api.cdq.com/bankaccount-data/rest/

Data Transformation Definitions

Gather endpoints that provide functionalities for testing data transformation definitions. These functionalities include testing data transformation definitions.

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.

Operations

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.

Operations

Files

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

Operations

Bank Data Sources

Operations

Bank Account Storage Data Monitors

Operations

List Bank Account Storage Data Monitors

Request

List all Data Monitors of the give Bank Account Storage.

Security
apiKey
Path
storageIdstring(BankAccountStorageId)required

Unique identifier of the BankAccountStorage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
startAfterstring

Indicator for the next page.

Example: startAfter=5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a
limitinteger(int32)[ 1 .. 100 ]

Number of results that should be fetched. Maximum 100 results can be returned in one page.

Default 50
Example: limit=50
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/72d6900fce6b326088f5d9d91049e3e6/datamonitors \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
valuesArray of objects(DataMonitor)

List of Data Monitors.

Example: "[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]"
limitinteger(Limit)

Number of items per page.

Example: "100"
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"
totalinteger(PageTotal)

Total number of items which can be paged.

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

Create Data Monitor

Request

Create a new Bank Account Storage Data monitor.

Data monitor is a concept for asynchronous processing of data.

Data monitors should be unique by a pair: bankAccountStorageId + type.

Security
apiKey
Path
storageIdstring(BankAccountStorageId)required

Unique identifier of the BankAccountStorage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired
namestring(DataMonitorName)required

Data Monitor name.

Example: "Trust Score Data Monitor Name"
typestring(DataMonitorType)required

Unique identifier of a Bank Account Storage Data Monitor type.

ValueDescription
TRUST_SCORE

To calculate Trust Score for Bank Accounts.

Example: "TRUST_SCORE"
enabledboolean(DataMonitorToggle)required

The toggle used to enable or disable the Data Monitor.

Example: true
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/72d6900fce6b326088f5d9d91049e3e6/datamonitors \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Trust Score Data Monitor Name",
    "type": "TRUST_SCORE",
    "enabled": true
  }'

Responses

OK

Bodyapplication/json
idstring(DataMonitorId)

Unique identifier of Data Monitor.

Example: "ff864c7bfe38397b8c160bc624f97574"
namestring(DataMonitorName)

Data Monitor name.

Example: "Trust Score Data Monitor Name"
typestring(DataMonitorType)

Unique identifier of a Bank Account Storage Data Monitor type.

ValueDescription
TRUST_SCORE

To calculate Trust Score for Bank Accounts.

Example: "TRUST_SCORE"
enabledboolean(DataMonitorToggle)

The toggle used to enable or disable the Data Monitor.

Example: true
createdAtstring(DataMonitorCreatedAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
modifiedAtstring(DataMonitorModifiedAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
disabledAtstring(DataMonitorDisabledAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
Response
application/json
{
  "id": "ff864c7bfe38397b8c160bc624f97574",
  "name": "Trust Score Data Monitor Name",
  "type": "TRUST_SCORE",
  "enabled": true,
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z",
  "disabledAt": "2025-08-29T09:46:42Z"
}

Update Data Monitor

Request

Possibility to update fields of the Bank Account Storage Data Monitor.

Security
apiKey
Path
storageIdstring(BankAccountStorageId)required

Unique identifier of the Bank Account Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
dataMonitorIdstring(DataMonitorId)required

Unique ID of a Bank Account Storage Data Monitor.

Example: ff864c7bfe38397b8c160bc624f97574
Bodyapplication/jsonrequired
namestring(DataMonitorName)

Data Monitor name.

Example: "Trust Score Data Monitor Name"
enabledboolean(DataMonitorToggle)

The toggle used to enable or disable the Data Monitor.

Example: true
curl -i -X PUT \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/72d6900fce6b326088f5d9d91049e3e6/datamonitors/ff864c7bfe38397b8c160bc624f97574 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Trust Score Data Monitor Name",
    "enabled": true
  }'

Responses

OK

Bodyapplication/json
updatedinteger(int32)

Number of updated Data Monitors.

Example: "1"
failedinteger(int32)

Number of failed updates.

Example: "1"
Response
application/json
{
  "updated": "1",
  "failed": "1"
}

Read Data Monitor

Request

Get a Data Monitor for specific Bank Account Storage based on provided ID.

Security
apiKey
Path
storageIdstring(BankAccountStorageId)required

Unique identifier of the Bank Account Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
dataMonitorIdstring(DataMonitorId)required

Unique ID of a Bank Account Storage Data Monitor.

Example: ff864c7bfe38397b8c160bc624f97574
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/72d6900fce6b326088f5d9d91049e3e6/datamonitors/ff864c7bfe38397b8c160bc624f97574 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(DataMonitorId)

Unique identifier of Data Monitor.

Example: "ff864c7bfe38397b8c160bc624f97574"
namestring(DataMonitorName)

Data Monitor name.

Example: "Trust Score Data Monitor Name"
typestring(DataMonitorType)

Unique identifier of a Bank Account Storage Data Monitor type.

ValueDescription
TRUST_SCORE

To calculate Trust Score for Bank Accounts.

Example: "TRUST_SCORE"
enabledboolean(DataMonitorToggle)

The toggle used to enable or disable the Data Monitor.

Example: true
createdAtstring(DataMonitorCreatedAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
modifiedAtstring(DataMonitorModifiedAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
disabledAtstring(DataMonitorDisabledAt)

Date in ISO-8601 format when data monitor was disabled.

Example: "2025-08-29T09:46:42Z"
Response
application/json
{
  "id": "ff864c7bfe38397b8c160bc624f97574",
  "name": "Trust Score Data Monitor Name",
  "type": "TRUST_SCORE",
  "enabled": true,
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z",
  "disabledAt": "2025-08-29T09:46:42Z"
}

Delete Data Monitor

Request

Delete a data monitor for specific Bank Account Storage.

Security
apiKey
Path
storageIdstring(BankAccountStorageId)required

Unique identifier of the Bank Account Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
dataMonitorIdstring(DataMonitorId)required

Unique ID of a Bank Account Storage Data Monitor.

Example: ff864c7bfe38397b8c160bc624f97574
curl -i -X DELETE \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/72d6900fce6b326088f5d9d91049e3e6/datamonitors/ff864c7bfe38397b8c160bc624f97574 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
deletedinteger(int32)

Number of deleted Data Monitors.

Example: "1"
failedinteger(int32)

Number of failed deletions.

Example: "1"
Response
application/json
{
  "deleted": "1",
  "failed": "1"
}