Bank Data Lookup

Lookup bank information

SecurityapiKey

Request

Request Body schema: application/json

	object (BankLookupQuery)
matchingThreshold	number <double> [ 0 .. 1 ] default: 0.0
maxCandidates	integer [ 20 .. 100 ]
page	integer >= 0 Default: 0
pageSize	integer [ 1 .. 1000 ] default: 10

Responses

200

post/banks/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"bank": {"names": [{"value": "string"
}
],
"identifiers": [{"value": "string",
"type": {"technicalKey": "string"
}
}
],
"addresses": [{"thoroughfares": [{"value": "string",
"number": "string"
}
],
"localities": [{"value": "Wrocław"
}
],
"postCodes": [{"value": "59400"
}
],
"country": {"shortName": "DE"
}
}
]
},
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0
}

Response samples

application/json

{"pageSize": 0,
"totals": 0,
"page": 0,
"values": [{"cdqId": "string",
"dataSource": {"id": "string",
"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": ["Lukasstraße 4, 9008 St. Gallen"
],
"externalId": "DE2357422",
"relations": [{"startedAt": "2019-08-31T16:47+00:00",
"endedAt": "2019-08-31T16:47+00:00",
"type": {"technicalKey": "BRANCH",
"name": "Organizational Unit"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
]
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "FULL_MATCH",
"name": "string"
},
"value": 0,
"explanation": "string"
},
"bank": {"classification": {"technicalKey": "FULL_MATCH",
"name": "string"
},
"value": 0,
"explanation": "string"
},
"address": {"classification": {"technicalKey": "FULL_MATCH",
"name": "string"
},
"value": 0,
"explanation": "string"
}
}
}
}
]
}