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.
-> Confirm reliability of given bank account data by CDL Trust Scores provided by other companies for the given bank account.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Service Unavailable
{- "bankAccountRequest": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "bankCountryCode": "DE",
- "nationalBankIdentifier": "00781",
- "nationalBankAccountIdentifier": "619278412000"
}, - "bankAccountConfirmed": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "bankCountryCode": "DE",
- "nationalBankIdentifier": "00781",
- "nationalBankAccountIdentifier": "619278412000"
}, - "scoreSum": "100",
- "maxScores": [
- {
- "score": "100",
- "lastUpdate": "20240302",
- "lastUpdateAsDate": "2024-12-21T01:35:17Z"
}
], - "associatedFraudCases": [
- {
- "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
- "version": "1",
- "dateOfAttack": "2024-12-21T01:35:17Z",
- "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": "2024-12-21T01:35:17Z",
- "creatorOrganization": "Organization name",
- "createdBy": "User name",
- "disclosedAttributes": [
- "BANKACCOUNT_BANK_NAME"
], - "relatedFraudCases": "5"
}
]
}
Confirm the reliability of the given bank account against the CDQ Whitelist (trust score based on transactions) and the Blacklist (fraud cases).
The BankAccount that is sent in the request needs to uniquely identify a bank account. Minimal sets of attributes that are considered valid to identify a bank account are:
{
"bankAccount": {
"internationalBankAccountIdentifier": "CH8800781619278412000"
}
}
{
"bankAccount": {
"nationalBankAccountIdentifier": "619278412000",
"internationalBankIdentifier": "KBSGCH22XXX"
}
}
{
"bankAccount": {
"bankCountryCode": "CH",
"nationalBankIdentifier": "00781",
"nationalBankAccountIdentifier": "619278412000"
}
}
If attributes are missing to uniquely identify a bank account an ApiError will be returned.
The response will always contain the BankAccount provided in the request and depending on the result found in the Whitelist or the Blacklist or neither, the following:
{
"bankAccountRequest": {
"internationalBankAccountIdentifier": "CH8800781619278412000"
},
"bankAccountConfirmed": {
"bankCountryCode": "CH",
"nationalBankIdentifier": "00781",
"nationalBankAccountIdentifier": "619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"internationalBankAccountIdentifier": "CH8800781619278412000"
}
"numberOfCompanies": "5",
"numberOfPayments": "42",
"lastPaymentAt": "2019-01-24",
"trustScore": "7"
}
{
"bankAccountRequest": {
"internationalBankAccountIdentifier": "CH8800781619278412000"
},
"associatedFraudCases": [
{
"cdlId": "123456",
...
}
]
}
{
"bankAccountRequest": {
"internationalBankAccountIdentifier": "CH8800781619278412000"
}
}
required | object (BankAccount) A bank account record holds information that universally describes a registered bank account. |
OK
Bad Request
Unauthorized
{- "bankAccount": {
- "internationalBankAccountIdentifier": "CH8800781619278412000"
}
}
{- "bankAccountRequest": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "bankCountryCode": "DE",
- "nationalBankIdentifier": "00781",
- "nationalBankAccountIdentifier": "619278412000"
}, - "bankAccountConfirmed": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "bankCountryCode": "DE",
- "nationalBankIdentifier": "00781",
- "nationalBankAccountIdentifier": "619278412000"
}, - "numberOfCompanies": "5",
- "numberOfPayments": "42",
- "lastPaymentAt": "2024-12-21T01:35:17Z",
- "trustScore": "7",
- "bankAccountOwners": [
- {
- "name": {
- "value": "johndoe"
}, - "lastPaymentAt": {
- "value": "2024-12-21T01:35:17Z"
}
}
], - "associatedFraudCases": [
- {
- "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
- "version": "1",
- "dateOfAttack": "2024-12-21T01:35:17Z",
- "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": "2024-12-21T01:35:17Z",
- "creatorOrganization": "Organization name",
- "createdBy": "User name",
- "disclosedAttributes": [
- "BANKACCOUNT_BANK_NAME"
], - "relatedFraudCases": "5"
}
]
}
Curates the given bank account.
The BankAccount that is sent in the request has to be uniquely identifiable. Minimal sets of attributes that identify a BankAccount are:
{
"bankAccount": {
"internationalBankAccountIdentifier": "CH8800781619278412000"
}
}
{
"bankAccount": {
"nationalBankAccountIdentifier": "619278412000",
"bank" : {
"nationalBankIdentifier": "00781",
"address": {
"country": {
"shortName": "CH"
}
}
}
}
}
{
"bankAccount": {
"nationalBankAccountIdentifier": "619278412000",
"bank" : {
"nationalBankIdentifier": "00781",
"internationalBankIdentifier": "KBSGCH22XXX"
}
}
}
If IBAN is not present in the request it will be generated only if there is sufficient data:
Or
For the following countries the generation of the internationalBankAccountIdentifier (IBAN) is NOT supported in the current version:
AL, BA, BE, BG, BI, BR, DJ, EE, EG, ES, FI, FO, FR, HU, IS, IT, LY, MC, ME, MK, MR, NO, PL, PT, RS, SC, SD, SI, SM, TL, TR
The response will always contain the original BankAccount provided in the request and a curated version of it. For example:
{ "originalBankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000" }, "curatedBankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000" "nationalBankAccountIdentifier": "619278412000", "bank" : { "nationalBankIdentifier": "00781", "address": { "country": { "shortName": "CH" } } } } }
If the given request does not provide one of the combinations of attributes described above, an ApiError will be returned:
{ "timestamp": "...", "message": "...", "error": "Bad Request", "path": "...", "status": 400 }
Message contains concatenated descriptions of all errors that occurred in the request.
OK
Bad Request
Unauthorized
{- "bankAccount": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "nationalBankAccountIdentifier": "619278412000",
- "bank": {
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankIdentifier": "00781",
- "nationalBankInstitutionCode": "LOYD",
- "nationalBankSortCode": "301883",
- "nationalBankControlKey": "12",
- "address": {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}
}
}
}, - "featuresOn": [
- "REMOVE_INVALID_VALUES"
], - "featuresOff": [
- "REMOVE_INVALID_VALUES"
]
}
{- "originalBankAccount": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "nationalBankAccountIdentifier": "619278412000",
- "bank": {
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankIdentifier": "00781",
- "nationalBankInstitutionCode": "LOYD",
- "nationalBankSortCode": "301883",
- "nationalBankControlKey": "12",
- "address": {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}
}
}
}, - "curatedBankAccount": {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "nationalBankAccountIdentifier": "619278412000",
- "bank": {
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankIdentifier": "00781",
- "nationalBankInstitutionCode": "LOYD",
- "nationalBankSortCode": "301883",
- "nationalBankControlKey": "12",
- "address": {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}
}
}
}
}
-> Calculates statistics from a bank account database and provides information about whitelist records, whitelist bank accounts, country distribution, etc.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Service Unavailable
{- "timeStampCreated": "20240302",
- "whitelistBankAccountCount": "10",
- "whitelistTrustScoreCount": "10",
- "whitelistCountryBankAccountCounts": [
- {
- "countryCode": "CH",
- "count": "2"
}
], - "whitelistCountryTrustScoreCounts": [
- {
- "countryCode": "CH",
- "count": "2"
}
], - "whitelistTrustScoreMean": "0.5",
- "whitelistTrustScore1Count": "10",
- "whitelistTrustScore2Count": "10",
- "whitelistTrustScore3Count": "10",
- "whitelistTrustScore4Count": "10",
- "whitelistBankAccountWith1TrustScoreCount": "10",
- "whitelistBankAccountWith2TrustScoresCount": "10",
- "whitelistBankAccountWith3TrustScoresCount": "10",
- "whitelistBankAccountWith4TrustScoresCount": "10",
- "whitelistBankAccountWith5TrustScoresCount": "10",
- "whitelistBankAccountWithMoreThan5TrustScoresCount": "10"
}
Get the status (including progress, if running) of a given job.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Service Unavailable
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "createdAt": "2024-12-21T01:35:17Z",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "status": "RUNNING"
}
-> Start a job to confirm all bank accounts provided by a previously uploaded CSV file, identified by the storage ID in the request object or from bank accounts of business partners in given business partner storage.
Identifies a previously uploaded CSV file with bank account data or business partner storage with bank accounts to confirm.
contentOrganization | string PLACEHOLDER Example: "cdq" | ||||
featuresOn | Array of strings (BankAccountDataConfirmationJobFeatureParam) Feature(s) to be used during the confirmation job:
Example: ["CONFIRM_BA_IN_BP_STORAGE"] | ||||
storageId | string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6" |
Created
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Service Unavailable
{- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "contentOrganization": "cdq",
- "featuresOn": [
- "CONFIRM_BA_IN_BP_STORAGE"
]
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "createdAt": "2024-12-21T01:35:17Z",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "status": "RUNNING"
}
Upload a CSV file with bank account data to be analyzed by several jobs.
ID of the created bank account storage.
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Service Unavailable
"72d6900fce6b326088f5d9d91049e3e6"