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

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

Curate Bank Address

Request

Curates the given bank address.

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
Bodyapplication/jsonrequired
internationalBankIdentifierstring(InternationalBankIdentifier)

(BIC/SWIFT) Bank identifier which is globally unique.

Example: "KBSGCH22XXX"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bank/address/curate \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "internationalBankIdentifier": "KBSGCH22XXX"
  }'

Responses

OK

Bodyapplication/json
versionobject(AddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

identifyingNameobject(AddressIdentifyingName)

An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.

externalIdstring(AddressExternalId)

ID the address has in the external system where the record originates from.

Example: "1"
metadataobject(AddressMetadata)

Specifies the language and primary data provenance.

careOfobject(CareOf)

Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.

contextsArray of objects(AddressContext)
countryobject(Country)

Country consisting of the country name and country code (ISO 3166-1 alpha-2).

administrativeAreasArray of objects(AdministrativeArea)
postCodesArray of objects(PostCode)
Example: ["9000"]
localitiesArray of objects(Locality)
thoroughfaresArray of objects(Thoroughfare)
premisesArray of objects(Premise)
postalDeliveryPointsArray of objects(PostalDeliveryPoint)
openingHoursArray of objects(OpeningHour)
geographicCoordinatesobject(GeographicCoordinates)

Decimal geographic coordinates (WGS 84 - reference coordinate system).

typesArray of objects(AddressType)
formattedAddressobject(FormattedAddress)

A formatted address is a structured address of VIES data source.

cdqIdstring

Unique identifier which identifies a Business Partner with one address. The same address versions has the same cdq ID.

Example: "CDQID-1234567890"
Response
application/json
{ "version": { "characterSet": {}, "language": {} }, "identifyingName": { "value": "John Doe" }, "externalId": "1", "metadata": { "primaryProvenance": {}, "language": {} }, "careOf": { "value": "CDQ GmbH c/o Product Department" }, "contexts": [ {} ], "country": { "shortName": "CH", "value": "Switzerland" }, "administrativeAreas": [ {} ], "postCodes": [ "9000" ], "localities": [ {} ], "thoroughfares": [ {} ], "premises": [ {} ], "postalDeliveryPoints": [ {} ], "openingHours": [ {} ], "geographicCoordinates": { "latitude": "47.439549", "longitude": "9.395275" }, "types": [ {} ], "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" }

Bank Account Storages

Operations

Processing logs

Operations

Bank Account Storage Data Monitors

Operations