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

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

Upserts Bank Account Log Entries List

Request

Upserts a list of bank account log entries.

Path
storageIdstring^[a-fA-F0-9]{24}$required

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Bodyapplication/jsonrequired

Add bank account processing log entries.

resultsArray of objects(ProcessingLogData)<= 100 items

List of bank account processing log entries.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountprocessinglogs/652697d8eb91545eb14e64e6/results \
  -H 'Content-Type: application/json' \
  -d '{
    "results": [
      {
        "processingLogType": "TRUST_SCORE_LOG",
        "bankAccountId": "6491b674961b604fd1cd8a65",
        "bankAccountStorageId": "72d6900fce6b326088f5d9d91049e3e6",
        "bankAccountExternalId": "123456789010",
        "resultData": {
          "request": {
            "internationalBankAccountIdentifier": "CH8800781619278412000",
            "internationalBankIdentifier": "KBSGCH22XXX",
            "bankCountryCode": "DE",
            "nationalBankIdentifier": "00781",
            "nationalBankAccountIdentifier": "619278412000"
          },
          "bankAccount": {
            "internationalBankAccountIdentifier": "CH8800781619278412000",
            "nationalBankAccountIdentifier": "619278412000",
            "payees": [
              {
                "name": "CDQ AG",
                "externalId": "The ID managed in the customer'\''s SAP systems.",
                "storage": {},
                "dataSource": {}
              }
            ],
            "bank": {
              "cdqId": "CDQID-1234567890",
              "name": [
                {}
              ],
              "internationalBankIdentifier": "KBSGCH22XXX",
              "nationalBankIdentifier": "00781",
              "address": {
                "version": {},
                "identifyingName": {},
                "externalId": "1",
                "metadata": {},
                "careOf": {},
                "contexts": [
                  null
                ],
                "country": {},
                "administrativeAreas": [
                  null
                ],
                "postCodes": [
                  null
                ],
                "localities": [
                  null
                ],
                "thoroughfares": [
                  null
                ],
                "premises": [
                  null
                ],
                "postalDeliveryPoints": [
                  null
                ],
                "openingHours": [
                  null
                ],
                "geographicCoordinates": {},
                "types": [
                  null
                ],
                "formattedAddress": {}
              }
            },
            "vendorPaymentSummary": {
              "firstPaymentDate": "2020-08-31T16:47+00:00",
              "lastPaymentDate": "2020-08-31T16:47+00:00",
              "numberOfPayments": "1"
            },
            "externalId": "The ID managed in the customer'\''s SAP systems.",
            "id": "63e635235c06b7396330fe40"
          },
          "numberOfCompanies": "5",
          "trustScore": "7",
          "bankAccountOwners": [
            {
              "name": "John Doe",
              "lastPaymentAt": "2024-01-01T00:00:00Z"
            }
          ],
          "associatedFraudCases": [
            {
              "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"
            }
          ]
        },
        "executedAt": "2019-09-07T00:00:00Z"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
createdinteger(int32)

Number of created bank account processing log entries.

Example: "1"
updatedinteger(int32)

Number of updated bank account processing log entries.

Example: "1"
failedinteger(in32)

Number of failed bank account processing log entries.

Example: "1"
Response
application/json
{
  "created": "1",
  "updated": "1",
  "failed": "1"
}

List Bank Account Processing Log Data

Request

Read a page of Bank Account processing log data by next after approach. The results are stored in the processing log and can be used to carry additional information.

Path
storageIdstring^[a-fA-F0-9]{24}$required

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Query
processingLogTypestring(ProcessingLogTypeEnum)

Unique identifier of a processing log.

ValueDescription
TRUST_SCORE_LOG

Trust Score processing log identifier.

Example: processingLogType=TRUST_SCORE_LOG
startAfterstring(StartAfter)

Indicator for the next page.

Example: startAfter=5712566172571652
limitinteger(int32)

Number of results that should be fetched. Maximum 5000 results can be returned in one page.

Default 100
Example: limit=100
fromstring

ISO 8601 representation of the timestamp when the result data was created.

Example: from=2019-09-07T00:00:00Z
tostring

ISO 8601 representation of the timestamp when the result data was created.

Example: to=2019-09-07T00:00:00Z
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountprocessinglogs/652697d8eb91545eb14e64e6/results

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(int32)

Number of items per page.

Example: "100"
fromstring

ISO 8601 representation of the timestamp when the result data was created.

Example: "2019-09-07T-15:50+00"
tostring

ISO 8601 representation of the timestamp when the result data was created.

Example: "2019-09-07T-15:50+00"
totalinteger(int32)

Total number of bank account processing log data, which can be paged.

Example: "67"
valuesArray of objects(ProcessingLogData)

List of bank account processing log data.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "from": "2019-09-07T-15:50+00",
  "to": "2019-09-07T-15:50+00",
  "total": "67",
  "values": [
    { … }
  ]
}

Delete Bank Account processing log data

Request

Delete Bank Account processing log data by ID.

Path
storageIdstring^[a-fA-F0-9]{24}$required

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Bodyapplication/json
processingLogTypestring(ProcessingLogTypeEnum)

Unique identifier of a bank account processing log type.

ValueDescription
TRUST_SCORE_LOG

Trust Score processing log identifier.

Example: "TRUST_SCORE_LOG"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/bankaccountprocessinglogs/652697d8eb91545eb14e64e6/delete \
  -H 'Content-Type: application/json' \
  -d '{
    "processingLogType": "TRUST_SCORE_LOG"
  }'

Responses

OK

Bodyapplication/json
deletedinteger(int32)

Number of deleted bank account processing log entries.

Example: "1"
Response
application/json
{
  "deleted": "1"
}

Bank Account Storage Data Monitors

Operations