System Banks

Delete Bank Data

SecurityapiKey

Request

Request Body schema: application/json

dataSourceId	string Data Source Id to delete data. If not provided default data source will be used.
externalIds	Array of strings The External Ids to delete data.

Responses

200

post/system/banks/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataSourceId": "string",
"externalIds": ["string"
]
}

Response samples

application/json

{"entriesToRemove": 0
}

Read System Banks

SecurityapiKey

Request

query Parameters

dataSourceIds	Array of strings Data Source Ids
externalId	string External Id
limit	integer <int32> [ 1 .. 100 ] Default: 50 Number of results that should be fetched. Maximum 100 results can be returned in one page.
startAfter	string Indicator for the next page.

Responses

200

get/system/banks

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "string",
"nextStartAfter": "string",
"limit": 0,
"values": [{"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": [{"cdqId": "string"
}
],
"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"
}
],
"dataSourceId": "string",
"rawData": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string"
}
]
}

Upsert Bank Data

SecurityapiKey

Request

Request Body schema: application/json

	Array of objects (BankUpsertRequest)
dataTransformationDefinitionId	string

Responses

200

post/system/banks/upsert

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataTransformationDefinitionId": "string",
"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": [{"cdqId": "string"
}
],
"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"
}
],
"dataSourceId": "string",
"rawData": { }
}
]
}

Response samples

application/json

{"numberOfAccepted": 0,
"numberOfFailed": 0,
"failures": [{"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": [{"cdqId": "string"
}
],
"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"
}
],
"dataSourceId": "string",
"rawData": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string"
},
"message": "This record could not be stored due to timeout."
}
]
}