# Confirm Reliability

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):
      
  2. The bank account number (= nationalBankAccountIdentifier) and the BIC (= internationalBankIdentifier):
      
  3. The bank account number (= nationalBankAccountIdentifier), bank code/number (= nationalBankIdentifier) and bank country code (= bankCountryCode):
      
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:
      
2. A fraud case entry was found:
      
3. The bank account is unknown (no trust score and no fraud case exists):
      


Endpoint: POST /v2/bankaccounts/confirm
Version: 2
Security: apiKey

## Request fields (application/json):

  - `bankAccount` (object, required)
    A bank account record holds information that universally describes a registered bank account.

  - `bankAccount.internationalBankAccountIdentifier` (string)
    The IBAN of a bank account.
    Example: "CH8800781619278412000"

  - `bankAccount.internationalBankIdentifier` (string)
    (BIC/SWIFT) Bank identifier which is globally unique.
    Example: "KBSGCH22XXX"

  - `bankAccount.bankCountryCode` (string)
    ISO code to identify the country a bank account is registered in.
    Example: "DE"

  - `bankAccount.nationalBankIdentifier` (string)
    Bank identifier which is unique in a national context, i.e. for a country.
    Example: "00781"

  - `bankAccount.nationalBankAccountIdentifier` (string)
    Identifier of a bank account in a national context, i.e. for a country.
    Example: "619278412000"

