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

Overview
URL

https://www.cdq.ch/team

Sebastian Kaczmarski

sebastian.kaczmarski@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/

Production SOAP

https://api.corporate-data-league.ch/bankaccount-data/soap/v2/

Production

https://api.corporate-data-league.ch/bankaccount-data/

Whitelists

The Whitelists API provides endpoints to manage the whitelist entries.

Operations

Database Cleanup

Endpoints for cleaning up and resetting databases in test environments.

WARNING: These endpoints should ONLY be used in test/development environments. They permanently delete data and should never be exposed in production.

Use these endpoints to:

  • Clear test data between test runs
  • Reset database state for integration tests
  • Clean up test fixtures
Operations

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

List Fraud Cases

Request

Display a page of Fraud Cases.

Query
pageinteger

The page index. The index of the first page is 0.

Default 0
Example: page=0
pageSizeinteger

Number of records listed on one page.

Default 200
Example: pageSize=200
sortstring

Defines the attributes to sort by.

Default "creationTimestamp"
Example: sort=-dateOfAttack
searchstring

The phrase that the query will look for.

Example: search=phrase
classificationstring(FraudCaseClassification)

Classification used to filter results.

Default "STANDARD"
Example: classification=STANDARD
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

Page of Fraud Cases

Body
pageinteger

The page index. The index of the first page is 0.

Example: "0"
pageSizeinteger

Number of records listed on one page.

Example: "20"
numberOfPagesinteger

Total number of pages.

Example: "10"
recordCountinteger(int64)

Total number of records.

Example: "2000"
sortFieldstring

The field used for sorting.

Example: "dateOfAttack"
ascendingboolean

Sort order.

Example: "true"
fraudCasesArray of objects(FraudCase)

List of fraud cases.

Response
{
  "page": "0",
  "pageSize": "20",
  "numberOfPages": "10",
  "recordCount": "2000",
  "sortField": "dateOfAttack",
  "ascending": "true",
  "fraudCases": [
    { … }
  ]
}

Create Fraud Case

Request

Create a new Fraud Case with the given data.

Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Body
required
fraudCaseobject(FraudCase)

-> Represents a fraud case with properties such as the unique identifier of the case, its version, the date of the attack, and the type of the fraud case.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -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": ""
      }
    }
  }'

Responses

Created

Body
cdlIdstring

Unique identifier of the fraud case.

Example: "oaRnfC1D1Q"
versioninteger(int64)

Version of the fraud case.

Example: "1"
dateOfAttackstring(offset-date-time)

Date of the attack.

Example: "1662010915"
typestring(FraudCaseType)

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.
Example: "ACTIVE_WARNING"
descriptionstring

Description of the fraud case.

Example: "Fraud case description"
internalCommentstring

Internal comment of the fraud case.

Example: "Internal comment"
confirmationStatestring(ConfirmationState)

Confirmation state. Available options:

  • CONFIRMED: Confirmed.
  • SUSPECTED: Suspected.
Example: "CONFIRMED"
classificationstring(FraudCaseClassificationParamDesc)

Classification of the fraud case.

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

Example: "STANDARD"
businessPartnerNamestring(NameValue)

The actual name.

Example: "Corporate Data Quality AG"
businessPartnerCountryCodestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
businessPartnerLocalitystring(LocalityValue)

Name of the Locality.

Example: "Sankt Gallen"
fraudsterEmailstring

Email of the fraudster.

Example: "thisisnot@fraud.com"
fraudsterPhonestring

Phone of the fraudster.

Example: "+49123456789"
fraudsterWebsitestring

Website of the fraudster.

Example: "www.thisisnotafraud.com"
alternativePayeestring

Alternative payee of the fraud case.

Example: "Alternative payee's name"
bankAccountobject(BankAccount)

A bank account record holds information that universally describes a registered bank account.

archivedboolean

Indicates if the fraud case is archived.

Example: "false"
alertTriggeredboolean

Indicates if an alert was triggered.

Example: "false"
createdAtstring(offset-date-time)

Creation timestamp of the fraud case.

Example: "1662010915"
creatorOrganizationstring

Creator organization of the fraud case.

Example: "Organization name"
createdBystring

Creator user of the fraud case.

Example: "User name"
disclosedAttributesArray of strings(DisclosedAttributesParam)

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

Example: ["BANKACCOUNT_BANK_NAME"]
relatedFraudCasesinteger(int64)

Number of related fraud cases.

Example: "5"
Response
{
  "cdlId": "oaRnfC1D1Q",
  "version": "1",
  "dateOfAttack": "1662010915",
  "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": "1662010915",
  "creatorOrganization": "Organization name",
  "createdBy": "User name",
  "disclosedAttributes": [
    "BANKACCOUNT_BANK_NAME"
  ],
  "relatedFraudCases": "5"
}

Update Fraud Case

Request

Update a Fraud Case with the given data.

Path
fraudCaseIdstringrequired

ID of the Fraud Case that is being updated.

Example: oaRnfC1D1Q
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Body
required
fraudCaseobject(FraudCase)

