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

Import Bank Accounts

Request

-> Start a job to import bank account records from a previously uploaded CSV file, identified by the storage ID in the request object.

Security
apiKey
Path
storageIdstring^[a-fA-F0-9]{24}$required

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Bodyapplication/jsonrequired

Identifies a previously uploaded CSV file with bank accounts to import. If the data transformation definition ID is provided, it will override the one defined in the storage and use it in the job.

urlstringrequired

-> Url received in response from request to /files/upload endpoint. It is a file name of file uploaded to the storage with bank account data.

Example: "bankaccountdata.csv"
featuresOnArray of strings(BankAccountImportJobFeatureParam)

Feature(s) to be used during the import job:

  • CLEAR_STORAGE - Removes all existing data in the storage before the file is imported.
Items Enum ValueDescription
CLEAR_STORAGE

Removes all existing data in the storage before the file is imported.

MERGE_PAYMENTS

Consolidate transactions into bank accounts.

Example: ["CLEAR_STORAGE"]
dataTransformationDefinitionIdstring(DataTransformationId)

The ID of an existing data transformation, which will be used to transform raw records into bank accounts.

Example: "72d6900fce6b326088f5d9d91049e3e6"
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/652697d8eb91545eb14e64e6/import \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "url": "bankaccountdata.csv",
    "featuresOn": [
      "CLEAR_STORAGE"
    ],
    "dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6"
  }'

Responses

Bank account import job started

Bodyapplication/json
idstring(BankAccountStorageId)

Unique identifier of the Bank Account Storage. Workspace could have only one Bank Account Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Date of modification (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
parametersobject(BankAccountImportJobRequest)

Request to import bank account data from a file.

Response
application/json
{
  "id": "72d6900fce6b326088f5d9d91049e3e6",
  "createdBy": "76248934691294444",
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "parameters": {
    "url": "bankaccountdata.csv",
    "featuresOn": [ … ],
    "dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6"
  }
}

Import Job Progress

Request

Get bank account import job progress. It contains information about request that started the job.

Security
apiKey
Path
idstring(JobId)required

Job ID.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
storageIdstring^[a-fA-F0-9]{24}$required

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountstorages/652697d8eb91545eb14e64e6/import/35f23c03-1c22-45fe-9484-3ffe769325de \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bank account import job results

Bodyapplication/json
idstring(BankAccountStorageId)

Unique identifier of the Bank Account Storage. Workspace could have only one Bank Account Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Date of modification (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
parametersobject(BankAccountImportJobRequest)

Request to import bank account data from a file.

Response
application/json
{
  "id": "72d6900fce6b326088f5d9d91049e3e6",
  "createdBy": "76248934691294444",
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "parameters": {
    "url": "bankaccountdata.csv",
    "featuresOn": [ … ],
    "dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6"
  }
}

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