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

Lookup Bank Information

Request

Lookup bank information based on the given bank data lookup request.

Security
apiKey
Bodyapplication/json
bankobject(BankLookupQuery)

Query for bank lookup.

matchingThresholdnumber(double)[ 0 .. 1 ]

The minimum matching score that a bank must have to be included in the result set. Default: 0.0.

Example: "0.5"
maxCandidatesinteger[ 20 .. 100 ]

The maximum number of candidates that should be returned.

Example: "50"
pageSizeinteger[ 1 .. 1000 ]

The number of results that should be fetched. Maximum 1000 results can be returned in one page. Default: 10.

Example: "100"
pageinteger>= 0

The number of page.

Default 0
Example: "0"
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/bankaccount-data-api/api-v2/banks/lookup \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "bank": {
      "names": [
        {
          "value": "Deutsche Bank"
        }
      ],
      "identifiers": [
        {
          "value": "DEUTDEFF",
          "type": {
            "technicalKey": "CH_VAT_ID"
          }
        }
      ],
      "addresses": [
        {
          "thoroughfares": [
            {
              "value": "Musterstraße 12",
              "number": "12"
            }
          ],
          "localities": [
            {
              "value": "Wrocław"
            }
          ],
          "postCodes": [
            {
              "value": "59400"
            }
          ],
          "country": {
            "shortName": "DE"
          }
        }
      ]
    },
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "pageSize": "100",
    "page": "0"
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalsinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(BankLookupMatch)

List of bank data matches.

Response
application/json
{
  "pageSize": "100",
  "totals": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

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

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