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

Create Data SourceDeprecated

Request

Create a new data source for the bank data.

Security
apiKey
Bodyapplication/json
namestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
typestring(AccessType)

Type of access to the data source.

Enum ValueDescription
PRIVATE

Private access.

ORGANIZATION

Organization access.

Example: "PRIVATE"
dataTransformationIdstring(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/banks/datasources \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Internal customers",
    "type": "PRIVATE",
    "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6"
  }'

Responses

OK

Bodyapplication/json
namestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
typestring(AccessType)

Type of access to the data source.

Enum ValueDescription
PRIVATE

Private access.

ORGANIZATION

Organization access.

Example: "PRIVATE"
dataTransformationIdstring(DataTransformationId)

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

Example: "72d6900fce6b326088f5d9d91049e3e6"
idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
creationUserstring(UserId)

Unique ID of a user.

Example: "johndoe"
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"
Response
application/json
{
  "name": "Internal customers",
  "type": "PRIVATE",
  "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  "id": "648824a691d8d2503d65103e",
  "creationUser": "johndoe",
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z"
}

List Data SourcesDeprecated

Request

List all data sources for the bank data.

Security
apiKey
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/banks/datasources \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
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(int32)

Number of items per page.

Example: "100"
valuesArray of objects(DataSource)

List of data sources.

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

Read Data SourceDeprecated

Request

Read a Data Source by ID.

Security
apiKey
Path
idstring(BusinessPartnerStorageDataSourceId)required

Data Source ID.

Example: 648824a691d8d2503d65103e
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/banks/datasources/648824a691d8d2503d65103e \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
namestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
typestring(AccessType)

Type of access to the data source.

Enum ValueDescription
PRIVATE

Private access.

ORGANIZATION

Organization access.

Example: "PRIVATE"
dataTransformationIdstring(DataTransformationId)

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

Example: "72d6900fce6b326088f5d9d91049e3e6"
idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
creationUserstring(UserId)

Unique ID of a user.

Example: "johndoe"
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"
Response
application/json
{
  "name": "Internal customers",
  "type": "PRIVATE",
  "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  "id": "648824a691d8d2503d65103e",
  "creationUser": "johndoe",
  "createdAt": "2025-08-29T09:46:42Z",
  "modifiedAt": "2025-08-29T09:46:42Z"
}

Delete Data SourceDeprecated

Request

Delete a Data Source by id.

Security
apiKey
Path
idstring(BusinessPartnerStorageDataSourceId)required

Data Source ID.

Example: 648824a691d8d2503d65103e
curl -i -X DELETE \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/banks/datasources/648824a691d8d2503d65103e \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(BankIdentifierValue)

The actual value of the bank identifier.

Example: "CH1234567890123456789"
Response
application/json
{
  "id": "CH1234567890123456789"
}

Bank Account Storage Data Monitors

Operations