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

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Mock server

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

Production

https://api.cdq.com/bankaccount-data/rest/

Data Transformation Definitions

Gather endpoints that provide functionalities for testing data transformation definitions. These functionalities include testing data transformation definitions.

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.

Operations

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.

Operations

List System Banks

Request

List system banks with the given parameters.

Security
apiKey
Query
limitinteger(int32)[ 1 .. 100 ]

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

Default 50
Example: limit=50
startAfterstring

Indicator for the next page.

Example: startAfter=5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)

Data Source IDs.

Example: dataSourceIds=648824a691d8d2503d65103e
externalIdstring(BusinessPartnerExternalId)

External ID.

Example: externalId=The ID managed in the customer's SAP systems.
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/system/banks \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

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(Limit)

Number of items per page.

Example: "100"
valuesArray of objects(BankInfo)

List of banks.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "values": [
    { … }
  ]
}

Upsert Bank Data

Request

Upsert system bank data with the given parameters.

Security
apiKey
Bodyapplication/json
dataTransformationDefinitionIdstring

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
banksArray of objects(BankUpsertRequest)

List of banks to be upserted.

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/system/banks/upsert \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "dataTransformationDefinitionId": "SAP.ODM",
    "banks": [
      {
        "names": "Swiss National Bank",
        "contact": {
          "emails": [
            {
              "address": "info@cdq.com",
              "type": {
                "name": "Bank contact email",
                "url": "https://meta.cdq.com/Bank_account/bank/contact/contact_email/type",
                "technicalKey": "BANK_CONTACT_EMAIL_TYPE"
              }
            }
          ],
          "phoneNumbers": [
            {
              "countryPrefix": "0041",
              "number": "58 631 00 00",
              "type": {
                "name": "Bank contact phone number",
                "url": "https://meta.cdq.com/Bank_account/bank/contact/phone_number/type",
                "technicalKey": "BANK_CONTACT_PHONE_TYPE_PHONE"
              },
              "value": "0041 58 631 00 00"
            }
          ],
          "websites": [
            {
              "url": "https://cdq.com",
              "type": {
                "name": "Bank contact website",
                "url": "https://meta.cdq.com/Bank_account/bank/contact/website/type",
                "technicalKey": "BANK_CONTACT_WEBSITE_TYPE"
              }
            }
          ]
        },
        "identifiers": [
          {
            "type": {
              "url": "https://meta.cdq.com/Bank_account/bank/identifier/type",
              "name": "Bank SWIFT Code",
              "technicalKey": "WR_BSC"
            },
            "value": "CH1234567890123456789",
            "issuingBody": {
              "name": "Bank Identifier Code",
              "url": "https://meta.cdq.com/Bank_account/bank/identifier/issuing_body",
              "technicalKey": "BIC"
            },
            "status": {
              "name": "Active",
              "technicalKey": "ACTIVE"
            }
          }
        ],
        "addresses": [
          {
            "version": {
              "characterSet": {
                "name": "International",
                "technicalKey": "INTERNATIONAL"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "identifyingName": {
              "value": "John Doe"
            },
            "externalId": "1",
            "metadata": {
              "primaryProvenance": {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "careOf": {
              "value": "CDQ GmbH c/o Product Department"
            },
            "contexts": [
              {
                "value": "Production hall 7, Storage field 8."
              }
            ],
            "country": {
              "shortName": "CH",
              "value": "Switzerland"
            },
            "administrativeAreas": [
              {
                "value": "Sankt Gallen",
                "shortName": "SG",
                "fipsCode": "SZ15",
                "isoCode": "CH-SG",
                "type": {},
                "language": {}
              }
            ],
            "postCodes": [
              "9000"
            ],
            "localities": [
              {
                "type": {},
                "shortName": "St. Gallen",
                "value": "Sankt Gallen",
                "language": {}
              }
            ],
            "thoroughfares": [
              {
                "type": {},
                "shortName": "Lukasstr. 4",
                "number": "4",
                "value": "Lukasstraße 4",
                "name": "Lukasstraße",
                "direction": "221-bis Baker Street, North",
                "language": {}
              }
            ],
            "premises": [
              {
                "value": "Lukasstraße 4",
                "shortName": "Lukasstr. 4",
                "number": "4",
                "type": {},
                "language": {}
              }
            ],
            "postalDeliveryPoints": [
              {
                "type": {},
                "shortName": "St Gallen, Postfach 460",
                "number": "460",
                "value": "Postfach",
                "language": {}
              }
            ],
            "openingHours": [
              {
                "openingHour": "09:00 AM",
                "closingHour": "05:00 PM",
                "weekday": "Monday"
              }
            ],
            "geographicCoordinates": {
              "latitude": "47.439549",
              "longitude": "9.395275"
            },
            "types": [
              {
                "name": "Legal Address",
                "url": "https://meta.cdq.com/Address/type",
                "technicalKey": "LEGAL_ADDRESS"
              }
            ],
            "formattedAddress": {
              "country": "Switzerland",
              "administrativeArea": "Sankt Gallen",
              "region": "Sankt Gallen",
              "regionCode": "9004",
              "locality": "Sankt Gallen",
              "district": "City center",
              "postalCode": "9000",
              "thoroughfare": "Lukassstrasse",
              "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
              "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
              "mailbox": "Postfach 460",
              "postOfficeBox": "Postfach 460"
            },
            "cdqId": "CDQID-1234567890"
          }
        ],
        "externalId": "DE2357422",
        "relations": [
          {
            "startedAt": "2025-08-29T09:46:42Z",
            "endedAt": "2025-08-29T09:46:42Z",
            "type": {
              "technicalKey": "BRANCH",
              "name": "Organizational Unit"
            },
            "startNode": "FR.RC:5664645",
            "endNode": "FR.RC:5664645"
          }
        ],
        "dataSourceId": "648824a691d8d2503d65103e",
        "rawData": {}
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfAcceptedinteger

Number of bank upserts accepted.

Example: "10"
numberOfFailedinteger

Number of banks upsert failed.

Example: "1"
failuresArray of objects(BankDataUpsertFailureLog)

List of bank upsert failures.

Response
application/json
{
  "numberOfAccepted": "10",
  "numberOfFailed": "1",
  "failures": [
    { … }
  ]
}

Delete Bank Data

Request

Delete system bank data with the given parameters.

Security
apiKey
Bodyapplication/json
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
externalIdsArray of strings(BusinessPartnerExternalId)

List of External IDs to delete data.

Example: ["The ID managed in the customer's SAP systems."]
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/system/banks/delete \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "dataSourceId": "648824a691d8d2503d65103e",
    "externalIds": [
      "The ID managed in the customer'\''s SAP systems."
    ]
  }'

Responses

OK

Bodyapplication/json
entriesToRemoveinteger(int64)

Number of entries removed.

Example: "10"
Response
application/json
{
  "entriesToRemove": "10"
}

Files

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

Operations

Bank Data Sources

Operations

Bank Account Storage Data Monitors

Operations