-> Represents a fraud case with properties such as the unique identifier of the case, its version, the date of the attack, and the type of the fraud case.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases/oaRnfC1D1Q \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "fraudCase": {
      "cdlId": "oaRnfC1D1Q",
      "version": "1",
      "dateOfAttack": "1662010915",
      "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": "1662010915",
      "creatorOrganization": "Organization name",
      "createdBy": "User name",
      "disclosedAttributes": [
        "BANKACCOUNT_BANK_NAME"
      ],
      "relatedFraudCases": "5"
    }
  }'

Responses

Updated

Body
cdlIdstring

Unique identifier of the fraud case.

Example: "oaRnfC1D1Q"
versioninteger(int64)

Version of the fraud case.

Example: "1"
dateOfAttackstring(offset-date-time)

Date of the attack.

Example: "1662010915"
typestring(FraudCaseType)

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.
Example: "ACTIVE_WARNING"
descriptionstring

Description of the fraud case.

Example: "Fraud case description"
internalCommentstring

Internal comment of the fraud case.

Example: "Internal comment"
confirmationStatestring(ConfirmationState)

Confirmation state. Available options:

  • CONFIRMED: Confirmed.
  • SUSPECTED: Suspected.
Example: "CONFIRMED"
classificationstring(FraudCaseClassificationParamDesc)

Classification of the fraud case.

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

Example: "STANDARD"
businessPartnerNamestring(NameValue)

The actual name.

Example: "Corporate Data Quality AG"
businessPartnerCountryCodestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
businessPartnerLocalitystring(LocalityValue)

Name of the Locality.

Example: "Sankt Gallen"
fraudsterEmailstring

Email of the fraudster.

Example: "thisisnot@fraud.com"
fraudsterPhonestring

Phone of the fraudster.

Example: "+49123456789"
fraudsterWebsitestring

Website of the fraudster.

Example: "www.thisisnotafraud.com"
alternativePayeestring

Alternative payee of the fraud case.

Example: "Alternative payee's name"
bankAccountobject(BankAccount)

A bank account record holds information that universally describes a registered bank account.

archivedboolean

Indicates if the fraud case is archived.

Example: "false"
alertTriggeredboolean

Indicates if an alert was triggered.

Example: "false"
createdAtstring(offset-date-time)

Creation timestamp of the fraud case.

Example: "1662010915"
creatorOrganizationstring

Creator organization of the fraud case.

Example: "Organization name"
createdBystring

Creator user of the fraud case.

Example: "User name"
disclosedAttributesArray of strings(DisclosedAttributesParam)

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

Example: ["BANKACCOUNT_BANK_NAME"]
relatedFraudCasesinteger(int64)

Number of related fraud cases.

Example: "5"
Response
{
  "cdlId": "oaRnfC1D1Q",
  "version": "1",
  "dateOfAttack": "1662010915",
  "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": "1662010915",
  "creatorOrganization": "Organization name",
  "createdBy": "User name",
  "disclosedAttributes": [
    "BANKACCOUNT_BANK_NAME"
  ],
  "relatedFraudCases": "5"
}

Delete Fraud Case

Request

Delete a Fraud Case with the given ID.

Path
fraudCaseIdstringrequired

ID of the Fraud Case that is about to be deleted.

Example: ID?
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X DELETE \
  'https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases/ID?' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

Deleted

Response
No content

Fraud Alert

Request

Broadcast a fraud alert for the given Fraud Case.

Path
fraudCaseIdstringrequired

ID of the Fraud Case that the alert is about

Example: oaRnfC1D1Q
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases/oaRnfC1D1Q/triggeralert \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

Alert triggered

Response
No content

Fraud Cases Statistics

Request

Get statistics about the Fraud Cases.

Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/fraudcases/statistics \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

Fraud Cases Statistics

Body
dateinteger(int64)

Date of the statistics generation.

Example: "20240302"
cachedValueboolean

Indicates if the value is cached.

Example: "false"
numberOfAllFraudCasesinteger(int64)

Number of all fraud cases.

Example: "10"
numberOfDisclosedFraudCasesinteger(int64)

Number of disclosed fraud cases.

Example: "10"
numberOfUndisclosedFraudCasesinteger(int64)

Number of undisclosed fraud cases.

Example: "10"
numberOfFraudCasesOfTheUsersOrganizationinteger(int64)

Number of fraud cases of the user's organization.

Example: "10"
numberOfDisclosedFraudCasesOfTheUsersOrganizationinteger(int64)

Number of disclosed fraud cases of the user's organization.

Example: "10"
numberOfUndisclosedFraudCasesOfTheUsersOrganizationinteger(int64)

Number of undisclosed fraud cases of the user's organization.

Example: "10"
Response
{
  "date": "20240302",
  "cachedValue": "false",
  "numberOfAllFraudCases": "10",
  "numberOfDisclosedFraudCases": "10",
  "numberOfUndisclosedFraudCases": "10",
  "numberOfFraudCasesOfTheUsersOrganization": "10",
  "numberOfDisclosedFraudCasesOfTheUsersOrganization": "10",
  "numberOfUndisclosedFraudCasesOfTheUsersOrganization": "10"
}

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.

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.

Files

Gather endpoints that provide functionalities for managing files. These functionalities include uploading a file to S3.

Operations

Fraud Cases

Operations

Bank Data Sources

Operations

Bank Address Curation

Operations

Bank Account Storages

Operations

Processing logs

Operations

Bank Account Storage Data Monitors

Operations