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.

Lookup a Bank Information

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

SecurityapiKey

Request

Request Body schema: application/json

	object (BankLookupQuery) Query for bank lookup.
matchingThreshold	number <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"
maxCandidates	integer [ 20 .. 100 ] The maximum number of candidates that should be returned. Example: "50"
page	integer >= 0 Default: 0 The number of page. Example: "0"
pageSize	integer [ 1 .. 1000 ] The number of results that should be fetched. Maximum 1000 results can be returned in one page. Default: 10. Example: "100"

Responses

200

post/banks/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"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"
}

Response samples

application/json

{"pageSize": "100",
"totals": "67",
"page": "1",
"values": [{"cdqId": "VIES:543456-7820",
"dataSource": {"id": "648824a691d8d2503d65103e",
"url": "https://meta.cdq.com/Data_source/BR.RF",
"name": "Receita Federal Brazil",
"technicalKey": "BR_RF"
},
"bank": {"names": "Swiss National Bank",
"contact": {"emails": [{"address": "info@cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "0041",
"number": "58 631 00 00",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "0041 58 631 00 00"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
]
},
"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": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"language": {"name": null,
"technicalKey": null
}
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": ["9000"
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"openingHours": [{"openingHour": null,
"closingHour": null,
"weekday": null
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"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"
}
}
],
"externalId": "DE2357422",
"relations": [{"startedAt": "2024-11-21T10:53:14Z",
"endedAt": "2024-11-21T10:53:14Z",
"type": {"technicalKey": "BRANCH",
"name": "Organizational Unit"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
]
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "FULL_MATCH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"bank": {"classification": {"technicalKey": "FULL_MATCH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "FULL_MATCH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
}
}
]
}