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
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

Create Data Transformation Definition

Request

The data transformation definition is used to transform raw data into a structured format.

Security
apiKey
Bodyapplication/json
namestring

Name of the Data Transformation Definition.

Example: "Test definition 1"
mappingsArray of objects(AttributeMappingRule)

Mappings defining transformation

valueMappingsArray of objects(ValueMapping)

Mappings defining transformation

valuesArray of objects(Value)

Mappings defining transformation

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/datatransformationdefinitions \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
namestring

Name of the Data Transformation Definition.

Example: "Test definition 1"
mappingsArray of objects(AttributeMappingRule)

Mappings defining transformation

valueMappingsArray of objects(ValueMapping)

Mappings defining transformation

valuesArray of objects(Value)

Mappings defining transformation

idstring

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
Response
application/json
{ "id": "SAP.ODM", "createdBy": "76248934691294444", "createdAt": "2025-08-29T09:46:42Z", "modifiedBy": "76248934691294444", "modifiedAt": "2025-08-29T09:46:42Z", "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4" }

Read Data Transformation Definition

Request

Read the definition by ID to get the details of the data transformation.

Security
apiKey
Path
idstringrequired

ID of the data mapper definition.

Example: 5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/datatransformationdefinitions/5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
namestring

Name of the Data Transformation Definition.

Example: "Test definition 1"
mappingsArray of objects(AttributeMappingRule)

Mappings defining transformation

valueMappingsArray of objects(ValueMapping)

Mappings defining transformation

valuesArray of objects(Value)

Mappings defining transformation

idstring

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
Response
application/json
{ "id": "SAP.ODM", "createdBy": "76248934691294444", "createdAt": "2025-08-29T09:46:42Z", "modifiedBy": "76248934691294444", "modifiedAt": "2025-08-29T09:46:42Z", "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4" }

Update Data Transformation Definition

Request

Update Data Transformation Definition by ID.

Security
apiKey
Path
idstringrequired

ID of the data mapper definition.

Example: 5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b
Bodyapplication/json
namestring

Name of the Data Transformation Definition.

Example: "Test definition 1"
mappingsArray of objects(AttributeMappingRule)

Mappings defining transformation

valueMappingsArray of objects(ValueMapping)

Mappings defining transformation

valuesArray of objects(Value)

Mappings defining transformation

curl -i -X PUT \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/datatransformationdefinitions/5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
namestring

Name of the Data Transformation Definition.

Example: "Test definition 1"
mappingsArray of objects(AttributeMappingRule)

Mappings defining transformation

valueMappingsArray of objects(ValueMapping)

Mappings defining transformation

valuesArray of objects(Value)

Mappings defining transformation

idstring

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-29T09:46:42Z"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
Response
application/json
{ "id": "SAP.ODM", "createdBy": "76248934691294444", "createdAt": "2025-08-29T09:46:42Z", "modifiedBy": "76248934691294444", "modifiedAt": "2025-08-29T09:46:42Z", "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4" }

Delete Data Transformation Definition

Request

Delete Data Transformation Definition by ID.

Security
apiKey
Path
idstringrequired

ID of the data mapper definition.

Example: 5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b
curl -i -X DELETE \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/datatransformationdefinitions/5f4b3b3b-4b3b-4b3b-4b3b-4b3b4b3b4b3b \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

ID of the deleted object.

Default "ID of the deleted object."
Example: "6461e6113b1865304b3038b6"
Response
application/json
{ "id": "6461e6113b1865304b3038b6" }

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
Operations

Bank Account Storage Data Monitors

Operations