Bankaccount Data API (2)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

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:

1. Only the IBAN (= internationalBankAccountIdentifier):
   {
     "bankAccount": {
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     }
   }

2. The bank account number (= nationalBankAccountIdentifier) and the BIC (= internationalBankIdentifier):
   {
     "bankAccount": {
       "nationalBankAccountIdentifier": "619278412000",
       "internationalBankIdentifier": "KBSGCH22XXX"
     }
   }

3. The bank account number (= nationalBankAccountIdentifier), bank code/number (= nationalBankIdentifier) and bank country code (= bankCountryCode):
   {
     "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:

1. A whitelist entry and no fraud case was found:
   {
     "bankAccountRequest": {
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     },
     "bankAccountConfirmed": {
       "bankCountryCode": "CH",
       "nationalBankIdentifier": "00781",
       "nationalBankAccountIdentifier": "619278412000",
       "internationalBankIdentifier": "KBSGCH22XXX",
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     }
     "numberOfCompanies": "5",
     "numberOfPayments": "42",
     "lastPaymentAt": "2019-01-24",
     "trustScore": "7"
   }

2. A fraud case entry was found:
   {
     "bankAccountRequest": {
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     },
     "associatedFraudCases": [
       {
         "cdlId": "123456",
         ...
       }
     ]
   }

3. The bank account is unknown (no trust score and no fraud case exists):
   {
     "bankAccountRequest": {
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     }
   }

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:

1. Only the IBAN (= internationalBankAccountIdentifier):
   {
     "bankAccount": {
       "internationalBankAccountIdentifier": "CH8800781619278412000"
     }
   }

2. The bank account number (= nationalBankAccountIdentifier), bank code/number (= bank.nationalBankIdentifier) and bank country code (= bank.address.country.shortName):
   {
     "bankAccount": {
       "nationalBankAccountIdentifier": "619278412000",
       "bank" : {
         "nationalBankIdentifier": "00781",
         "address": {
           "country": {
             "shortName": "CH"
           }
         }
       }
     }
   }

3. The bank account number (= nationalBankAccountIdentifier), bank code/number (= bank.nationalBankIdentifier) and the BIC (= internationalBankIdentifier):
   {
     "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:

• countryCode
• internationalBankIdentifier
• nationalBankAccountIdentifier

Or

• internationalBankIdentifier
• nationalBankIdentifier
• nationalBankAccountIdentifier

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.

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

-> Calculates statistics from a bank account database and provides information about whitelist records, whitelist bank accounts, country distribution, etc.

-> Confirm reliability of given bank account data by CDL Trust Scores provided by other companies for the given bank account.