This API provides services to validate and to confirm bank account data, and to manage payment fraud cases
Bankaccount Data API (2)
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/
https://api.cdq.com/bankaccount-data/rest/
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.
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.
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.
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.
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "page": "0", "pageSize": "20", "numberOfPages": "10", "recordCount": "2000", "sortField": "dateOfAttack", "ascending": "true", "fraudCases": [ { … } ] }
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X POST \
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"fraudCase": {
"dateOfAttack": "<DATE_OF_ATTACK>",
"type": "FAKE_DOCUMENT",
"description": "description",
"internalComment": "comment",
"confirmationState": "CONFIRMED",
"businessPartnerName": "",
"businessPartnerCountryCode": "",
"businessPartnerLocality": "",
"fraudsterEmail": "<EMAIL_ADDRESS>",
"fraudsterPhone": "",
"bankAccount": {
"internationalBankAccountIdentifier": "",
"internationalBankIdentifier": "",
"bankCountryCode": "",
"nationalBankIdentifier": "",
"nationalBankAccountIdentifier": ""
}
}
}'
Created
- application/json
- application/xml
Fraud case type. Available options:
ACTIVE_WARNING
: Active warning.ANNOUNCEMENT
: Announcement.FAKE_DOCUMENT
: Fake document.FAKE_EMAIL
: Fake email.FAKE_PRESIDENT_CALL
: Fake president call.FALSIFIED_INVOICE
: Falsified invoice.
Confirmation state. Available options:
CONFIRMED
: Confirmed.SUSPECTED
: Suspected.
Classification of the fraud case.
Enum Value | Description |
---|---|
DEMO | Create fraud case in Demo mode |
TEST | Create fraud case in Test mode |
CATENAX | Create fraud case for Catena-X community |
STANDARD | Create fraud case in standard mode |
A bank account record holds information that universally describes a registered bank account.
Creation timestamp of the fraud case.
Available disclosed attributes:
BANKACCOUNT_BANK_COUNTRY_CODE
: Bank account bank country code.BANKACCOUNT_BANK_NAME
: Bank account bank name.BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER
: Bank account international bank identifier.BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER
: Bank account international bank account identifier.BANKACCOUNT_NATIONAL_BANK_IDENTIFIER
: Bank account national bank identifier.BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER
: Bank account national bank account identifier.FRAUDCASE_CDL_ID
: Fraud case CDL ID.FRAUDCASE_ALTERNATIVE_PAYEE
: Fraud case alternative payee.FRAUDCASE_BUSINESS_PARTNER_NAME
: Fraud case business partner name.FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE
: Fraud case business partner country code.FRAUDCASE_BUSINESS_PARTNER_LOCALITY
: Fraud case business partner locality.FRAUDCASE_DATE_OF_ATTACK
: Fraud case date of attack.FRAUDCASE_CREATION_TIMESTAMP
: Fraud case creation timestamp.FRAUDCASE_DESCRIPTION
: Fraud case description.FRAUDCASE_INTERNAL_COMMENT
: Fraud case internal comment.FRAUDCASE_FRAUDSTER_EMAIL
: Fraud case fraudster email.FRAUDCASE_FRAUDSTER_PHONE
: Fraud case fraudster phone.FRAUDCASE_FRAUDSTER_WEBSITE
: Fraud case fraudster website.FRAUDCASE_TYPE
: Fraud case type.FRAUDCASE_CONFIRMATION_STATE
: Fraud case confirmation state.FRAUDCASE_CREATOR_ORGANIZATION
: Fraud case creator organization.FRAUDCASE_CREATOR_USER
: Fraud case creator user.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_NAME
: Fraud case disclosed attributes bank account bank name.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_COUNTRY_CODE
: Fraud case disclosed attributes bank account bank country code.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER
: Fraud case disclosed attributes bank account international bank identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER
: Fraud case disclosed attributes bank account international bank account identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_IDENTIFIER
: Fraud case disclosed attributes bank account national bank identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER
: Fraud case disclosed attributes bank account national bank account identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_ALTERNATIVE_PAYEE
: Fraud case disclosed attributes fraud case alternative payee.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_NAME
: Fraud case disclosed attributes fraud case business partner name.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE
: Fraud case disclosed attributes fraud case business partner country code.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_LOCALITY
: Fraud case disclosed attributes fraud case business partner locality.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DATE_OF_ATTACK
: Fraud case disclosed attributes fraud case date of attack.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATION_TIMESTAMP
: Fraud case disclosed attributes fraud case creation timestamp.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DESCRIPTION
: Fraud case disclosed attributes fraud case description.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_EMAIL
: Fraud case disclosed attributes fraud case fraudster email.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_PHONE
: Fraud case disclosed attributes fraud case fraudster phone.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_WEBSITE
: Fraud case disclosed attributes fraud case fraudster website.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_TYPE
: Fraud case disclosed attributes fraud case type.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CONFIRMATION_STATE
: Fraud case disclosed attributes fraud case confirmation state.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_ORGANIZATION
: Fraud case disclosed attributes fraud case creator organization.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_USER
: Fraud case disclosed attributes fraud case creator user.
Items Enum Value | Description |
---|---|
BANKACCOUNT_BANK_COUNTRY_CODE | Bank account bank country code. |
BANKACCOUNT_BANK_NAME | Bank account bank name. |
BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER | Bank account international bank identifier. |
BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER | Bank account international bank account identifier. |
BANKACCOUNT_NATIONAL_BANK_IDENTIFIER | Bank account national bank identifier. |
BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER | Bank account national bank account identifier. |
FRAUDCASE_CDL_ID | Fraud case CDL ID. |
FRAUDCASE_ALTERNATIVE_PAYEE | Fraud case alternative payee. |
FRAUDCASE_BUSINESS_PARTNER_NAME | Fraud case business partner name. |
FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE | Fraud case business partner country code. |
{ "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a", "version": "1", "dateOfAttack": "2025-08-29T09:46:42Z", "type": "ACTIVE_WARNING", "description": "Fraud case description", "internalComment": "Internal comment", "confirmationState": "CONFIRMED", "classification": "STANDARD", "businessPartnerName": "Corporate Data Quality AG", "businessPartnerCountryCode": "CH", "businessPartnerLocality": "Sankt Gallen", "fraudsterEmail": "thisisnot@fraud.com", "fraudsterPhone": "+49123456789", "fraudsterWebsite": "www.thisisnotafraud.com", "alternativePayee": "Alternative payee's name", "bankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000", "internationalBankIdentifier": "KBSGCH22XXX", "bankCountryCode": "DE", "nationalBankIdentifier": "00781", "nationalBankAccountIdentifier": "619278412000" }, "archived": "false", "alertTriggered": "false", "createdAt": "2025-08-29T09:46:42Z", "creatorOrganization": "Organization name", "createdBy": "User name", "disclosedAttributes": [ "BANKACCOUNT_BANK_NAME" ], "relatedFraudCases": "5" }
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/{fraudCaseId}
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases/{fraudCaseId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X PUT \
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/oaRnfC1D1Q \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"fraudCase": {
"cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
"version": "1",
"dateOfAttack": "2025-08-29T09:46:42Z",
"type": "ACTIVE_WARNING",
"description": "Fraud case description",
"internalComment": "Internal comment",
"confirmationState": "CONFIRMED",
"classification": "STANDARD",
"businessPartnerName": "Corporate Data Quality AG",
"businessPartnerCountryCode": "CH",
"businessPartnerLocality": "Sankt Gallen",
"fraudsterEmail": "thisisnot@fraud.com",
"fraudsterPhone": "+49123456789",
"fraudsterWebsite": "www.thisisnotafraud.com",
"alternativePayee": "Alternative payee'\''s name",
"bankAccount": {
"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"bankCountryCode": "DE",
"nationalBankIdentifier": "00781",
"nationalBankAccountIdentifier": "619278412000"
},
"archived": "false",
"alertTriggered": "false",
"createdAt": "2025-08-29T09:46:42Z",
"creatorOrganization": "Organization name",
"createdBy": "User name",
"disclosedAttributes": [
"BANKACCOUNT_BANK_NAME"
],
"relatedFraudCases": "5"
}
}'
Updated
- application/json
- application/xml
Fraud case type. Available options:
ACTIVE_WARNING
: Active warning.ANNOUNCEMENT
: Announcement.FAKE_DOCUMENT
: Fake document.FAKE_EMAIL
: Fake email.FAKE_PRESIDENT_CALL
: Fake president call.FALSIFIED_INVOICE
: Falsified invoice.
Confirmation state. Available options:
CONFIRMED
: Confirmed.SUSPECTED
: Suspected.
Classification of the fraud case.
Enum Value | Description |
---|---|
DEMO | Create fraud case in Demo mode |
TEST | Create fraud case in Test mode |
CATENAX | Create fraud case for Catena-X community |
STANDARD | Create fraud case in standard mode |
A bank account record holds information that universally describes a registered bank account.
Creation timestamp of the fraud case.
Available disclosed attributes:
BANKACCOUNT_BANK_COUNTRY_CODE
: Bank account bank country code.BANKACCOUNT_BANK_NAME
: Bank account bank name.BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER
: Bank account international bank identifier.BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER
: Bank account international bank account identifier.BANKACCOUNT_NATIONAL_BANK_IDENTIFIER
: Bank account national bank identifier.BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER
: Bank account national bank account identifier.FRAUDCASE_CDL_ID
: Fraud case CDL ID.FRAUDCASE_ALTERNATIVE_PAYEE
: Fraud case alternative payee.FRAUDCASE_BUSINESS_PARTNER_NAME
: Fraud case business partner name.FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE
: Fraud case business partner country code.FRAUDCASE_BUSINESS_PARTNER_LOCALITY
: Fraud case business partner locality.FRAUDCASE_DATE_OF_ATTACK
: Fraud case date of attack.FRAUDCASE_CREATION_TIMESTAMP
: Fraud case creation timestamp.FRAUDCASE_DESCRIPTION
: Fraud case description.FRAUDCASE_INTERNAL_COMMENT
: Fraud case internal comment.FRAUDCASE_FRAUDSTER_EMAIL
: Fraud case fraudster email.FRAUDCASE_FRAUDSTER_PHONE
: Fraud case fraudster phone.FRAUDCASE_FRAUDSTER_WEBSITE
: Fraud case fraudster website.FRAUDCASE_TYPE
: Fraud case type.FRAUDCASE_CONFIRMATION_STATE
: Fraud case confirmation state.FRAUDCASE_CREATOR_ORGANIZATION
: Fraud case creator organization.FRAUDCASE_CREATOR_USER
: Fraud case creator user.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_NAME
: Fraud case disclosed attributes bank account bank name.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_COUNTRY_CODE
: Fraud case disclosed attributes bank account bank country code.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER
: Fraud case disclosed attributes bank account international bank identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER
: Fraud case disclosed attributes bank account international bank account identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_IDENTIFIER
: Fraud case disclosed attributes bank account national bank identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER
: Fraud case disclosed attributes bank account national bank account identifier.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_ALTERNATIVE_PAYEE
: Fraud case disclosed attributes fraud case alternative payee.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_NAME
: Fraud case disclosed attributes fraud case business partner name.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE
: Fraud case disclosed attributes fraud case business partner country code.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_LOCALITY
: Fraud case disclosed attributes fraud case business partner locality.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DATE_OF_ATTACK
: Fraud case disclosed attributes fraud case date of attack.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATION_TIMESTAMP
: Fraud case disclosed attributes fraud case creation timestamp.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DESCRIPTION
: Fraud case disclosed attributes fraud case description.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_EMAIL
: Fraud case disclosed attributes fraud case fraudster email.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_PHONE
: Fraud case disclosed attributes fraud case fraudster phone.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_WEBSITE
: Fraud case disclosed attributes fraud case fraudster website.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_TYPE
: Fraud case disclosed attributes fraud case type.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CONFIRMATION_STATE
: Fraud case disclosed attributes fraud case confirmation state.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_ORGANIZATION
: Fraud case disclosed attributes fraud case creator organization.FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_USER
: Fraud case disclosed attributes fraud case creator user.
Items Enum Value | Description |
---|---|
BANKACCOUNT_BANK_COUNTRY_CODE | Bank account bank country code. |
BANKACCOUNT_BANK_NAME | Bank account bank name. |
BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER | Bank account international bank identifier. |
BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER | Bank account international bank account identifier. |
BANKACCOUNT_NATIONAL_BANK_IDENTIFIER | Bank account national bank identifier. |
BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER | Bank account national bank account identifier. |
FRAUDCASE_CDL_ID | Fraud case CDL ID. |
FRAUDCASE_ALTERNATIVE_PAYEE | Fraud case alternative payee. |
FRAUDCASE_BUSINESS_PARTNER_NAME | Fraud case business partner name. |
FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE | Fraud case business partner country code. |
{ "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a", "version": "1", "dateOfAttack": "2025-08-29T09:46:42Z", "type": "ACTIVE_WARNING", "description": "Fraud case description", "internalComment": "Internal comment", "confirmationState": "CONFIRMED", "classification": "STANDARD", "businessPartnerName": "Corporate Data Quality AG", "businessPartnerCountryCode": "CH", "businessPartnerLocality": "Sankt Gallen", "fraudsterEmail": "thisisnot@fraud.com", "fraudsterPhone": "+49123456789", "fraudsterWebsite": "www.thisisnotafraud.com", "alternativePayee": "Alternative payee's name", "bankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000", "internationalBankIdentifier": "KBSGCH22XXX", "bankCountryCode": "DE", "nationalBankIdentifier": "00781", "nationalBankAccountIdentifier": "619278412000" }, "archived": "false", "alertTriggered": "false", "createdAt": "2025-08-29T09:46:42Z", "creatorOrganization": "Organization name", "createdBy": "User name", "disclosedAttributes": [ "BANKACCOUNT_BANK_NAME" ], "relatedFraudCases": "5" }
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/{fraudCaseId}
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases/{fraudCaseId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X DELETE \
'https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/ID?' \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/{fraudCaseId}/triggeralert
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases/{fraudCaseId}/triggeralert
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X POST \
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/oaRnfC1D1Q/triggeralert \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
- Mock server
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/statistics
- Production
https://api.cdq.com/bankaccount-data/rest/fraudcases/statistics
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/fraudcases/statistics \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "date": "20240302", "cachedValue": "false", "numberOfAllFraudCases": "10", "numberOfDisclosedFraudCases": "10", "numberOfUndisclosedFraudCases": "10", "numberOfFraudCasesOfTheUsersOrganization": "10", "numberOfDisclosedFraudCasesOfTheUsersOrganization": "10", "numberOfUndisclosedFraudCasesOfTheUsersOrganization": "10" }
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.