## Response 200 fields (application/json):

  - `bankAccountRequest` (object)
    A bank account record holds information that universally describes a registered bank account.

  - `bankAccountRequest.internationalBankAccountIdentifier` (string)
    The IBAN of a bank account.
    Example: "CH8800781619278412000"

  - `bankAccountRequest.internationalBankIdentifier` (string)
    (BIC/SWIFT) Bank identifier which is globally unique.
    Example: "KBSGCH22XXX"

  - `bankAccountRequest.bankCountryCode` (string)
    ISO code to identify the country a bank account is registered in.
    Example: "DE"

  - `bankAccountRequest.nationalBankIdentifier` (string)
    Bank identifier which is unique in a national context, i.e. for a country.
    Example: "00781"

  - `bankAccountRequest.nationalBankAccountIdentifier` (string)
    Identifier of a bank account in a national context, i.e. for a country.
    Example: "619278412000"

  - `bankAccountConfirmed` (object)
    A bank account record holds information that universally describes a registered bank account.

  - `numberOfCompanies` (integer)
    Number of companies that use this bank account.
    Example: "5"

  - `numberOfPayments` (integer)
    Sum of payments performed by companies that use this bank account.
    Example: "42"

  - `lastPaymentAt` (string)
    Date of last payment made by any of the companies that use this bank account.
    Example: "2025-08-29T09:46:42Z"

  - `trustScore` (integer)
    Trust score based on the number of payments done with this bank account.
    Example: "7"

  - `bankAccountOwners` (array)
    Five frequentest bank account owner names.

  - `bankAccountOwners.name` (object)
    Name of the bank account owner.

  - `bankAccountOwners.name.value` (string)
    Unique ID of a user.
    Example: "johndoe"

  - `bankAccountOwners.lastPaymentAt` (object)
    Last payment date of the bank account owner.

  - `bankAccountOwners.lastPaymentAt.value` (string)
    Last payment date of the bank account owner.
    Example: "2025-08-29T09:46:42Z"

  - `associatedFraudCases` (array)
    List of fraud cases associated with the bank account.

  - `associatedFraudCases.cdlId` (string)
    Unique identifier of the fraud case.
    Example: "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"

  - `associatedFraudCases.version` (integer)
    Version of the fraud case.
    Example: "1"

  - `associatedFraudCases.dateOfAttack` (string)
    Date of the attack.
    Example: "2025-08-29T09:46:42Z"

  - `associatedFraudCases.type` (string)
    Fraud case type. Available options:
  * : Active warning.
  * : Announcement. 
  * : Fake document.
  * : Fake email.
  * : Fake president call.
  * : Falsified invoice.
    Example: "ACTIVE_WARNING"

  - `associatedFraudCases.description` (string)
    Description of the fraud case.
    Example: "Fraud case description"

  - `associatedFraudCases.internalComment` (string)
    Internal comment of the fraud case.
    Example: "Internal comment"

  - `associatedFraudCases.confirmationState` (string)
    Confirmation state. Available options:
  * : Confirmed.
  * : Suspected.
    Example: "CONFIRMED"

  - `associatedFraudCases.classification` (string)
    Classification of the fraud case.
    Enum: "DEMO", "TEST", "CATENAX", "STANDARD"

  - `associatedFraudCases.businessPartnerName` (string)
    The actual name.
    Example: "Corporate Data Quality AG"

  - `associatedFraudCases.businessPartnerCountryCode` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `associatedFraudCases.businessPartnerLocality` (string)
    Name of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "Sankt Gallen"

  - `associatedFraudCases.fraudsterEmail` (string)
    Email of the fraudster.
    Example: "thisisnot@fraud.com"

  - `associatedFraudCases.fraudsterPhone` (string)
    Phone of the fraudster.
    Example: "+49123456789"

  - `associatedFraudCases.fraudsterWebsite` (string)
    Website of the fraudster.
    Example: "www.thisisnotafraud.com"

  - `associatedFraudCases.alternativePayee` (string)
    Alternative payee of the fraud case.
    Example: "Alternative payee's name"

  - `associatedFraudCases.bankAccount` (object)
    A bank account record holds information that universally describes a registered bank account.

  - `associatedFraudCases.archived` (boolean)
    Indicates if the fraud case is archived.
    Example: "false"

  - `associatedFraudCases.alertTriggered` (boolean)
    Indicates if an alert was triggered.
    Example: "false"

  - `associatedFraudCases.createdAt` (string)
    Creation timestamp of the fraud case.
    Example: "2025-08-29T09:46:42Z"

  - `associatedFraudCases.creatorOrganization` (string)
    Creator organization of the fraud case.
    Example: "Organization name"

  - `associatedFraudCases.createdBy` (string)
    Creator user of the fraud case.
    Example: "User name"

  - `associatedFraudCases.disclosedAttributes` (array)
    Available disclosed attributes:
  * : Bank account bank country code.
  * : Bank account bank name.
  * : Bank account international bank identifier.
  * : Bank account international bank account identifier.
  * : Bank account national bank identifier.
  * : Bank account national bank account identifier.
  * : Fraud case CDL ID.
  * : Fraud case alternative payee.
  * : Fraud case business partner name.
  * : Fraud case business partner country code.
  * : Fraud case business partner locality.
  * : Fraud case date of attack.
  * : Fraud case creation timestamp.
  * : Fraud case description.
  * : Fraud case internal comment.
  * : Fraud case fraudster email.
  * : Fraud case fraudster phone.
  * : Fraud case fraudster website.
  * : Fraud case type.
  * : Fraud case confirmation state.
  * : Fraud case creator organization.
  * : Fraud case creator user.
  * : Fraud case disclosed attributes bank account bank name.
  * : Fraud case disclosed attributes bank account bank country code.
  * : Fraud case disclosed attributes bank account international bank identifier.
  * : Fraud case disclosed attributes bank account international bank account identifier.
  * : Fraud case disclosed attributes bank account national bank identifier.
  * : Fraud case disclosed attributes bank account national bank account identifier.
  * : Fraud case disclosed attributes fraud case alternative payee.
  * : Fraud case disclosed attributes fraud case business partner name.
  * : Fraud case disclosed attributes fraud case business partner country code.
  * : Fraud case disclosed attributes fraud case business partner locality.
  * : Fraud case disclosed attributes fraud case date of attack.
  * : Fraud case disclosed attributes fraud case creation timestamp.
  * : Fraud case disclosed attributes fraud case description.
  * : Fraud case disclosed attributes fraud case fraudster email.
  * : Fraud case disclosed attributes fraud case fraudster phone.
  * : Fraud case disclosed attributes fraud case fraudster website.
  * : Fraud case disclosed attributes fraud case type.
  * : Fraud case disclosed attributes fraud case confirmation state.
  * : Fraud case disclosed attributes fraud case creator organization.
  * : Fraud case disclosed attributes fraud case creator user.
    Enum: "BANKACCOUNT_BANK_COUNTRY_CODE", "BANKACCOUNT_BANK_NAME", "BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER", "BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER", "BANKACCOUNT_NATIONAL_BANK_IDENTIFIER", "BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER", "FRAUDCASE_CDL_ID", "FRAUDCASE_ALTERNATIVE_PAYEE", "FRAUDCASE_BUSINESS_PARTNER_NAME", "FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE", "FRAUDCASE_BUSINESS_PARTNER_LOCALITY", "FRAUDCASE_DATE_OF_ATTACK", "FRAUDCASE_CREATION_TIMESTAMP", "FRAUDCASE_DESCRIPTION", "FRAUDCASE_INTERNAL_COMMENT", "FRAUDCASE_FRAUDSTER_EMAIL", "FRAUDCASE_FRAUDSTER_PHONE", "FRAUDCASE_FRAUDSTER_WEBSITE", "FRAUDCASE_TYPE", "FRAUDCASE_CONFIRMATION_STATE", "FRAUDCASE_CREATOR_ORGANIZATION", "FRAUDCASE_CREATOR_USER", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_NAME", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_BANK_COUNTRY_CODE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_IDENTIFIER", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_INTERNATIONAL_BANK_ACCOUNT_IDENTIFIER", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_IDENTIFIER", "FRAUDCASE_DISCLOSED_ATTRIBUTES_BANKACCOUNT_NATIONAL_BANK_ACCOUNT_IDENTIFIER", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_ALTERNATIVE_PAYEE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_NAME", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_COUNTRY_CODE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_BUSINESS_PARTNER_LOCALITY", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DATE_OF_ATTACK", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATION_TIMESTAMP", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_DESCRIPTION", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_EMAIL", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_PHONE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_FRAUDSTER_WEBSITE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_TYPE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CONFIRMATION_STATE", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_ORGANIZATION", "FRAUDCASE_DISCLOSED_ATTRIBUTES_FRAUDCASE_CREATOR_USER"

  - `associatedFraudCases.relatedFraudCases` (integer)
    Number of related fraud cases.
    Example: "5"

## Response 400 fields (application/json):

  - `id` (string)
    Unique identifier of the error.
    Example: "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-29T09:46:42Z"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"

## Response 401 fields (application/json):

  - `id` (string)
    Unique identifier of the error.
    Example: "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-29T09:46:42Z"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"