Trader Backend API Specs

• AML
  • getList of AMLMonitorCustomerPEPRecords for Anti Money Laundering monitoring
  • postCreate AMLMonitorCustomerPEPRecord
  • putUpdate AMLMonitorCustomerPEPRecord details by the given input
  • patchMake AMLMonitorCustomerPEPRecord in-active
  • getList of AMLMonitorCustomerSanctionRecords for Anti Money Laundering monitoring
  • postCreate AMLMonitorCustomerSanctionRecord
  • putUpdate AMLMonitorCustomerSanctionRecord details by the given input
  • patchMake AMLMonitorCustomerSanctionRecord in-active
  • getList of AMLMonitorCustomerOtherRecords for Anti Money Laundering monitoring
  • postCreate AMLMonitorCustomerOtherRecord
  • putUpdate AMLMonitorCustomerOtherRecord details by the given input
  • patchMake AMLMonitorCustomerOtherRecord in-active
  • getList of AMLParameterCustomerCashBalances for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerCashBalance
  • putUpdate AMLParameterCustomerCashBalance details by the given input
  • patchMake AMLParameterCustomerCashBalance in-active
  • getList of AMLParameterCustomerOccupationGroups for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerOccupationGroup
  • putUpdate AMLParameterCustomerOccupationGroup details by the given input
  • patchMake AMLParameterCustomerOccupationGroup in-active
  • getList of AMLParameterCustomerOriginCountrys for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerOriginCountry
  • putUpdate AMLParameterCustomerOriginCountry details by the given input
  • patchMake AMLParameterCustomerOriginCountry in-active
  • getList of AMLParameterCustomerReferenceAccountCountrys for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerReferenceAccountCountry
  • putUpdate AMLParameterCustomerReferenceAccountCountry details by the given input
  • patchMake AMLParameterCustomerReferenceAccountCountry in-active
  • getList of AMLParameterCustomerResidencyCountrys for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerResidencyCountry
  • putUpdate AMLParameterCustomerResidencyCountry details by the given input
  • patchMake AMLParameterCustomerResidencyCountry in-active
  • getList of AMLParameterCustomerSectors for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerSector
  • putUpdate AMLParameterCustomerSector details by the given input
  • patchMake AMLParameterCustomerSector in-active
  • getList of AMLParameterCustomerAccountUsageTypes for Anti Money Laundering monitoring
  • postCreate AMLParameterCustomerAccountUsageType parameter
  • putUpdate AMLParameterCustomerAccountUsageType details by the given input
  • patchMake AMLParameterCustomerAccountUsageType in-active
  • getList of AMLParameterIndividualTransactionAmounts for Anti Money Laundering monitoring
  • postCreate AMLParameterIndividualTransactionAmount
  • putUpdate AMLParameterIndividualTransactionAmount details by the given input
  • patchMake AMLParameterIndividualTransactionAmount in-active
  • getList of AMLParameterIndividualTransactionOtherAccountCountrys for Anti Money Laundering monitoring
  • postCreate AMLParameterIndividualTransactionOtherAccountCountry
  • putUpdate AMLParameterIndividualTransactionOtherAccountCountry details by the given input
  • patchMake AMLParameterIndividualTransactionOtherAccountCountry in-active
  • getList of AMLParameterIndividualTransactionReferenceAccountCountrys for Anti Money Laundering monitoring
  • postCreate AMLParameterIndividualTransactionReferenceAccountCountry
  • putUpdate AMLParameterIndividualTransactionReferenceAccountCountry details by the given input
  • patchMake AMLParameterIndividualTransactionReferenceAccountCountry in-active
  • getList of AMLParameterAggregateTransactionAmounts for Anti Money Laundering monitoring
  • postCreate AMLParameterAggregateTransactionAmount
  • putUpdate AMLParameterAggregateTransactionAmount details by the given input
  • patchMake AMLParameterAggregateTransactionAmount in-active
  • getList of AMLParameterAggregateTransactionCounts for Anti Money Laundering monitoring
  • postCreate AMLParameterAggregateTransactionCount
  • putUpdate AMLParameterAggregateTransactionCount details by the given input
  • patchMake AMLParameterAggregateTransactionCount in-active
  • getList of AMLCustomerRiskFactorCalculationDailyRecords for a client within the given date-time frame.
  • getList of AMLCustomerRiskFactorCalculationDailyRecords based on several filters
  • patchUpdate AMLCustomerActionRiskFactorEvaluationRecord status in order to allow client action, or deny because it is found risky in terms of AML If approved, then the action will be completed. If denied, then the action is rejected and not completed.
  • patchUpdate AMLCustomerActionRiskFactorEvaluationRecord reason and note
  • getList of Most Risky Clients based on several filters
  • getGet AML tenant general parameter record
  • putUpdate AML tenant general parameter record
  • getGet money laundering indicator of a customer
  • postSend customer to AML monitoring
  • putRefresh customer AML monitoring hits
  • getGet customer AML monitoring details
• BankAccount
  • postCreate new bank account
  • getGet list of bank accounts
  • patchUpdate bank account status
  • putAdd document
  • delRemove document
  • getGet a bank account document
  • patchValidate bank account
  • getGet a bank account
  • getGet a bank account validation
• Client
  • getList clients
  • postCreate client
  • getGet client
  • putUpdate client
  • patchUpdate client email
  • patchUpdate client occupation group
  • putUpload client document
  • getList client documents
  • delDelete client document
  • getGet client document file
  • getList client bank accounts
  • getGet client bank account
  • getList client internal accounts
  • getGet client internal account
  • getList client deposit accounts
  • getReturn client deposit account
  • getList authorized people under a client
  • postCreate an authorized person
  • getGet an authorized person under a client
  • delDelete an authorized person
  • putUpdate authorized person
  • getGet an authorized person document under a client
  • putAdd new phone number
  • getList phone numbers of a client
  • delRemove phone number
  • putUpdate phone number
  • getGet phone number
  • putAdd new address
  • getList client addresses
  • delRemove address
  • putUpdate address
  • getGet a spesific address of a a client
  • patchUpdate record state of an address
  • putSet default bank account
  • putSet default internal account
  • putSet default deposit account
  • putAdd new tax identifier
  • getList tax identifiers
  • delRemove tax identifier
  • putUpdate tax identifier
  • getGet tax identifier
  • patchValidate client
  • patchUpdate client status
  • putAdd new non-assessment certificate
  • getList non-assessment certificates
  • patchRevoke non-assessment certificate
  • getGet non-assessment certificate
  • getGet active exemption orders
  • getGet client tax data
  • patchUpdate client partnership
  • patchReleases client partnership
  • getGet church tax information
  • postTrigger KISTAM request
  • putAdd new employment information
  • getList client employment informations
  • putUpdate employment information
  • delRemove employment information
  • getGet a spesific employment information of a a client
  • postUnsubscribe a report event
  • delSubscribe a report event
  • getGets unsubscribed report events for a client
  • putAdd new client photo
  • getGet the photo of the given client
  • putUpdate client photo
  • getGet client loss threshold reports
  • getGet client loss threshold report
  • getGet client loss threshold event
  • getGet list of Ultimate Beneficial Owners
  • postNew Ultimate Beneficial Owner
  • getGet a Ultimate Beneficial Owner
  • putUpdate Ultimate Beneficial Owner
  • getGet a Ultimate Beneficial Owner Document
  • patchUpdate Ultimate Beneficial Owner Valid Record as False
  • postStart KYC process for a client
  • getGet KYC detail of client
  • patchUpdate Kyc Status of the specified Kyc Detail (KYC Simulation Mode)
  • patchUpdate Kyc Status of the specified Kyc Detail
  • getGet KYC details of client
  • getGet investment decision makers of business client
  • postCreate new investment decision maker
  • putUpdate investment decision maker
  • patchUpdate default investment decision maker
  • patchUpdate activeness of business client investment decision maker
• CorporateActions
  • getGet corporate action statement
  • getGet corporate action metadata
  • getGet corporate action with choice details for the customer notification
  • getReturns the corporate action with choice records within the given date range.
  • getGet corporate action summary list for the dashboard
  • getGet corporate action detail for the dashboard
  • getGet related security account list for the given corporate action
  • getGet instruction details of a voluntary corporate action for a spesific security account
  • postSubmit customer instruction for a voluntary corporate action.
  • getGet list of instructions that pending approve
  • patchCancel a previously submitted corporate action instruction (allowed until checker approval).
  • patchApprove or reject a corporate action instruction
  • patchCancel a single corporate action instruction election (allowed until checker approval).
  • patchApprove or reject single corporate action instruction election
  • getGet list of submitted elections for a ca job
  • putUpdate customer instruction for a voluntary corporate action.
• DepositAccount
  • postCreate new deposit account
  • getGet list of deposit accounts
  • patchUpdate deposit account status
  • patchUpdate deposit account alias
  • getGet a deposit account
  • getGet all open positions of a particular deposit account
  • getGet an open position by id
  • getGet transactions of a particular deposit account
  • getGet a particular deposit account transaction by id
  • getGet transaction tax data of a particular deposit account
  • getGet a particular deposit account statement
  • getGet deposit account statements
  • getGet a particular deposit account transaction statement
• ExemptionOrder
  • postCreate or update an exemption order
  • patchRevoke an existing exemption order
• Fee
  • postInitiate one time fee request for a cash account
  • getGet supported fee types
  • getGet one time fee requests
  • getGet one time fee request by request Id
  • patchApprove one time fee request
• Helpers
  • getReturns list of all federal states
  • getReturns list of all employment sector definitons
  • getReturns list of divisions for requested classification code
  • getReturns list of possible event reports that can be generated by the system
  • getReturns list of api return code details that can be generated by the order management api
• InternalAccount
  • postCreate new internal account
  • getGet list of internal accounts
  • patchUpdate internal account status
  • postInitiate interest settlement process for the internal account, when account status is in InClosure
  • patchUpdate internal account alias
  • getGet an internal account
  • getGet available withdrawal balance for any internal account
  • getGet total balance for any internal account
  • getGet available trade balance for any internal account
  • getGet transactions of a particular internal account
  • getGet a particular internal account transaction by id
  • getGet transaction tax data of a particular internal account
  • postWithdraw money from an internal account
  • getGet internal account withdrawal request by withdrawal request id
  • getGet internal account withdrawal requests by internal account
  • getGet a particular internal account statement
  • getGet internal account statements
  • getGet available floating balance for any internal account
  • getGet a particular internal account transaction statement
• MoneyManagement
  • postCreate a SEPA direct debit mandate creditor for the tenant
  • getGet existing SEPA direct mandate creditors created for the tenant
  • putUpdate SEPA direct debit mandate creditor for the tenant
  • getGet an existing SEPA direct debit mandate creditor by id
  • patchInvalidate an existing SEPA direct debit mandate creditor
  • postCreate a SEPA direct debit mandate on a particular bank account
  • getGet existing SEPA direct debit mandates on a particular bank account
  • patchInvalidate an existing SEPA direct debit mandate
  • getGet an existing SEPA direct debit mandate by id
  • postCreate a new SEPA direct debit instruction
  • patchCancel an existing SEPA direct debit instruction (If not uploaded to bank yet)
  • getGet existing SEPA direct debit instructions using the filter parameters
  • getGet existing SEPA direct debit instructions on a particular mandate
  • getGet an existing SEPA direct debit instruction by id
  • postCreate a new Payment Instruction
  • getGet an existing Payment Instruction by Initiator's own identifier
• OutgoingDepositTransfer
  • getGet an Outgoing Deposit Transfer Batch
  • getGet list of Outgoing Deposit Transfer Batch
  • getGet Outgoing Deposit Transfer Document
  • delRemove Outgoing Deposit Transfer Document
  • getList Outgoing Deposit Transfer Documents
  • getList Trade Positions To Transfer
  • getList Outgoing Deposit Transfer Custodian Messages
• Report
  • getGet list of top traded instruments
  • getList Position Holdings
  • getGet IFR Metrics
• Tenant
  • postUnsubscribe a report event
  • delSubscribe a report event
  • getGets unsubscribed report events for a tenant
  • getReplay Event Report
  • getGet investment decision makers with scope = DealingDesk
  • postCreate new investment decision maker with scope = DealingDesk
  • putUpdate investment decision maker
  • patchUpdate default investment decision maker
  • patchUpdate investment decision maker set IsActive to false

API docs by Redocly

koala.markets TraderBackendApi (3.3.16.0)

Download OpenAPI specification:Download

koala.markets: devcenter@koala.markets URL: https://koala.markets

Documentation of koala.markets Trader Backend APIs

AML

List of AMLMonitorCustomerPEPRecords for Anti Money Laundering monitoring

Return a list of AMLMonitorCustomerPEPRecords for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords	boolean Whether the result should contain in-active records
includeOnlyIsBanned	boolean Whether the result should contain only banned records
startDate	string <date-time> First Creation Date
endDate	string <date-time> Last Creation Date
customerId	string <uuid> Customer Id
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List

Responses

/api/aml/record/customerPEP

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "isActive": true,
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "informationSource": "string",
  • "isBanned": true,
  • "reason": "string",
  • "note": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLMonitorCustomerPEPRecord

Creates a new AMLMonitorCustomerPEPRecord

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerPEPRecordBase

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerPEP

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLMonitorCustomerPEPRecord details by the given input

Updates AMLMonitorCustomerPEPRecord details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerPEPRecord to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerPEPRecord base info to update

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerPEP/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLMonitorCustomerPEPRecord in-active

De-Activates AMLMonitorCustomerPEPRecord

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerPEPRecord to make in-active

Responses

/api/aml/record/customerPEP/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLMonitorCustomerSanctionRecords for Anti Money Laundering monitoring

Return a list of AMLMonitorCustomerSanctionRecords for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords	boolean Whether the result should contain in-active records
includeOnlyIsBanned	boolean Whether the result should contain only banned records
startDate	string <date-time> First Creation Date
endDate	string <date-time> Last Creation Date
customerId	string <uuid> Customer Id
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List

Responses

/api/aml/record/customerSanction

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "isActive": true,
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "informationSource": "string",
  • "isBanned": true,
  • "reason": "string",
  • "note": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLMonitorCustomerSanctionRecord

Creates a new AMLMonitorCustomerSanctionRecord

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerSanctionRecordBase

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerSanction

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLMonitorCustomerSanctionRecord details by the given input

Updates AMLMonitorCustomerSanctionRecord details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerSanctionRecord to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerSanctionRecord base info to update

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerSanction/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLMonitorCustomerSanctionRecord in-active

De-Activates AMLMonitorCustomerSanctionRecord

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerSanctionRecord to make in-active

Responses

/api/aml/record/customerSanction/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLMonitorCustomerOtherRecords for Anti Money Laundering monitoring

Return a list of AMLMonitorCustomerOtherRecords for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords	boolean Whether the result should contain in-active records
includeOnlyIsBanned	boolean Whether the result should contain only banned records
startDate	string <date-time> First Creation Date
endDate	string <date-time> Last Creation Date
customerId	string <uuid> Customer Id
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List

Responses

/api/aml/record/customerOther

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "isActive": true,
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "recordType": "Other",
  • "informationSource": "string",
  • "isBanned": true,
  • "reason": "string",
  • "note": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLMonitorCustomerOtherRecord

Creates a new AMLMonitorCustomerOtherRecord

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerOtherRecordBase

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
recordType required	string Enum: "Other" "AdverseMedia" "LegalEnforcement" AdverseMedia: An adverse media hi LegalEnforcement: A legal penalty hit Other: Any other type of hit
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerOther

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "recordType": "Other",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLMonitorCustomerOtherRecord details by the given input

Updates AMLMonitorCustomerOtherRecord details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerOtherRecord to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLMonitorCustomerOtherRecord base info to update

customerId required	string <uuid>
isActive required	boolean There can only 1 Active record for the same CustomerId.
dateStart	string <date-time> When this record's effect start
dateEnd	string or null <date-time> When this record's effect ends
recordType required	string Enum: "Other" "AdverseMedia" "LegalEnforcement" AdverseMedia: An adverse media hi LegalEnforcement: A legal penalty hit Other: Any other type of hit
informationSource	string or null <= 36 characters The information source that this record data has been originated. Lionware, Fourthline, etc.
isBanned	boolean Whether the transactions of customer should be banned and/or cancelled by anti money laundering officer
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users

Responses

/api/aml/record/customerOther/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
• "isActive": true,
• "dateStart": "2019-08-24T14:15:22Z",
• "dateEnd": "2019-08-24T14:15:22Z",
• "recordType": "Other",
• "informationSource": "string",
• "isBanned": true,
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLMonitorCustomerOtherRecord in-active

De-Activates AMLMonitorCustomerOtherRecord

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLMonitorCustomerOtherRecord to make in-active

Responses

/api/aml/record/customerOther/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerCashBalances for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerCashBalances for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerCashBalance

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "minAmount": 0,
  • "maxAmount": 0,
  • "currencyCode": "str",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerCashBalance

Creates a new AMLParameterCustomerCashBalance

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerCashBalanceBase

minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the MinAmount MaxAmount range.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerCashBalance

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerCashBalance details by the given input

Updates AMLParameterCustomerCashBalance details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerCashBalance to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerCashBalance base info to update

minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the MinAmount MaxAmount range.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerCashBalance/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerCashBalance in-active

De-Activates AMLParameterCustomerCashBalance

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerCashBalance to make in-active

Responses

/api/aml/parameter/customerCashBalance/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerOccupationGroups for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerOccupationGroups for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerOccupationGroup

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "occupationGroupCode": "Other",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerOccupationGroup

Creates a new AMLParameterCustomerOccupationGroup

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerOccupationGroupBase

occupationGroupCode required	string Enum: "Other" "PupilOrStudent" "Pensioner" Occupation group code of the customer
isActive required	boolean There can only 1 Active record for the same OccupationGroupCode.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerOccupationGroup

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "occupationGroupCode": "Other",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerOccupationGroup details by the given input

Updates AMLParameterCustomerOccupationGroup details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerOccupationGroup to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerOccupationGroup base info to update

occupationGroupCode required	string Enum: "Other" "PupilOrStudent" "Pensioner" Occupation group code of the customer
isActive required	boolean There can only 1 Active record for the same OccupationGroupCode.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerOccupationGroup/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "occupationGroupCode": "Other",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerOccupationGroup in-active

De-Activates AMLParameterCustomerOccupationGroup

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerOccupationGroup to make in-active

Responses

/api/aml/parameter/customerOccupationGroup/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerOriginCountrys for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerOriginCountrys for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerOriginCountry

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "countryCode": "str",
  • "isActive": true,
  • "countryName": "string",
  • "countryGroup": "string",
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerOriginCountry

Creates a new AMLParameterCustomerOriginCountry

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerOriginCountryBase

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerOriginCountry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerOriginCountry details by the given input

Updates AMLParameterCustomerOriginCountry details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerOriginCountry to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerOriginCountry base info to update

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerOriginCountry/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerOriginCountry in-active

De-Activates AMLParameterCustomerOriginCountry

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerOriginCountry to make in-active

Responses

/api/aml/parameter/customerOriginCountry/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerReferenceAccountCountrys for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerReferenceAccountCountrys for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerReferenceAccountCountry

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "countryCode": "str",
  • "isActive": true,
  • "countryName": "string",
  • "countryGroup": "string",
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerReferenceAccountCountry

Creates a new AMLParameterCustomerReferenceAccountCountry

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerReferenceAccountCountryBase

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerReferenceAccountCountry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerReferenceAccountCountry details by the given input

Updates AMLParameterCustomerReferenceAccountCountry details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerReferenceAccountCountry to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerReferenceAccountCountry base info to update

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerReferenceAccountCountry/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerReferenceAccountCountry in-active

De-Activates AMLParameterCustomerReferenceAccountCountry

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerReferenceAccountCountry to make in-active

Responses

/api/aml/parameter/customerReferenceAccountCountry/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerResidencyCountrys for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerResidencyCountrys for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerResidencyCountry

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "countryCode": "str",
  • "isActive": true,
  • "countryName": "string",
  • "countryGroup": "string",
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerResidencyCountry

Creates a new AMLParameterCustomerResidencyCountry

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerResidencyCountryBase

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerResidencyCountry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerResidencyCountry details by the given input

Updates AMLParameterCustomerResidencyCountry details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerResidencyCountry to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerResidencyCountry base info to update

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerResidencyCountry/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerResidencyCountry in-active

De-Activates AMLParameterCustomerResidencyCountry

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerResidencyCountry to make in-active

Responses

/api/aml/parameter/customerResidencyCountry/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerSectors for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerSectors for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerSector

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "sectorCode": "string",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerSector

Creates a new AMLParameterCustomerSector

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerSectorBase

sectorCode required	string non-empty Service code for the transaction. This could be from [EmploymentClassifications].SectorCode such as "F" F.01.11.0
isActive required	boolean There can only 1 Active record for the same SectorCode.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerSector

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "sectorCode": "string",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerSector details by the given input

Updates AMLParameterCustomerSector details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerSector to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerSector base info to update

sectorCode required	string non-empty Service code for the transaction. This could be from [EmploymentClassifications].SectorCode such as "F" F.01.11.0
isActive required	boolean There can only 1 Active record for the same SectorCode.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerSector/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "sectorCode": "string",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerSector in-active

De-Activates AMLParameterCustomerSector

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerSector to make in-active

Responses

/api/aml/parameter/customerSector/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterCustomerAccountUsageTypes for Anti Money Laundering monitoring

Return a list of AMLParameterCustomerAccountUsageTypes for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/customerService

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "accountUsageType": "PortfolioManagement",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterCustomerAccountUsageType parameter

Creates a new AMLParameterCustomerAccountUsageType parameter

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerAccountUsageTypeBase

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerService

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterCustomerAccountUsageType details by the given input

Updates AMLParameterCustomerAccountUsageType details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerAccountUsageType to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterCustomerAccountUsageType base info to update

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/customerService/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterCustomerAccountUsageType in-active

De-Activates AMLParameterCustomerAccountUsageType

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterCustomerAccountUsageType to make in-active

Responses

/api/aml/parameter/customerService/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterIndividualTransactionAmounts for Anti Money Laundering monitoring

Return a list of AMLParameterIndividualTransactionAmounts for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/individualTransactionAmount

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "accountUsageType": "PortfolioManagement",
  • "minAmount": 0,
  • "maxAmount": 0,
  • "currencyCode": "str",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterIndividualTransactionAmount

Creates a new AMLParameterIndividualTransactionAmount

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionAmountBase

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionAmount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterIndividualTransactionAmount details by the given input

Updates AMLParameterIndividualTransactionAmount details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionAmount to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionAmount base info to update

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionAmount/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterIndividualTransactionAmount in-active

De-Activates AMLParameterIndividualTransactionAmount

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionAmount to make in-active

Responses

/api/aml/parameter/individualTransactionAmount/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterIndividualTransactionOtherAccountCountrys for Anti Money Laundering monitoring

Return a list of AMLParameterIndividualTransactionOtherAccountCountrys for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/individualTransactionOtherAccountCountry

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "countryCode": "str",
  • "isActive": true,
  • "countryName": "string",
  • "countryGroup": "string",
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterIndividualTransactionOtherAccountCountry

Creates a new AMLParameterIndividualTransactionOtherAccountCountry

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionOtherAccountCountryBase

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionOtherAccountCountry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterIndividualTransactionOtherAccountCountry details by the given input

Updates AMLParameterIndividualTransactionOtherAccountCountry details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionOtherAccountCountry to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionOtherAccountCountry base info to update

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionOtherAccountCountry/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterIndividualTransactionOtherAccountCountry in-active

De-Activates AMLParameterIndividualTransactionOtherAccountCountry

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionOtherAccountCountry to make in-active

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionOtherAccountCountry/{recordId}/isActive/false

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterIndividualTransactionReferenceAccountCountrys for Anti Money Laundering monitoring

Return a list of AMLParameterIndividualTransactionReferenceAccountCountrys for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/individualTransactionReferenceAccountCountry

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "countryCode": "str",
  • "isActive": true,
  • "countryName": "string",
  • "countryGroup": "string",
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterIndividualTransactionReferenceAccountCountry

Creates a new AMLParameterIndividualTransactionReferenceAccountCountry

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionReferenceAccountCountryBase

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionReferenceAccountCountry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterIndividualTransactionReferenceAccountCountry details by the given input

Updates AMLParameterIndividualTransactionReferenceAccountCountry details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionReferenceAccountCountry to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterIndividualTransactionReferenceAccountCountry base info to update

countryCode required	string = 3 characters 3 letter country code in ISO 3166-1 alpha-3
isActive required	boolean There can only 1 Active record for the same CountryCode.
countryName required	string [ 1 .. 128 ] characters Name of the Country in English
countryGroup required	string [ 1 .. 128 ] characters If this record is a part of group country, the name of that group as a descriptive text. Such as one of: 'EU countries', 'Rest of EU', 'EFTA country', 'Other SEPA countries', 'Third countries outside the EU/SEPA'
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/individualTransactionReferenceAccountCountry/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "countryCode": "str",
• "isActive": true,
• "countryName": "string",
• "countryGroup": "string",
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterIndividualTransactionReferenceAccountCountry in-active

De-Activates AMLParameterIndividualTransactionReferenceAccountCountry

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterIndividualTransactionReferenceAccountCountry to make in-active

Responses

/api/aml/parameter/individualTransactionReferenceAccountCountry/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterAggregateTransactionAmounts for Anti Money Laundering monitoring

Return a list of AMLParameterAggregateTransactionAmounts for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/aggregateTransactionAmount

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "accountUsageType": "PortfolioManagement",
  • "minAmount": 0,
  • "maxAmount": 0,
  • "currencyCode": "str",
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterAggregateTransactionAmount

Creates a new AMLParameterAggregateTransactionAmount

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterAggregateTransactionAmountBase

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/aggregateTransactionAmount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterAggregateTransactionAmount details by the given input

Updates AMLParameterAggregateTransactionAmount details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterAggregateTransactionAmount to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterAggregateTransactionAmount base info to update

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minAmount required	number <decimal> Minimum money amount that this parameter risk factor is effective for the transaction
maxAmount	number or null <decimal> Maximum money amount that this parameter risk factor is effective for the transaction
currencyCode required	string = 3 characters 3 letter currency code. default: EUR
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/aggregateTransactionAmount/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minAmount": 0,
• "maxAmount": 0,
• "currencyCode": "str",
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterAggregateTransactionAmount in-active

De-Activates AMLParameterAggregateTransactionAmount

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterAggregateTransactionAmount to make in-active

Responses

/api/aml/parameter/aggregateTransactionAmount/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLParameterAggregateTransactionCounts for Anti Money Laundering monitoring

Return a list of AMLParameterAggregateTransactionCounts for Anti Money Laundering monitoring

Authorizations:

BearerOpenIdConnect

query Parameters

includeInActiveRecords

boolean Default: false Whether the result should contain in-active records

Responses

/api/aml/parameter/aggregateTransactionCount

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "accountUsageType": "PortfolioManagement",
  • "minCount": 0,
  • "maxCount": 0,
  • "isActive": true,
  • "riskFactor": 0,
  • "isBanned": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Create AMLParameterAggregateTransactionCount

Creates a new AMLParameterAggregateTransactionCount

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterAggregateTransactionCountBase

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minCount required	integer <int32> Minimum count that this parameter risk factor is effective for the transaction
maxCount	integer or null <int32> Maximum count that this parameter risk factor is effective for the transaction
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/aggregateTransactionCount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minCount": 0,
• "maxCount": 0,
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLParameterAggregateTransactionCount details by the given input

Updates AMLParameterAggregateTransactionCount details by the given input

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterAggregateTransactionCount to update

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

AMLParameterAggregateTransactionCount base info to update

accountUsageType required	string Enum: "PortfolioManagement" "Brokerage" Account Usage Type for the transaction. "Portfolio Management" or "Brokerage"
minCount required	integer <int32> Minimum count that this parameter risk factor is effective for the transaction
maxCount	integer or null <int32> Maximum count that this parameter risk factor is effective for the transaction
isActive required	boolean There can only 1 Active record for the same AccountUsageType.
riskFactor	integer <int32> Risk factor associated for this record, between 1 and 10. You can use very high values such as 100.
isBanned	boolean Whether this record should be banned/cancelled/dis-allowed/prohibited from that transaction whatever the risk factor is. If this is true, then, even if the risk factor is 1, this action of customer should be banned/cancelled/dis-allowed/prohibited.

Responses

/api/aml/parameter/aggregateTransactionCount/{recordId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountUsageType": "PortfolioManagement",
• "minCount": 0,
• "maxCount": 0,
• "isActive": true,
• "riskFactor": 0,
• "isBanned": true

}

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Make AMLParameterAggregateTransactionCount in-active

De-Activates AMLParameterAggregateTransactionCount

Authorizations:

BearerOpenIdConnect

path Parameters

recordId required

string <uuid> Id of the AMLParameterAggregateTransactionCount to make in-active

Responses

/api/aml/parameter/aggregateTransactionCount/{recordId}/isActive/false

Response samples

• 200
• 400
• 413
• 422
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

List of AMLCustomerRiskFactorCalculationDailyRecords for a client within the given date-time frame.

Return a list of List of AMLCustomerRiskFactorCalculationDailyRecords for a client within the given date-time frame.

1. Time frame can not be more than 14 days.
2. If no startDate or endDate provided, then, only last record is returned if there is any

Authorizations:

BearerOpenIdConnect

query Parameters

customerId	string <uuid> Customer Id
startDate	string <date-time> First Creation Date (optional)
endDate	string <date-time> Last Creation Date (optional)

Responses

/api/aml/record/customerRiskFactorDailyRecord

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "clientKey": "Example Client Key",
  • "clientName": "Max",
  • "clientSurname": "Mustermann",
  • "clientType": "Business",
  • "countryOfOrigin": "DEU",
  • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
  • "bankAccountCountry": "DEU",
  • "bankAccountIban": "DE30000000000000000108",
  • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
  • "occupationGroup": "Other",
  • "sectorCode": "string",
  • "cashBalance": 0,
  • "averageRisk": 0,
  • "hasActiveAMLMonitoringHit": true

  }

]

List of AMLCustomerRiskFactorCalculationDailyRecords based on several filters

Return a list of List of AMLCustomerRiskFactorCalculationDailyRecords based on several filters

Authorizations:

BearerOpenIdConnect

query Parameters

statuses	string Comma separated AMLCustomerActionEvaluationStatus values to filter
clientId	string <uuid> Optional client Id
clientKey	string Optional client key
reconciliationGuid	string <uuid> Optional reconciliation Id
internalAccountWithdrawalRequestId	string <uuid> Optional InternalAccount Withdrawal Request Id
internalAccountId	string <uuid> Optional InternalAccount Id
bankAccountId	string <uuid> Optional BankAccount Id
dateBegin	string <date-time> Optional begin filter for CreatedDate
dateEnd	string <date-time> Optional end filter for CreatedDate
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List

Responses

/api/aml/record/customerActionRiskFactorEvaluationRecord

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "clientKey": "Example Client Key",
  • "clientName": "Max",
  • "clientSurname": "Mustermann",
  • "clientType": "Business",
  • "countryOfOrigin": "DEU",
  • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
  • "bankAccountCountry": "DEU",
  • "bankAccountIban": "DE30000000000000000108",
  • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
  • "occupationGroup": "Other",
  • "sectorCode": "string",
  • "cashBalance": 0,
  • "averageRisk": 0,
  • "hasActiveAMLMonitoringHit": true

  }

]

Update AMLCustomerActionRiskFactorEvaluationRecord status in order to allow client action, or deny because it is found risky in terms of AML If approved, then the action will be completed. If denied, then the action is rejected and not completed.

Updates the status of the AMLCustomerActionRiskFactorEvaluationRecord in order to allow client action, or deny because it is found risky in terms of AML

Authorizations:

BearerOpenIdConnect

path Parameters

id required

string <uuid> Id of the record

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

New Status, Reason and Note for the record

newStatus	string Enum: "Waiting" "Approved" "Denied"
reason	string or null
note	string or null

Responses

/api/aml/record/customerActionRiskFactorEvaluationRecord/{id}/status

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "newStatus": "Waiting",
• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update AMLCustomerActionRiskFactorEvaluationRecord reason and note

Update the reason and note of the AMLCustomerActionRiskFactorEvaluationRecord

Authorizations:

BearerOpenIdConnect

path Parameters

id required

string <uuid> Id of the record

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Note and Reason

reason	string or null
note	string or null

Responses

/api/aml/record/customerActionRiskFactorEvaluationRecord/{id}/reasonAndNote

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "reason": "string",
• "note": "string"

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "clientKey": "Example Client Key",
• "clientName": "Max",
• "clientSurname": "Mustermann",
• "clientType": "Business",
• "transactionType": "Deposit",
• "reconciliationGuid": "33b02107-15a5-4154-b452-1725b95a04f7",
• "internalAccountWithdrawalRequestId": "4b7ed5e0-d5ec-492f-bf30-27e83cbdab07",
• "sepaDirectDebitExecutionId": "a7c8904e-5f74-4c42-a43d-457517e23435",
• "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
• "accountUsageType": "PortfolioManagement",
• "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
• "bankAccountIban": "DE30000000000000000108",
• "bankAccountCountry": "DEU",
• "amount": 0,
• "currencyCode": "str",
• "riskMessage": "string",
• "hasActivePEPRecord": true,
• "hasActiveSanctionRecord": true,
• "hasActiveOtherRecord": true,
• "isApprovalNeeded": true,
• "isBanned": true,
• "dateAction": "2019-08-24T14:15:22Z",
• "averageRisk": 0,
• "riskThresholdAcceptAutoBelow": 0,
• "riskThresholdRejectAutoAbove": 0,
• "dateDecision": "2019-08-24T14:15:22Z",
• "deciderUserId": "45e4dca1-8330-433c-8655-8093e7eb0848",
• "status": "Waiting",
• "processingStatus": "Waiting",
• "processingDateTime": "2019-08-24T14:15:22Z",
• "source": "UndefinedCase",
• "reason": "string",
• "note": "string",
• "processingResult": "string"

}

List of Most Risky Clients based on several filters

Return a list of Most Risky Clients based on several filters

Authorizations:

BearerOpenIdConnect

query Parameters

date	string <date-time> filter for CreatedDate
minAverageRisk	integer <int32> minimum average risk values to filter
maxAverageRisk	integer <int32> maximum average risk values to optional filter
minCashBalance	integer <int32> minimum cash balance values to optional filter
maxCashBalance	integer <int32> maximum cash balance values to optional filter
hasActiveAMLMonitoringHit	boolean Optional filter whether client has active Anti Money Laundering record
countryOfOrigin	string Optional filter for Country Of Origin
bankAccountCountry	string Optional filter for Bank Account Country
clientId	string Optional filter for Client Id
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List

Responses

/api/aml/record/mostRiskyClients

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "clientKey": "Example Client Key",
  • "clientName": "Max",
  • "clientSurname": "Mustermann",
  • "clientType": "Business",
  • "countryOfOrigin": "DEU",
  • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
  • "bankAccountCountry": "DEU",
  • "bankAccountIban": "DE30000000000000000108",
  • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
  • "occupationGroup": "Other",
  • "sectorCode": "string",
  • "cashBalance": 0,
  • "averageRisk": 0,
  • "hasActiveAMLMonitoringHit": true

  }

]

Get AML tenant general parameter record

Returns AML tenant general parameter record

Authorizations:

BearerOpenIdConnect

Responses

/api/aml/parameter/amlTenantParameter

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "amlOfficerEmail": "string",
• "riskThresholdAcceptAutoBelow": 0,
• "riskThresholdRejectAutoAbove": 0,
• "defaultPEPRiskFactor": 0,
• "defaultSanctionRiskFactor": 0,
• "defaultOtherRiskFactor": 0,
• "reason": "string",
• "note": "string",
• "saveAMLMonitoringResultsUnderClientDocs": true,
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Update AML tenant general parameter record

Updates the current AML tenant general parameter record

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

amlOfficerEmail required	string [ 1 .. 256 ] characters
riskThresholdAcceptAutoBelow	number <decimal> When Risk Factor value is EQUAL or LOWER than this value, then the operation is ACCEPTED automatically.
riskThresholdRejectAutoAbove	number <decimal> When Risk Factor value is HIGHER than this value, then the operation is REJECTED automatically.
defaultPEPRiskFactor	number <decimal> Default Risk Factor if the customer has a PEP AML record.
defaultSanctionRiskFactor	number <decimal> Default Risk Factor if the customer has a Sanction AML record.
defaultOtherRiskFactor	number <decimal> Default Risk Factor if the customer has a Other AML records such as Adverse Media, Legal Enforcement or Other.
reason	string or null <= 64 characters The reason if this customer should be screened or banned/cancelled for transactions.
note	string or null <= 128 characters Notes for this record for future referencing of other users
saveAMLMonitoringResultsUnderClientDocs	boolean When this parameter is true, AML monitoring reports will be saved to the client documents.
tenantId required	string <uuid>
createdDate	string <date-time> When this record is created
updatedDate	string or null <date-time> When this record is updated
createdUserId	string or null <uuid> Whe user Id who created this record
updatedUserId	string or null <uuid> Whe user Id who updated this record

Responses

/api/aml/parameter/amlTenantParameter

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "amlOfficerEmail": "string",
• "riskThresholdAcceptAutoBelow": 0,
• "riskThresholdRejectAutoAbove": 0,
• "defaultPEPRiskFactor": 0,
• "defaultSanctionRiskFactor": 0,
• "defaultOtherRiskFactor": 0,
• "reason": "string",
• "note": "string",
• "saveAMLMonitoringResultsUnderClientDocs": true,
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "amlOfficerEmail": "string",
• "riskThresholdAcceptAutoBelow": 0,
• "riskThresholdRejectAutoAbove": 0,
• "defaultPEPRiskFactor": 0,
• "defaultSanctionRiskFactor": 0,
• "defaultOtherRiskFactor": 0,
• "reason": "string",
• "note": "string",
• "saveAMLMonitoringResultsUnderClientDocs": true,
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get money laundering indicator of a customer

Returns money laundering indicator of a particular customer (client) that belong to the same tenant

Authorizations:

BearerOpenIdConnect

path Parameters

customerId required

string <uuid>

Responses

/api/aml/customer/{customerId}/moneyLaunderingIndicator

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "amlOfficerEmail": "string",
• "riskThresholdAcceptAutoBelow": 0,
• "riskThresholdRejectAutoAbove": 0,
• "defaultPEPRiskFactor": 0,
• "defaultSanctionRiskFactor": 0,
• "defaultOtherRiskFactor": 0,
• "reason": "string",
• "note": "string",
• "saveAMLMonitoringResultsUnderClientDocs": true,
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Send customer to AML monitoring

Manually send given customer to monitoring

Authorizations:

BearerOpenIdConnect

path Parameters

customerId required

string <uuid>

Responses

/api/aml/{customerId}/sendAmlMonitoring

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "string",
• "providerClientId": "string",
• "clientData": {

  • "person": {

    • "type": "string",
    • "name": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "nationality": "string",
    • "gender": "string",
    • "countryOfBirth": "string",
    • "placeOfBirth": "string",
    • "birthDate": "string"

    },
  • "address": {

    • "street": "string",
    • "streetNumberPrefix": "string",
    • "streetNumber": "string",
    • "streetNumberSuffix": "string",
    • "secondAddressLine": "string",
    • "postalCode": "string",
    • "region": "string",
    • "city": "string",
    • "country": "string"

    },
  • "document": {

    • "documentNumber": "string"

    },
  • "contact": {

    • "email": "string",
    • "phone": "string",
    • "mobile": "string"

    }

  },
• "monitoringType": "None",
• "creationUtcDateTime": "2019-08-24T14:15:22Z",
• "updateUtcDateTime": "2019-08-24T14:15:22Z"

}

Refresh customer AML monitoring hits

Generate a request to refresh given customer AML monitoring hits.

Authorizations:

BearerOpenIdConnect

path Parameters

customerId required

string <uuid>

Responses

/api/aml/{customerId}/refreshAmlMonitoringHits

Response samples

• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get customer AML monitoring details

Returns the detail of the AML Monitoring of the customer

Authorizations:

BearerOpenIdConnect

path Parameters

customerId required

string <uuid>

Responses

/api/aml/{customerId}/amlMonitoring

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "providerClientId": "80d767c9-39e8-4194-a995-a1094160a927",
• "monitoringType": "None",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "lastRefreshDate": "2019-08-24T14:15:22Z"

}

BankAccount

Create new bank account

Creates a new bank account for the client(s) corresponding to bankAccountRequest

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Bank Account Request Informations

alias	string or null <= 70 characters Alias for the account.
clientIds	Array of strings or null <uuid> Owner(s) of the account. It may be a personal or joint account.
accountHolderName required	string [ 1 .. 70 ] characters Bank account holder name.
bankName required	string [ 1 .. 140 ] characters Name of the bank.
bic required	string [ 8 .. 11 ] characters The BIC code formatted as below: AAAA BB CC DDD First 4 characters - bank code (only uppercase letters) Next 2 characters - ISO 3166-1 alpha-2 country code(only uppercase letters) Next 2 characters - location code (uppercase letters and digits) (passive participant will have "1" in the second character) Last 3 characters - branch code, optional ('XXX' for primary office) (uppercase letters and digits)
sortCode	string or null <= 35 characters Sort code. (A.k.a: BLZ in Germany) Length may vary with source country. It is mandatory if account is not an IBAN mandatory country account
alpha3CountryCode required	string = 3 characters Country code in alpha3 format. It should be a valid country code. Otherwise service returns HTTP 400 (Bad Request) response.
currencyCode required	string = 3 characters Currency code of the bank account. It should be a valid currency code. Otherwise service returns HTTP 400 (Bad Request) response.
accountNumber	string or null <= 35 characters Account number of the bank account. It is mandatory if account is not an IBAN mandatory country account
iban	string or null <= 34 characters IBAN of the bank account. It is mandatory if account is an IBAN mandatory country account It should comply the iban rules if it it mandatory. Otherwise service returns HTTP 400 (Bad Request) response.

Responses

/api/bankAccount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "alias": "SomeAliasForThisAccount",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "accountHolderName": "Max Mustermann",
• "bankName": "Deutsche Bank",
• "bic": "DEUTDEFFXXX",
• "sortCode": "00000000",
• "alpha3CountryCode": "DEU",
• "currencyCode": "EUR",
• "accountNumber": "0000000089",
• "iban": "DE30000000000000000108"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "accountHolderName": "Max Mustermann",
• "bankName": "Deutsche Bank",
• "bic": "DEUTDEFFXXX",
• "sortCode": "00000000",
• "alpha3CountryCode": "DEU",
• "currencyCode": "EUR",
• "accountNumber": "0000000089",
• "iban": "DE30000000000000000108",
• "status": "Active",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Get list of bank accounts

Returns the corresponding bank accounts with the given criteria. At least one of the following parameters should be sent:

• accountId
• iban
• accountNumber
• dateTimeStart/dateTimeEnd

Authorizations:

BearerOpenIdConnect

query Parameters

clientId	string <uuid> Client Id
accountId	string <uuid> Bank Account Id
iban	string Example: iban=DE30000000000000000108 IBAN of the Bank Account
accountHolderName	string Example: accountHolderName=Max Mustermann Account Holder Name of the Bank Account
accountNumber	string Example: accountNumber=0000000089 Account Number of the Bank Account
accountStatuses	string Example: accountStatuses=Initial, Active Account Statuses of the Bank Account
dateTimeStart	string <date-time> Example: dateTimeStart=2023-01-14T13:46:27.975Z Bank Account Creation Date-Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2023-01-23T13:46:27.975Z Bank Account Creation Date-End
createdUserId	string <uuid> Bank Account Create User
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/bankAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "accountHolderName": "Max Mustermann",
    • "bankName": "Deutsche Bank",
    • "bic": "DEUTDEFFXXX",
    • "sortCode": "00000000",
    • "alpha3CountryCode": "DEU",
    • "currencyCode": "EUR",
    • "accountNumber": "0000000089",
    • "iban": "DE30000000000000000108",
    • "status": "Active",
    • "clientIds": [

      • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ]

}

Update bank account status

Updates the status of client bank account with initial,active,suspended or deleted

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Account Status Request

status required	string Enum: "Initial" "Active" "Suspended" "Deleted" "Closed" "InClosure" Requested status of the account.
closeOrDeleteReason	string or null <= 512 characters Account close or delete reason. Free format.Not required. Max length 512

Responses

/api/bankAccount/{bankAccountId}/status

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "status": "Active",
• "closeOrDeleteReason": "string"

}

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Add document

Adds the bank account related documents one by one

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Uploaded document informations

contentType	string Enum: "Unknown" "Image_Jpeg" "Image_Bmp" "Image_Png" "Application_Pdf" "Application_Docx" "Application_Doc" "Text_Plain" "Other"
fileData	string or null <binary> File data in binary format (ie: hex string with 0x prefix)
label	string or null <= 256 characters Document Label
comment	string or null <= 1024 characters Document Comment
documentType	string Enum: "Unknown" "NationalId" "Passport" "DriversLicense" "CompanyRegistrationCertificate" "TaxPlate" "AuthorizedSignatureCircular" "AddressCertificate" "Bill" "SepaDirectDebitMandate" "DivorceCertificate" "MarriageCertificate" "DeathCertificateOfTheSpouse" "CertificateOfIncumbency" "AMLHitReport" "FourthlineCDDReport" "FourthlineSignedDocument"
fileName	string or null <= 256 characters Uploaded file name
validFrom	string or null <date> = 10 characters Date from which this document is valid
validUntil	string or null <date> = 10 characters Date until this document is valid

Responses

/api/bankAccount/{bankAccountId}/document

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6...",
• "label": "A document",
• "comment": "Some information about this document",
• "documentType": "Unknown",
• "fileName": "file_name.jpg",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31"

}

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Remove document

Removes the given document

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id
documentId required	string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Id of the document

Responses

/api/bankAccount/{bankAccountId}/document/{documentId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get a bank account document

Returns the corresponding bank account document with the given document id.

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id
documentId required	string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Document Id

Responses

/api/bankAccount/{bankAccountId}/document/{documentId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6..."

}

Validate bank account

Validates the given bank account

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Bank Account Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Validation Informations

validationMethod	string Enum: "None" "Manual" "OnlineBanking" "KYCProvider" "RemoteCall" Validation method for the bank account.
validated	boolean
validationDate	string or null <date-time> Validation date of the bank account.

Responses

/api/bankAccount/{bankAccountId}/validate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "validationMethod": "OnlineBanking",
• "validated": true,
• "validationDate": "2023-01-14T10:52:36.022Z"

}

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get a bank account

Returns the corresponding bank account with the given bank account id.

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id

Responses

/api/bankAccount/{bankAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "accountHolderName": "Max Mustermann",
• "bankName": "Deutsche Bank",
• "bic": "DEUTDEFFXXX",
• "sortCode": "00000000",
• "alpha3CountryCode": "DEU",
• "currencyCode": "EUR",
• "accountNumber": "0000000089",
• "iban": "DE30000000000000000108",
• "status": "Active",
• "bankAccountValidation": {

  • "validationMethod": "OnlineBanking",
  • "validated": true,
  • "validationDate": "2023-01-14T10:52:36.022Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "validationUserId": "12bfa91b-1840-42a3-aa23-3370cc3e0709",
  • "uploadedDocuments": [

    • {

      • "contentType": "Image_Bmp",
      • "fileData": "0x646174613A696D6...",
      • "label": "A document",
      • "comment": "Some information about this document",
      • "documentType": "Unknown",
      • "fileName": "file_name.jpg",
      • "validFrom": "2023-01-01",
      • "validUntil": "2023-12-31",
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

      }

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  },
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get a bank account validation

Returns the corresponding bank account validation with the given bank account id.

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Example: 76AB1DAA-9A64-4DD4-86CD-08D9F1E30EB0 Bank Account Id

Responses

/api/bankAccount/{bankAccountId}/validation

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "validationMethod": "OnlineBanking",
• "validated": true,
• "validationDate": "2023-01-14T10:52:36.022Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "validationUserId": "12bfa91b-1840-42a3-aa23-3370cc3e0709",
• "uploadedDocuments": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Client

List clients

Return a list of clients based on several filters

Authorizations:

BearerOpenIdConnect

query Parameters

tenantId	string <uuid> Tenant Id
clientType	string Enum: "Business" "Retail" Type of Client
status	string Enum: "Initial" "Onboarded" "Suspended" "Deleted" "External" "Rejected" Client Status
name	string Example: name=Max Name
surname	string Example: surname=Mustermann Surname
email	string Example: email=mail@somedomain.com Email
alpha3CountryCode	string Example: alpha3CountryCode=DEU Country Code
dateTimeBegin	string <date-time> Example: dateTimeBegin=2022-07-14T13:46:27.975Z Create Date - Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2022-12-14T13:46:27.975Z Create Date - End
contractualPartnerCode	string Example: contractualPartnerCode=CP0001 Contractual Partner Code
clientKey	string Example: clientKey=JFD00242 Externally managed unique customer identifier
clientId	string <uuid> Client Id
clientSubType	string Enum: "Regular" "DesignatedSponsor" "TenantOwnerClient" Sub type of the client
maritalStatuses	string Example: maritalStatuses=Single, Married Marital statuses of the client
taxId	string Example: taxId=VAT1234567890 Tax identification number of the client
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List

Responses

/api/client

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ]

}

Create client

Creates a new client

Authorizations:

BearerOpenIdConnect

query Parameters

createUserIdentity	boolean Default: false Create Identity User Flag
createExternalClient	boolean Default: false Identifies if client will be external or not

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Client request

clientKey required	string [ 1 .. 36 ] characters Externally managed unique customer identifier. Required for all clients.
name required	string [ 1 .. 256 ] characters For business clients, used to define company Name For retail clients, Name of the person (First, second, third and more names if present)
surname	string or null <= 256 characters Surname (Family name of the person) Only required for retail clients
email	string or null <email> <= 320 characters Should be unique in between different clients due to dependency at the identity server part where email is a unique identifier for users Optional for External Clients while required for all remaining
countryOfOrigin required	string = 3 characters Alpha 3 Country Code Format For Legal Entitites: Established Country For Real Person: Country of Birth
nationality	string or null = 3 characters Alpha 3 Country Code Format Only applicable to retail clients
dateOfBirth	string or null <date> = 10 characters Only applicable for retail clients
placeOfBirth	string or null <= 35 characters Only applicable for retail clients
maritalStatus	string or null Enum: "Single" "Married" "RegisteredCivilPartnership" "Divorced" "Widowed" "SeparateLiving" "Unknown" Marital status of the natural person Only applicable for retail clients Default value is 'Unknown' if field is not provided during retail client creation
establishedDate	string or null <date> = 10 characters Only applicable for business clients
clientType required	string Enum: "Business" "Retail"
riskClass	string or null Enum: "Low" "MediumLow" "Medium" "MediumHigh" "High" Only applicable for retail clients REMARK: clients can overrule their risk class assignment for a single trade For other client types set to RiskClasses.High as default
clientLEI	string or null = 20 characters ^[A-Z0-9]{18}[0-9]{2}$ Required field for non-retail clients for Mifir Reporting purposes. Only applicable for business client type. For other types it should be empty/null.
identityNumberType	string or null Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber" Holds type of identity number used to define client REMARK: Should be always set to BusinessRegistrationNumber for business entities
identityNumber	string or null <= 50 characters Holds country wise identity number of the client. ie: Passport No, Business Registration, etc
liableToTax	boolean Applicable to all client types
federalState	string or null <enum> <= 35 characters Enum: "DE-HE" "DE-SH" "DE-BW" "DE-BY" "DE-SL" "DE-BE" "DE-RP" "DE-HB" "DE-MV" "DE-NI" "DE-TH" "DE-SN" "DE-ST" "DE-NW" "DE-BB" "DE-HH" The federal state of the client full list is available on federalStates helper endpoint
birthName	string or null <= 256 characters Only applicable to retail clients
title	string or null <= 128 characters Only applicable to retail clients
gender	string or null Enum: "Unspecified" "Male" "Female" "Other" "Undisclosed" Gender of the client. Only applicable to retail clients
salutation	string or null <= 128 characters Only applicable to retail clients
language	string or null Enum: "de_DE" "en_US" Preferred Communication language
communicationWithPostAllowed required	boolean Indicates that if client prefers to communication with post applicable to all clients
communicationWithEmailAllowed required	boolean Indicates that if client prefers to communication with email applicable to all clients
communicationWithPhoneAllowed required	boolean Indicates that if client prefers to communication with phone applicable to all clients
contractualPartnerCode required	string = 6 characters Client's contractual partner code.
occupationGroup	string or null Enum: "Other" "PupilOrStudent" "Pensioner" Occupation group code of the client. Applicable for the Retail clients

Responses

/api/client

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "clientKey": "ExampleClientKey",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "GERMANY",
• "maritalStatus": "Married",
• "establishedDate": "2017-11-03",
• "clientType": "Business",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "liableToTax": true,
• "federalState": "DE-HE",
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other"

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Get client

Returns client details by its id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

query Parameters

includePhoneNumbers	boolean Default: false Include PhoneNumbers at the response
includeAddresses	boolean Default: false Include Addresses at the response
includeTaxIdentifiers	boolean Default: false Include TaxIdentifiers at the response
includeChurchTaxInformation	boolean Default: false Include ChurchTaxInformation at the response

Responses

/api/client/{clientId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
• "users": [

  • {

    • "userName": "mail@somedomain.com",
    • "assignmentDate": "2023-01-21T12:28:21.612Z",
    • "assignmentUserId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

    }

  ],
• "phoneNumbers": [

  • {

    • "alpha3CountryCode": "DEU",
    • "number": "+905054545",
    • "extension": "136",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "addresses": [

  • {

    • "addressName": "My home Frankfurt",
    • "street": "Some street at Frankfurt",
    • "buildingIdentifier": "Katoni Palace",
    • "suiteIdentifier": "17",
    • "floorIdentifier": "3",
    • "districtName": "Some District at frankfurt",
    • "postBox": "Frankfurt",
    • "postCode": "65343",
    • "city": "Frankfurt",
    • "countrySubentity": "Kansas",
    • "alpha3CountryCode": "DEU",
    • "addressType": "InvoicingAddress",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "recordState": "Inactive",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "taxIdentifiers": [

  • {

    • "tin": "VAT1234567890",
    • "alpha3CountryCode": "DEU",
    • "type": "TaxNumber",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "validation": {

  • "validationMethod": "Manual",
  • "validated": true,
  • "validationDate": "2023-01-13T00:11:11.276Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "validationUserId": "12bfa91b-1840-42a3-aa23-3370cc3e0709",
  • "uploadedDocuments": [

    • {

      • "contentType": "Image_Bmp",
      • "fileData": "0x646174613A696D6...",
      • "label": "A document",
      • "comment": "Some information about this document",
      • "documentType": "Unknown",
      • "fileName": "file_name.jpg",
      • "validFrom": "2023-01-01",
      • "validUntil": "2023-12-31",
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
      • "updatedDate": "2019-08-24T14:15:22Z",
      • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

      }

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  },
• "employmentInformations": [

  • {

    • "sectionCode": "S",
    • "sectionInformation": "ERBRINGUNG VON SONSTIGEN DIENSTLEISTUNGEN",
    • "divisionCode": "01.11.0",
    • "divisionInformation": "Interessenvertretungen",
    • "jobTitle": "Engineer",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "averageAnnualIncome": 0,
    • "currencyCode": "EUR",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "investmentDecisionMakers": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "scope": "BusinessClient",
    • "concatCode": "string",
    • "shortCode": "string",
    • "name": "string",
    • "surname": "string",
    • "countryCode": "DE",
    • "dateOfBirth": "1970-01-01",
    • "email": "user@example.com",
    • "isDefault": true,
    • "isActive": true,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "churchTaxInformation": {

  • "subjectToChurchTax": true,
  • "religiousCommunityId": "010600",
  • "religiousCommunityName": "Evangelische Landeskirche Anhalts",
  • "churchTaxRateValidFrom": "2023-01-01",
  • "churchTaxRate": 0.08

  },
• "isWaitingApprove": true

}

Update client

Updates client details by its id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Client Update Request

name required	string [ 1 .. 256 ] characters For business clients, used to define company Name For retail clients, Name of the person (First, second, third and more names if present)
surname	string or null <= 256 characters Surname (Family name of the person) Only required for retail clients
countryOfOrigin required	string = 3 characters Alpha 3 Country Code Format For Legal Entitites: Established Country For Real Person: Country of Birth
nationality	string or null = 3 characters Alpha 3 Country Code Format Only applicable to retail clients
dateOfBirth	string or null <date> = 10 characters Only applicable for retail clients
placeOfBirth	string or null <= 35 characters Only applicable for retail clients
maritalStatus	string or null Enum: "Single" "Married" "RegisteredCivilPartnership" "Divorced" "Widowed" "SeparateLiving" "Unknown" Marital status of the natural person Only applicable for retail clients Default value is 'Unknown' if field is not provided during retail client update
establishedDate	string or null <date> = 10 characters Only applicable for business clients
riskClass	string or null Enum: "Low" "MediumLow" "Medium" "MediumHigh" "High" Only applicable for retail clients REMARK: clients can overrule their risk class assignment for a single trade For other client types set to RiskClasses.High as default
clientLEI	string or null = 20 characters ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}$ Required field for non-retail clients for Mifir Reporting purposes. Only applicable for business client type. For other types it should be empty/null.
identityNumberType	string or null Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber" Holds type of identity number used to define client REMARK: Should be always set to BusinessRegistrationNumber for business entities
identityNumber	string or null <= 50 characters Holds country wise identity number of the client. ie: Passport No, Business Registration, etc
liableToTax	boolean or null Applicable to all client types
federalState	string or null <enum> <= 35 characters Enum: "DE-HE" "DE-SH" "DE-BW" "DE-BY" "DE-SL" "DE-BE" "DE-RP" "DE-HB" "DE-MV" "DE-NI" "DE-TH" "DE-SN" "DE-ST" "DE-NW" "DE-BB" "DE-HH" The federal state of the client full list is available on federalStates helper endpoint
birthName	string or null <= 256 characters Only applicable to retail clients
title	string or null <= 128 characters Only applicable to retail clients
gender	string or null Enum: "Unspecified" "Male" "Female" "Other" "Undisclosed" Gender of the client. Only applicable to retail clients
salutation	string or null <= 128 characters Only applicable to retail clients
language	string or null Enum: "de_DE" "en_US" Preferred Communication language
communicationWithPostAllowed required	boolean Indicates that if client prefers to communication with post applicable to all clients
communicationWithEmailAllowed required	boolean Indicates that if client prefers to communication with email applicable to all clients
communicationWithPhoneAllowed required	boolean Indicates that if client prefers to communication with phone applicable to all clients
occupationGroup	string or null Enum: "Other" "PupilOrStudent" "Pensioner" Occupation group code of the client. Applicable for the Retail clients

Responses

/api/client/{clientId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "name": "Max",
• "surname": "Mustermann",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "GERMANY",
• "maritalStatus": "Married",
• "establishedDate": "2017-11-03",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "liableToTax": true,
• "federalState": "DE-HE",
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "occupationGroup": "Other"

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update client email

Updates the email of the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

query Parameters

email

string Email

Responses

/api/client/{clientId}/email

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update client occupation group

Updates the occupation group of the client. Applicable only for Retail clients.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

query Parameters

occupationGroup

string Enum: "Other" "PupilOrStudent" "Pensioner" Occupation Group to set

Responses

/api/client/{clientId}/occupationGroup

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Upload client document

Uploads a document like passport or certificate to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Document Informations

contentType	string Enum: "Unknown" "Image_Jpeg" "Image_Bmp" "Image_Png" "Application_Pdf" "Application_Docx" "Application_Doc" "Text_Plain" "Other"
fileData	string or null <binary> File data in binary format (ie: hex string with 0x prefix)
label	string or null <= 256 characters Document Label
comment	string or null <= 1024 characters Document Comment
documentType	string Enum: "Unknown" "NationalId" "Passport" "DriversLicense" "CompanyRegistrationCertificate" "TaxPlate" "AuthorizedSignatureCircular" "AddressCertificate" "Bill" "SepaDirectDebitMandate" "DivorceCertificate" "MarriageCertificate" "DeathCertificateOfTheSpouse" "CertificateOfIncumbency" "AMLHitReport" "FourthlineCDDReport" "FourthlineSignedDocument"
fileName	string or null <= 256 characters Uploaded file name
validFrom	string or null <date> = 10 characters Date from which this document is valid
validUntil	string or null <date> = 10 characters Date until this document is valid

Responses

/api/client/{clientId}/document

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6...",
• "label": "A document",
• "comment": "Some information about this document",
• "documentType": "Unknown",
• "fileName": "file_name.jpg",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6...",
• "label": "A document",
• "comment": "Some information about this document",
• "documentType": "Unknown",
• "fileName": "file_name.jpg",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List client documents

Lists the uploaded documents under a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/document

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Delete client document

Deletes specified document from the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
documentId required	string <uuid> Document Id

Responses

/api/client/{clientId}/document/{documentId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get client document file

Get the uploaded document file under a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
documentId required	string <uuid> Document Id

Responses

/api/client/{clientId}/document/{documentId}/file

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6..."

}

List client bank accounts

Lists the bank accounts of a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/bankAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountHolderName": "Max Mustermann",
  • "bankName": "Deutsche Bank",
  • "bic": "DEUTDEFFXXX",
  • "sortCode": "00000000",
  • "alpha3CountryCode": "DEU",
  • "currencyCode": "EUR",
  • "accountNumber": "0000000089",
  • "iban": "DE30000000000000000108",
  • "status": "Active",
  • "clientIds": [

    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z"

  }

]

Get client bank account

Returns the bank account of a client with the given account id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
bankAccountId required	string <uuid> Bank Account Id

Responses

/api/client/{clientId}/bankAccount/{bankAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "accountHolderName": "Max Mustermann",
• "bankName": "Deutsche Bank",
• "bic": "DEUTDEFFXXX",
• "sortCode": "00000000",
• "alpha3CountryCode": "DEU",
• "currencyCode": "EUR",
• "accountNumber": "0000000089",
• "iban": "DE30000000000000000108",
• "status": "Active",
• "bankAccountValidation": {

  • "validationMethod": "OnlineBanking",
  • "validated": true,
  • "validationDate": "2023-01-14T10:52:36.022Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "validationUserId": "12bfa91b-1840-42a3-aa23-3370cc3e0709",
  • "uploadedDocuments": [

    • {

      • "contentType": "Image_Bmp",
      • "fileData": "0x646174613A696D6...",
      • "label": "A document",
      • "comment": "Some information about this document",
      • "documentType": "Unknown",
      • "fileName": "file_name.jpg",
      • "validFrom": "2023-01-01",
      • "validUntil": "2023-12-31",
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

      }

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  },
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List client internal accounts

Lists the internal accounts of a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/internalAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "alias": "ExampleAlias",
  • "currencyCode": "EUR",
  • "dispositionLimit": 12.34,
  • "blockedAmount": 12.34,
  • "status": "Active",
  • "iban": "DE30000000000000000108",
  • "bic": "DEUTDEFFXXX",
  • "accountNumber": "00000089",
  • "sortCode": "00000000",
  • "accountUsageType": "PortfolioManagement",
  • "accountScope": "Customer",
  • "clientIds": [

    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z"

  }

]

Get client internal account

Returns the internal account of a client with the given account id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
internalAccountId required	string <uuid> Internal Account Id

Responses

/api/client/{clientId}/internalAccount/{internalAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alias": "Example alias",
• "currencyCode": "EUR",
• "dispositionLimit": 12.34,
• "blockedAmount": 12.34,
• "externalBlockedAmount": 12.34,
• "status": "Initial",
• "iban": "DE30000000000000000108",
• "bic": "DEUTDEFFXXX",
• "accountNumber": "00000089",
• "sortCode": "00000000",
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List client deposit accounts

Lists the deposit accounts of a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/depositAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "alias": "Example alias",
  • "status": "Active",
  • "accountNumber": "000000089",
  • "sortCode": "00000000",
  • "accountUsageType": "PortfolioManagement",
  • "accountScope": "Customer",
  • "clientIds": [

    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z"

  }

]

Return client deposit account

Returns the deposit account of a client with the given account id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
depositAccountId required	string <uuid> Deposit Account Id

Responses

/api/client/{clientId}/depositAccount/{depositAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alias": "Example Alias",
• "status": "Initial",
• "accountNumber": "000000089",
• "sortCode": "00000000",
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List authorized people under a client

Returns a list of authorized people belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/authorizedPeople

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "photo": "0x646174613A696D6...",
  • "authorizedPersonType": "AuthorizedSignatory",
  • "name": "Max",
  • "surname": "Mustermann",
  • "email": "mail@somedomain.com",
  • "identityNumberType": "NotSet",
  • "identityNumber": "456789012345abc",
  • "certificateOfIncumbency": {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
    • "createdDate": "2023-01-03T19:53:43.617Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

    },
  • "countryOfOrigin": "DEU",
  • "countryOfResidence": "DEU",
  • "memo": "string",
  • "isUserCreate": false,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

  }

]

Create an authorized person

Creates a new authorized person under a client if a valid authorized person object given

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Authorized Person Properties

photo	string or null <byte> Binary[] formatted Authorized Person photo
authorizedPersonType	string Value: "AuthorizedSignatory"
name	string or null Name of the authorized person
surname	string or null Surname of the authorized person
email required	string <email> [ 1 .. 320 ] characters Mail of the authorized person
identityNumberType	string Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber"
identityNumber	string or null <= 50 characters Holds country wise identity number of the client. ie: Passport No, Business Registration, etc
	object (CertificateOfIncumbency)
countryOfOrigin required	string = 3 characters Alpha 3 Country Code Format
countryOfResidence required	string = 3 characters Alpha 3 Country Code Format
memo required	string non-empty
isUserCreate	boolean

Responses

/api/client/{clientId}/authorizedPeople

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Get an authorized person under a client

Returns the authorized person under a client with the given authorized person id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
authorizedPersonId required	string <uuid> Authorized Person Id

Responses

/api/client/{clientId}/authorizedPeople/{authorizedPersonId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Delete an authorized person

Deletes an authorized person under a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
authorizedPersonId required	string <uuid> Authorized Person Id

Responses

/api/client/{clientId}/authorizedPeople/{authorizedPersonId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Update authorized person

An authorized person data under a client is update with a new authorized person object

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
authorizedPersonId required	string <uuid> Authorized Person Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Authorized Person Properties

photo	string or null <byte> Binary[] formatted Authorized Person photo
authorizedPersonType	string Value: "AuthorizedSignatory"
name	string or null Name of the authorized person
surname	string or null Surname of the authorized person
email required	string <email> [ 1 .. 320 ] characters Mail of the authorized person
identityNumberType	string Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber"
identityNumber	string or null <= 50 characters Holds country wise identity number of the client. ie: Passport No, Business Registration, etc
	object (CertificateOfIncumbency)
countryOfOrigin required	string = 3 characters Alpha 3 Country Code Format
countryOfResidence required	string = 3 characters Alpha 3 Country Code Format
memo required	string non-empty
isUserCreate	boolean

Responses

/api/client/{clientId}/authorizedPeople/{authorizedPersonId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "authorizedPersonType": "AuthorizedSignatory",
• "name": "Max",
• "surname": "Mustermann",
• "email": "mail@somedomain.com",
• "identityNumberType": "NotSet",
• "identityNumber": "456789012345abc",
• "certificateOfIncumbency": {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorizedPersonId": "39918200-7616-4545-9070-27c91b874951",
  • "createdDate": "2023-01-03T19:53:43.617Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  },
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "isUserCreate": false,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Get an authorized person document under a client

Returns the authorized person document under a client with the given authorized person id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
authorizedPersonId required	string <uuid> Authorized Person Id

Responses

/api/client/{clientId}/authorizedPeople/{authorizedPersonId}/document

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6..."

}

Add new phone number

Adds new phone number for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Phone Number Properties

alpha3CountryCode	string or null <= 3 characters Alpha 3 Country Code Format
number	string or null <= 35 characters
extension	string or null <= 35 characters

Responses

/api/client/{clientId}/phoneNumber

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "alpha3CountryCode": "DEU",
• "number": "+905054545",
• "extension": "136"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alpha3CountryCode": "DEU",
• "number": "+905054545",
• "extension": "136",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List phone numbers of a client

Returns a list of phone numbers belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/phoneNumber

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "alpha3CountryCode": "DEU",
  • "number": "+905054545",
  • "extension": "136",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Remove phone number

Removes existing phone number from the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
phoneNumberId required	string <uuid> Phone Number Id

Responses

/api/client/{clientId}/phoneNumber/{phoneNumberId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Update phone number

Updates existing phone number under the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
phoneNumberId required	string <uuid> Phone Number Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Phone Number Properties

alpha3CountryCode	string or null <= 3 characters Alpha 3 Country Code Format
number	string or null <= 35 characters
extension	string or null <= 35 characters

Responses

/api/client/{clientId}/phoneNumber/{phoneNumberId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "alpha3CountryCode": "DEU",
• "number": "+905054545",
• "extension": "136"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alpha3CountryCode": "DEU",
• "number": "+905054545",
• "extension": "136",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get phone number

Returns the phone number of a client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
phoneNumberId required	string <uuid> Phone Number Id

Responses

/api/client/{clientId}/phoneNumber/{phoneNumberId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alpha3CountryCode": "DEU",
• "number": "+905054545",
• "extension": "136",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Add new address

Adds new address for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Address Properties

addressName	string or null <= 70 characters
street	string or null <= 80 characters
buildingIdentifier	string or null <= 30 characters
suiteIdentifier	string or null <= 10 characters
floorIdentifier	string or null <= 10 characters
districtName	string or null <= 80 characters
postBox	string or null <= 10 characters
postCode	string or null <= 12 characters
city required	string [ 1 .. 80 ] characters
countrySubentity	string or null <= 80 characters
alpha3CountryCode required	string = 3 characters Alpha 3 Country Code Format
addressType	string or null Enum: "ResidentialAddress" "DeliveryAddress" "InvoicingAddress" "TaxResidencyAddress" Type of the address

Responses

/api/client/{clientId}/address

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List client addresses

Returns a list of addresses belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

query Parameters

excludeInactive

boolean Default: false Exclude Inactive Records

Responses

/api/client/{clientId}/address

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "addressName": "My home Frankfurt",
  • "street": "Some street at Frankfurt",
  • "buildingIdentifier": "Katoni Palace",
  • "suiteIdentifier": "17",
  • "floorIdentifier": "3",
  • "districtName": "Some District at frankfurt",
  • "postBox": "Frankfurt",
  • "postCode": "65343",
  • "city": "Frankfurt",
  • "countrySubentity": "Kansas",
  • "alpha3CountryCode": "DEU",
  • "addressType": "InvoicingAddress",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "recordState": "Inactive",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Remove address

Removes existing address from the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
addressId required	string <uuid> Address Id

Responses

/api/client/{clientId}/address/{addressId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Update address

Updates existing address under the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
addressId required	string <uuid> Address Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Address Properties

addressName	string or null <= 70 characters
street	string or null <= 80 characters
buildingIdentifier	string or null <= 30 characters
suiteIdentifier	string or null <= 10 characters
floorIdentifier	string or null <= 10 characters
districtName	string or null <= 80 characters
postBox	string or null <= 10 characters
postCode	string or null <= 12 characters
city required	string [ 1 .. 80 ] characters
countrySubentity	string or null <= 80 characters
alpha3CountryCode required	string = 3 characters Alpha 3 Country Code Format
addressType	string or null Enum: "ResidentialAddress" "DeliveryAddress" "InvoicingAddress" "TaxResidencyAddress" Type of the address

Responses

/api/client/{clientId}/address/{addressId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get a spesific address of a a client

Returns the address of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
addressId required	string <uuid> Address Id

Responses

/api/client/{clientId}/address/{addressId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Update record state of an address

Updates record state of an address under the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
addressId required	string <uuid> Address Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Record State

string

Enum: "Inactive" "Active"

Responses

/api/client/{clientId}/address/{addressId}/state

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"Inactive"

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Set default bank account

Sets the default bank account of a client with the given bank account

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
bankAccountId required	string <uuid> Bank Account Id

Responses

/api/client/{clientId}/bankAccount/{bankAccountId}/default

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Set default internal account

Sets the default internal account of a client with the given internal account

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
internalAccountId required	string <uuid> Internal Account Id

Responses

/api/client/{clientId}/internalAccount/{internalAccountId}/default

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Set default deposit account

Sets the default deposit account of a client with the given deposit account

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
depositAccountId required	string <uuid> Deposit Account Id

Responses

/api/client/{clientId}/depositAccount/{depositAccountId}/default

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Add new tax identifier

Adds new tax identifier for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Tax Identifier Properties

tin required	string [ 1 .. 20 ] characters Tax identification number
alpha3CountryCode required	string = 3 characters Alpha 3 Country Code Format
type required	string Enum: "TaxId" "TaxNumber" "VATNumber" Type of the tax identifier. Should exist in TaxIdentifierType list.

Responses

/api/client/{clientId}/taxIdentifier

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "tin": "VAT1234567890",
• "alpha3CountryCode": "DEU",
• "type": "TaxNumber"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "tin": "VAT1234567890",
• "alpha3CountryCode": "DEU",
• "type": "TaxNumber",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List tax identifiers

Returns a list of tax identifiers belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/taxIdentifier

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "tin": "VAT1234567890",
  • "alpha3CountryCode": "DEU",
  • "type": "TaxNumber",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Remove tax identifier

Removes existing tax identifier from the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
taxIdentifierId required	string <uuid> Tax Identifier Id

Responses

/api/client/{clientId}/taxIdentifier/{taxIdentifierId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Update tax identifier

Updates existing tax identifier under the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
taxIdentifierId required	string <uuid> Tax Identifier Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Tax Identifier Properties

tin required	string [ 1 .. 20 ] characters Tax identification number
alpha3CountryCode required	string = 3 characters Alpha 3 Country Code Format
type required	string Enum: "TaxId" "TaxNumber" "VATNumber" Type of the tax identifier. Should exist in TaxIdentifierType list.

Responses

/api/client/{clientId}/taxIdentifier/{taxIdentifierId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "tin": "VAT1234567890",
• "alpha3CountryCode": "DEU",
• "type": "TaxNumber"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "tin": "VAT1234567890",
• "alpha3CountryCode": "DEU",
• "type": "TaxNumber",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get tax identifier

Returns the tax identifier of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
taxIdentifierId required	string <uuid> Tax Identifier Id

Responses

/api/client/{clientId}/taxIdentifier/{taxIdentifierId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "tin": "VAT1234567890",
• "alpha3CountryCode": "DEU",
• "type": "TaxNumber",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Validate client

Validates the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Validation Properties

validationMethod	string Enum: "None" "Manual" "OnlineBanking" "KYCProvider" "RemoteCall" Type of the validation method. Should exist in ValidationMethods list.
validated	boolean Current state of the validation. 'true' means validated.
validationDate	string or null <date-time> Date of time of last state change

Responses

/api/client/{clientId}/validate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "validationMethod": "Manual",
• "validated": true,
• "validationDate": "2023-01-13T00:11:11.276Z"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Update client status

Updates the status of the client with initial, onboarded, suspended or deleted

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

query Parameters

internalAccountUsageType	string Enum: "PortfolioManagement" "Brokerage" Example: internalAccountUsageType=PortfolioManagement Internal Account Usage Type
depositAccountUsageType	string Enum: "PortfolioManagement" "Brokerage" Example: depositAccountUsageType=PortfolioManagement Deposit Account Usage Type
createAccounts	boolean Default: false Create Internal and Deposit Account Flag

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Client Status

string

Enum: "Initial" "Onboarded" "Suspended" "Deleted" "External" "Rejected"

Responses

/api/client/{clientId}/status

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"Onboarded"

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Add new non-assessment certificate

Adds new non-assessment certificate for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Non-Assessment Certificate Request

type required	string Enum: "NaturalPerson" "LegalEntity" "LegalEntityWithPartialExemption" "LegalEntitySubCode35" "LegalEntitySubCode36" "LegalEntitySubCode37" '01' - natural persons (natürliche Personen) '02' - Körperschaften, Personenvereinigungen, Vermögensmassen '03' - unbeschränkt steuerpflichtige und nicht steuerbefreite Körperschaften, Personenvereinigungen, Vermögensmassen
validFrom required	string <date> = 10 characters Date from which the non-assessment certificate is valid; can only be 1st of January
validUntil required	string <date> = 10 characters Date until which the non-assessment certificate is valid; can only be 31st of December
externalIdentifier required	string [ 1 .. 25 ] characters External identifier of the non-assessment certificate (ie: NV-Nummer)

Responses

/api/client/{clientId}/nonAssessmentCertificate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "type": "NaturalPerson",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "externalIdentifier": "0123456789012345"

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "NaturalPerson",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "externalIdentifier": "0123456789012345",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

List non-assessment certificates

Returns a list of non-assessment certificates belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/nonAssessmentCertificate

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "type": "NaturalPerson",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "externalIdentifier": "0123456789012345",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

  }

]

Revoke non-assessment certificate

Revoke validUntil date of non-assessment certificate under the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
nonAssessmentCertificateId required	string <uuid> Non-Assessment Certificate Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

required

Non-Assessment Certificate Valid Until Date that can only be last day of the year

string

Responses

/api/client/{clientId}/nonAssessmentCertificate/{nonAssessmentCertificateId}/revoke

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"2022-12-31"

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "NaturalPerson",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "externalIdentifier": "0123456789012345",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Get non-assessment certificate

Returns the non-assessment certificate of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
nonAssessmentCertificateId required	string <uuid> Non-Assessment Certificate Id

Responses

/api/client/{clientId}/nonAssessmentCertificate/{nonAssessmentCertificateId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "NaturalPerson",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "externalIdentifier": "0123456789012345",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"

}

Get active exemption orders

Returns the active exemption orders under the client if client is part of any exemption order

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/activeExemptionOrders

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applicableAmount": 0,
  • "currencyCode": "EUR",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "clientIds": [

    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

    ],
  • "usedAmount": 0

  }

]

Get client tax data

Returns the tax information of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/taxData

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "activeTaxResidencies": [

  • {

    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "clientType": "B",
    • "germanTaxResident": true,
    • "federalState": "DE-HE",
    • "validFrom": "2019-08-24T14:15:22Z",
    • "invalidFrom": "2019-08-24T14:15:22Z"

    }

  ],
• "activeTaxIds": [

  • {

    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "tin": "string",
    • "taxCountry": "str",
    • "type": "TaxId",
    • "validFrom": "2019-08-24T14:15:22Z",
    • "invalidFrom": "2019-08-24T14:15:22Z"

    }

  ],
• "activeChurchTaxInformations": [

  • {

    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "subjectToChurchTax": true,
    • "activeChurchTaxRate": {

      • "churchTaxRate": 0,
      • "religiousCommunityId": "string",
      • "religiousCommunityName": "string",
      • "churchTaxRateValidFrom": "string",
      • "churchTaxRateInvalidFrom": "string"

      }

    }

  ],
• "activeExemptionOrders": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "applicableAmount": 0,
    • "currencyCode": "EUR",
    • "validFrom": "2019-08-24",
    • "validUntil": "2019-08-24",
    • "clientIds": [

      • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

      ],
    • "usedAmount": 0

    }

  ],
• "activeNonAssessmentCertificates": [

  • {

    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "nvId": 0,
    • "externalIdentifier": "string",
    • "type": "strin",
    • "typeDescription": "string",
    • "validFrom": "2019-08-24T14:15:22Z",
    • "validUntil": "2019-08-24T14:15:22Z"

    }

  ]

}

Update client partnership

Updates the partner client id of the married or registered civil partnership person REMARK:Updating client's marital status later to single, divorced, etc. will break this partnership as well.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
partnerClientId required	string <uuid> Id of the partner client

Responses

/api/client/{clientId}/partnership/{partnerClientId}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Releases client partnership

Releases the partnership of given clients. REMARK: May be used for to release partnership if the partnership is set between wrong clients.

It does not affect the marital status of the clients.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
partnerClientId required	string <uuid> Id of the partner client

Responses

/api/client/{clientId}/partnership/{partnerClientId}/release

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "status": "Onboarded",
• "clientKey": "Example Client Key",
• "name": "Max",
• "surname": "Mustermann",
• "email": "user@example.com",
• "countryOfOrigin": "DEU",
• "nationality": "DEU",
• "dateOfBirth": "1980-11-03",
• "placeOfBirth": "DEU",
• "maritalStatus": "Married",
• "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
• "establishedDate": "2022-08-31",
• "clientType": "Business",
• "clientSubType": "DesignatedSponsor",
• "riskClass": "Low",
• "clientLEI": "stringstringstringst",
• "identityNumberType": "NotSet",
• "identityNumber": "345678901234",
• "liableToTax": true,
• "federalState": "DE-HE",
• "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
• "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
• "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
• "hasIdentityUser": true,
• "birthName": "Max",
• "title": "Prof.",
• "gender": "Male",
• "salutation": "Mrs.",
• "language": "de_DE",
• "communicationWithPostAllowed": true,
• "communicationWithEmailAllowed": true,
• "communicationWithPhoneAllowed": true,
• "contractualPartnerCode": "CP0001",
• "occupationGroup": "Other",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "deletedDate": "2019-08-24T14:15:22Z",
• "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

}

Get church tax information

Returns the church tax information if client is liable to church tax

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/churchTaxInformation

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "subjectToChurchTax": true,
• "religiousCommunityId": "010600",
• "religiousCommunityName": "Evangelische Landeskirche Anhalts",
• "churchTaxRateValidFrom": "2023-01-01",
• "churchTaxRate": 0.08

}

Trigger KISTAM request

Triggers KISTAM request for a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/onDemandKistamQuery

Response samples

• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Add new employment information

Adds new employment information for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Employment Properties

divisionCode required	string [ 1 .. 10 ] characters Division code full list is available on employment/{classificationCode}/division helper endpoint
jobTitle	string or null <= 256 characters Job title.Free format entry to be received from client .
validFrom required	string <date> = 10 characters Beginning date of the job.
validUntil	string or null <date> <= 10 characters End date of the job.
averageAnnualIncome	number <decimal> Average annual income.Can be used for credit risk assessment purposes if needed.
currencyCode	string or null <= 3 characters Currency of the average annual income.Required when average annual income is sent

Responses

/api/client/{clientId}/employment

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "divisionCode": "01.11.0",
• "jobTitle": "Engineer",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "averageAnnualIncome": 0,
• "currencyCode": "EUR"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "sectionCode": "S",
• "sectionInformation": "ERBRINGUNG VON SONSTIGEN DIENSTLEISTUNGEN",
• "divisionCode": "01.11.0",
• "divisionInformation": "Interessenvertretungen",
• "jobTitle": "Engineer",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "averageAnnualIncome": 0,
• "currencyCode": "EUR",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

List client employment informations

Returns a list of employment informations belongs to a client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/employment

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "sectionCode": "S",
  • "sectionInformation": "ERBRINGUNG VON SONSTIGEN DIENSTLEISTUNGEN",
  • "divisionCode": "01.11.0",
  • "divisionInformation": "Interessenvertretungen",
  • "jobTitle": "Engineer",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "averageAnnualIncome": 0,
  • "currencyCode": "EUR",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Update employment information

Updates existing employment information of the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
employmentId required	string <uuid> Employment Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Employment Properties

divisionCode required	string [ 1 .. 10 ] characters Division code full list is available on employment/{classificationCode}/division helper endpoint
jobTitle	string or null <= 256 characters Job title.Free format entry to be received from client .
validFrom required	string <date> = 10 characters Beginning date of the job.
validUntil	string or null <date> <= 10 characters End date of the job.
averageAnnualIncome	number <decimal> Average annual income.Can be used for credit risk assessment purposes if needed.
currencyCode	string or null <= 3 characters Currency of the average annual income.Required when average annual income is sent

Responses

/api/client/{clientId}/employment/{employmentId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "divisionCode": "01.11.0",
• "jobTitle": "Engineer",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "averageAnnualIncome": 0,
• "currencyCode": "EUR"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "sectionCode": "S",
• "sectionInformation": "ERBRINGUNG VON SONSTIGEN DIENSTLEISTUNGEN",
• "divisionCode": "01.11.0",
• "divisionInformation": "Interessenvertretungen",
• "jobTitle": "Engineer",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "averageAnnualIncome": 0,
• "currencyCode": "EUR",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Remove employment information

Removes existing employment information from the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
employmentId required	string <uuid> Employment Id

Responses

/api/client/{clientId}/employment/{employmentId}

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get a spesific employment information of a a client

Returns the employment information of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
employmentId required	string <uuid> Employment Id

Responses

/api/client/{clientId}/employment/{employmentId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "sectionCode": "S",
• "sectionInformation": "ERBRINGUNG VON SONSTIGEN DIENSTLEISTUNGEN",
• "divisionCode": "01.11.0",
• "divisionInformation": "Interessenvertretungen",
• "jobTitle": "Engineer",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "averageAnnualIncome": 0,
• "currencyCode": "EUR",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Unsubscribe a report event

Unsubscribes a report event for the given client. Any change in data will propagate to online system within one hour

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Type of the event report

string

Enum: "TradeExecutionReport" "TradeExecutionAccountBooking" "TradeExecutionReversal" "TradeOrderCancelReject" "TradeOrderModifyReject" "TradeCaptureReport" "TradeCaptureReportSno" "PaymentSDDInstructionUploaded" "PaymentSDDInstructionReceived" "PaymentSDDInstructionReverted" "PaymentSDDInstructionFailed" "ClientKistamQueryResultReceived" "NewInternalAccountStatement" "NewDepositAccountStatement" "BONewClientCreate" "BONewDepositAccountCreate" "BONewInternalAccountCreate" "BONewBankAccountCreate" "BOClientStateUpdate" "BOInternalAccountStateUpdate" "BODepositAccountStateUpdate" "BOBankAccountStateUpdate" "NewInternalAccountTransaction" "NewDepositAccountTransaction" "KycCreate" "KycUpdate" "ClientUpdate" "WithdrawalUpdate" "BankAccountAMLClosure" "PaymentSCTInstructionUpdated" "TradeExecutionStatement" "TradeExecutionReversalStatement" "LossThresholdReport" "CorporateActionStatement" "CorporateActionMetadata" "CorporateActionWithChoiceNotif"

Holds list of different event report types supported by the system

Responses

/api/client/{clientId}/eventReportUnsubscription

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"TradeExecutionReport"

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Subscribe a report event

Subscribes a report event for the given client. Any change in data will propagate to online system within one hour

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Type of the event report

string

Enum: "TradeExecutionReport" "TradeExecutionAccountBooking" "TradeExecutionReversal" "TradeOrderCancelReject" "TradeOrderModifyReject" "TradeCaptureReport" "TradeCaptureReportSno" "PaymentSDDInstructionUploaded" "PaymentSDDInstructionReceived" "PaymentSDDInstructionReverted" "PaymentSDDInstructionFailed" "ClientKistamQueryResultReceived" "NewInternalAccountStatement" "NewDepositAccountStatement" "BONewClientCreate" "BONewDepositAccountCreate" "BONewInternalAccountCreate" "BONewBankAccountCreate" "BOClientStateUpdate" "BOInternalAccountStateUpdate" "BODepositAccountStateUpdate" "BOBankAccountStateUpdate" "NewInternalAccountTransaction" "NewDepositAccountTransaction" "KycCreate" "KycUpdate" "ClientUpdate" "WithdrawalUpdate" "BankAccountAMLClosure" "PaymentSCTInstructionUpdated" "TradeExecutionStatement" "TradeExecutionReversalStatement" "LossThresholdReport" "CorporateActionStatement" "CorporateActionMetadata" "CorporateActionWithChoiceNotif"

Holds list of different event report types supported by the system

Responses

/api/client/{clientId}/eventReportUnsubscription

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"TradeExecutionReport"

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Gets unsubscribed report events for a client

Gets unsubscribed report events for the given client.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/eventReportUnsubscription

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "addressName": "My home Frankfurt",
• "street": "Some street at Frankfurt",
• "buildingIdentifier": "Katoni Palace",
• "suiteIdentifier": "17",
• "floorIdentifier": "3",
• "districtName": "Some District at frankfurt",
• "postBox": "Frankfurt",
• "postCode": "65343",
• "city": "Frankfurt",
• "countrySubentity": "Kansas",
• "alpha3CountryCode": "DEU",
• "addressType": "InvoicingAddress",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "recordState": "Inactive",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Add new client photo

Adds new photo for the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Photo Properties

photo

string or null <byte> Binary[] formatted client photo

Responses

/api/client/{clientId}/photo

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "photo": "0x646174613A696D6..."

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get the photo of the given client

Returns the photo of the client with the given id

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/photo

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Update client photo

Updates existing client photo

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
photoId required	string <uuid> Photo Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Photo Properties

photo

string or null <byte> Binary[] formatted client photo

Responses

/api/client/{clientId}/photo/{photoId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "photo": "0x646174613A696D6..."

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "photo": "0x646174613A696D6...",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get client loss threshold reports

Returns the loss threshold reports of the given client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid>

query Parameters

dateBegin required	string <date> Example: dateBegin=2023-07-12 Begin Date (YYYY-MM-DD)
dateEnd required	string <date> Example: dateEnd=2023-08-12 End Date (YYYY-MM-DD)

Responses

/api/client/{clientId}/lossThresholdReport

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "contentType": "Unknown"

  }

]

Get client loss threshold report

Returns the specified loss threshold report for the given client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid>
lossThresholdReportId required	string <uuid>

Responses

/api/client/{clientId}/lossThresholdReport/{lossThresholdReportId}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pdfReport": "string"

}

Get client loss threshold event

Returns the specified loss threshold event details for the given client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid>
snapshotDate required	string

Responses

/api/client/{clientId}/lossThresholdEvent/{snapshotDate}

Response samples

• 200
• 400
• 404
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "snapshotDate": "2025-01-05",
• "lossThresholdPercentage": 10,
• "lastTotalBalance": 10000,
• "totalLossPercentage": 3,
• "reportingQuarter": "Q1-2025"

}

Get list of Ultimate Beneficial Owners

Returns the corresponding requests with the given criteria.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client

query Parameters

validRecord	boolean Validation Status of the Record
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/client/{clientId}/ultimateBeneficialOwner

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "uboType": "LegalEntity",
    • "ownerShipType": "Direct",
    • "companyOrIndividualFullName": "New Company",
    • "ownershipRatio": 100,
    • "identityNumber": "456789012345abc",
    • "identityNumberType": "PassportNumber",
    • "countryOfOrigin": "DEU",
    • "countryOfResidence": "DEU",
    • "memo": "string",
    • "email": "mail@somedomain.com",
    • "contactTelephone": "+905054545",
    • "validRecord": true,
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ]

}

New Ultimate Beneficial Owner

Creates Ultimate Beneficial Owner

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Information for Ultimate Beneficial Owner

documents	Array of strings or null Document File Data File data in binary format (ie: hex string with 0x prefix)
uboType required	string Enum: "LegalEntity" "Person" Ultimate Beneficial Owner Type
ownerShipType	string Enum: "Direct" "Indirect" Ultimate Beneficial Owner Ship Type
companyOrIndividualFullName required	string non-empty Ultimate Beneficial Owner Company Or Individual Name
ownershipRatio required	number <decimal> Ultimate Beneficial Owner Ownership Ratio
identityNumber required	string [ 1 .. 50 ] characters Holds country wise identity number of the Ultimate Beneficial Owner . ie: Passport No, Business Registration, etc
identityNumberType required	string Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber" Holds type of identity number used to define Ultimate Beneficial Owner
countryOfOrigin required	string = 3 characters Country of Origin in Alpha 3 Country Code Format
countryOfResidence required	string = 3 characters Country of Residence in Alpha 3 Country Code Format
memo required	string non-empty Record Notes for Ultimate Beneficial Owner
email required	string <email> [ 1 .. 320 ] characters Mail of the Ultimate Beneficial Owner
contactTelephone	string or null <= 35 characters Contact Telephone of the Ultimate Beneficial Owner
validRecord required	boolean Ultimate Beneficial Owner Valid Record. Default is True
id	string <uuid> Ultimate Beneficial Owner Id
tenantId	string <uuid> Ultimate Beneficial Owner Tenant Id
clientId	string <uuid> Ultimate Beneficial Owner Client Id
createdDate	string <date-time>
createdUserId	string <uuid>
updatedDate	string or null <date-time>
updatedUserId	string or null <uuid>

Responses

/api/client/{clientId}/ultimateBeneficialOwner

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get a Ultimate Beneficial Owner

Returns the specific Ultimate Beneficial Owner request with the given id.

Authorizations:

BearerOpenIdConnect

path Parameters

ultimateBeneficialOwnerId required	string <uuid> Ultimate Beneficial Owner Id
clientId required	string

Responses

/api/client/{clientId}/ultimateBeneficialOwner/{ultimateBeneficialOwnerId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true

}

Update Ultimate Beneficial Owner

Updates Ultimate Beneficial Owner with the given input data

Authorizations:

BearerOpenIdConnect

path Parameters

ultimateBeneficialOwnerId required	string <uuid> Ultimate Beneficial Owner Id
clientId required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Ultimate Beneficial Owner

documents	Array of strings or null Document File Data File data in binary format (ie: hex string with 0x prefix)
uboType required	string Enum: "LegalEntity" "Person" Ultimate Beneficial Owner Type
ownerShipType	string Enum: "Direct" "Indirect" Ultimate Beneficial Owner Ship Type
companyOrIndividualFullName required	string non-empty Ultimate Beneficial Owner Company Or Individual Name
ownershipRatio required	number <decimal> Ultimate Beneficial Owner Ownership Ratio
identityNumber required	string [ 1 .. 50 ] characters Holds country wise identity number of the Ultimate Beneficial Owner . ie: Passport No, Business Registration, etc
identityNumberType required	string Enum: "NotSet" "NationalIdNumber" "PassportNumber" "BusinessRegistrationNumber" Holds type of identity number used to define Ultimate Beneficial Owner
countryOfOrigin required	string = 3 characters Country of Origin in Alpha 3 Country Code Format
countryOfResidence required	string = 3 characters Country of Residence in Alpha 3 Country Code Format
memo required	string non-empty Record Notes for Ultimate Beneficial Owner
email required	string <email> [ 1 .. 320 ] characters Mail of the Ultimate Beneficial Owner
contactTelephone	string or null <= 35 characters Contact Telephone of the Ultimate Beneficial Owner
validRecord required	boolean Ultimate Beneficial Owner Valid Record. Default is True

Responses

/api/client/{clientId}/ultimateBeneficialOwner/{ultimateBeneficialOwnerId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get a Ultimate Beneficial Owner Document

Returns the specific Ultimate Beneficial Owner Document with the given id.

Authorizations:

BearerOpenIdConnect

path Parameters

ultimateBeneficialOwnerId required	string <uuid> Ultimate Beneficial Owner Id
clientId required	string

Responses

/api/client/{clientId}/ultimateBeneficialOwner/{ultimateBeneficialOwnerId}/document

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "documents": [

  • "string"

  ]

}

Update Ultimate Beneficial Owner Valid Record as False

Updates Ultimate Beneficial Owner Valid Record as False.

Authorizations:

BearerOpenIdConnect

path Parameters

ultimateBeneficialOwnerId required	string <uuid> Ultimate Beneficial Owner Id
clientId required	string

Responses

/api/client/{clientId}/ultimateBeneficialOwner/{ultimateBeneficialOwnerId}/validRecord

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "documents": [

  • "string"

  ],
• "uboType": "LegalEntity",
• "ownerShipType": "Direct",
• "companyOrIndividualFullName": "New Company",
• "ownershipRatio": 100,
• "identityNumber": "456789012345abc",
• "identityNumberType": "PassportNumber",
• "countryOfOrigin": "DEU",
• "countryOfResidence": "DEU",
• "memo": "string",
• "email": "mail@somedomain.com",
• "contactTelephone": "+905054545236",
• "validRecord": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Start KYC process for a client

Starts a new KYC operation and returns the session link to the client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
initiatorKycId required	string

query Parameters

flowType

string Enum: "WithProofOfAddress" "WithoutProofOfAddress"

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

kycMethod	string Enum: "Fourthline" "Lionware" Applicable kyc methods
	object (KycCallbackUrls)

Responses

/api/client/{clientId}/kyc/{initiatorKycId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "kycMethod": "Fourthline",
• "callbackUrls": {

  • "success": "string",
  • "declined": "string",
  • "incomplete": "string",
  • "reviewPending": "string"

  }

}

Response samples

• 200
• 400
• 404
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "providerKycId": "string",
• "sessionUrl": "string",
• "expiryDate": "2019-08-24T14:15:22Z"

}

Get KYC detail of client

Returns the given clients kyc detail

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
initiatorKycId required	string

query Parameters

includeProviderDetails

boolean Default: false

Responses

/api/client/{clientId}/kyc/{initiatorKycId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "providerDetail": "string",
• "documents": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "initiatorKycId": "string",
• "providerKycId": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "expiryDate": "2019-08-24T14:15:22Z",
• "kycMethod": "Fourthline",
• "sessionUrl": "string",
• "kycStatus": "Initial",
• "kycFlowType": "WithProofOfAddress",
• "reviewReason": "string",
• "internalNote": "string",
• "customerNote": "string",
• "identityVerificationStatus": "Initial",
• "identityVerificationStatusCodes": "string",
• "qesStatus": "New",
• "qesStatusCodes": "string",
• "qesProviderDetail": "string"

}

Update Kyc Status of the specified Kyc Detail (KYC Simulation Mode)

Updates the Kyc Status of the specified Kyc Detail under the client Only applicable in Test Environment

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
initiatorKycId required	string

query Parameters

kycStatus

string Enum: "Initial" "Pending" "InconsistentData" "InvalidData" "Declined" "Success" "Retry" "AMLReview" "AMLRejected" "AMLRetry" Desired Kyc Status

Responses

/api/client/{clientId}/kyc/{initiatorKycId}/automationUpdate

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "providerDetail": "string",
• "documents": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "initiatorKycId": "string",
• "providerKycId": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "expiryDate": "2019-08-24T14:15:22Z",
• "kycMethod": "Fourthline",
• "sessionUrl": "string",
• "kycStatus": "Initial",
• "kycFlowType": "WithProofOfAddress",
• "reviewReason": "string",
• "internalNote": "string",
• "customerNote": "string",
• "identityVerificationStatus": "Initial",
• "identityVerificationStatusCodes": "string",
• "qesStatus": "New",
• "qesStatusCodes": "string",
• "qesProviderDetail": "string"

}

Update Kyc Status of the specified Kyc Detail

Updates the Kyc Status of the specified Kyc Detail under the client.

Add/Update the Customer note of the specified kyc detail.

Add/Update the Internal note of the specified kyc detail.

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
initiatorKycId required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

status	string or null Enum: "Initial" "Pending" "InconsistentData" "InvalidData" "Declined" "Success" "Retry" "AMLReview" "AMLRejected" "AMLRetry"
internalNote	string or null <= 1024 characters Reason for the review. Only AML officers can see this part.
customerNote	string or null <= 1024 characters Reason for the review. Contains the detail of the review for the client.

Responses

/api/client/{clientId}/kyc/{initiatorKycId}/update

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "status": "Initial",
• "internalNote": "string",
• "customerNote": "string"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "providerDetail": "string",
• "documents": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "initiatorKycId": "string",
• "providerKycId": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "expiryDate": "2019-08-24T14:15:22Z",
• "kycMethod": "Fourthline",
• "sessionUrl": "string",
• "kycStatus": "Initial",
• "kycFlowType": "WithProofOfAddress",
• "reviewReason": "string",
• "internalNote": "string",
• "customerNote": "string",
• "identityVerificationStatus": "Initial",
• "identityVerificationStatusCodes": "string",
• "qesStatus": "New",
• "qesStatusCodes": "string",
• "qesProviderDetail": "string"

}

Get KYC details of client

Returns list of the given clients kyc details

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/kyc

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "providerDetail": "string",
• "documents": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "initiatorKycId": "string",
• "providerKycId": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "expiryDate": "2019-08-24T14:15:22Z",
• "kycMethod": "Fourthline",
• "sessionUrl": "string",
• "kycStatus": "Initial",
• "kycFlowType": "WithProofOfAddress",
• "reviewReason": "string",
• "internalNote": "string",
• "customerNote": "string",
• "identityVerificationStatus": "Initial",
• "identityVerificationStatusCodes": "string",
• "qesStatus": "New",
• "qesStatusCodes": "string",
• "qesProviderDetail": "string"

}

Get investment decision makers of business client

Returns list of the given business clients investment decision makers

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid> Client Id

Responses

/api/client/{clientId}/investmentDecisionMaker

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "scope": "BusinessClient",
• "concatCode": "string",
• "shortCode": "string",
• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com",
• "isDefault": true,
• "isActive": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Create new investment decision maker

Create new investment decision maker for a business client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required

string <uuid>

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

name	string or null <= 128 characters
surname	string or null <= 128 characters
countryCode required	string = 2 characters Iso country alpha 2 code
dateOfBirth	string or null <date> = 10 characters Birth data of the decision maker
email	string or null <email> <= 320 characters

Responses

/api/client/{clientId}/investmentDecisionMaker

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com"

}

Response samples

• 200
• 400
• 404
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "scope": "BusinessClient",
• "concatCode": "string",
• "shortCode": "string",
• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com",
• "isDefault": true,
• "isActive": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Update investment decision maker

Update investment decision maker of a business client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Investment Decision Maker Request

name	string or null <= 128 characters
surname	string or null <= 128 characters
countryCode required	string = 2 characters Iso country alpha 2 code
dateOfBirth	string or null <date> = 10 characters Birth data of the decision maker
email	string or null <email> <= 320 characters

Responses

/api/client/{clientId}/investmentDecisionMaker/{investmentDecisionMakerId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "scope": "BusinessClient",
• "concatCode": "string",
• "shortCode": "string",
• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com",
• "isDefault": true,
• "isActive": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Update default investment decision maker

Change business client default investment decision maker

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id

Responses

/api/client/{clientId}/investmentDecisionMaker/{investmentDecisionMakerId}/defaultInvestmentDecisionMaker

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
• "scope": "BusinessClient",
• "concatCode": "string",
• "shortCode": "string",
• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com",
• "isDefault": true,
• "isActive": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Update activeness of business client investment decision maker

Update activeness of specified investment decision maker from the business client

Authorizations:

BearerOpenIdConnect

path Parameters

clientId required	string <uuid> Client Id
investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id

Responses

/api/client/{clientId}/investmentDecisionMaker/{investmentDecisionMakerId}/activeInvestmentDecisionMaker

Response samples

• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

CorporateActions

Get corporate action statement

Returns the statement of the given id

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required

string <= 36 characters Corporate action id

Responses

/api/corporateActions/{corporateActionId}/statement

Response samples

• 200
• 400
• 404
• 422
• 500

Content type

application/json

{

• "id": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "type": "\r\n DVCA\r\n ",
• "data": "string"

}

Get corporate action metadata

Returns the statement metadata of the given id

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required

string <= 36 characters Corporate action id

Responses

/api/corporateActions/{corporateActionId}/metadata

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

Example

CorporateActionMetadataADDSCorporateActionMetadataCAPGCorporateActionMetadataDVCACorporateActionMetadataREORCorporateActionMetadataINTRCorporateActionMetadataDVAPCorporateActionMetadataADDS

{

• "clients": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "name": "string",
    • "surname": "string",
    • "email": "user@example.com",
    • "gender": "Unspecified",
    • "salutation": "string",
    • "address": {

      • "street": "Some street at Frankfurt",
      • "buildingIdentifier": "Katoni Palace",
      • "suiteIdentifier": "17",
      • "floorIdentifier": "3",
      • "districtName": "Some District at frankfurt",
      • "postCode": "65343",
      • "city": "Frankfurt",
      • "alpha3CountryCode": "DEU"

      }

    }

  ],
• "securityName": "string",
• "job": {

  • "caJobId": 123,
  • "isin": "US83088M1027",
  • "depository": "CBF",
  • "sectionCode": "E",
  • "sectionNumber": "012021013000",
  • "caTemplateVersion": 3,
  • "caType": "DVCA",
  • "externalCaType": "DVCA",
  • "property1": null,
  • "property2": null

  },
• "jobProcessing": {

  • "entitlementDate": "2024-09-10",
  • "entitledBalance": "",
  • "securityAccountNumber": "XXXXXX",
  • "securityAccountId": "60259c88-7437-4a4b-95b2-e86e85891fcf",
  • "cashAccountNumber": "183115040",
  • "cashAccountId": "60259c88-7437-4a4b-95b2-e86e85891fcf",
  • "depository": "CBF",
  • "property1": null,
  • "property2": null

  },
• "taxData": {

  • "taxation": {

    • "taxationId": 0,
    • "taId": 0,
    • "transactionId": 0,
    • "dateTimeCreate": "2019-08-24T14:15:22Z",
    • "capitalGainsTaxRate": "string",
    • "solidaritySurchargeRate": "string",
    • "inflowDate": "2019-08-24T14:15:22Z",
    • "cashAccountNumber": "string",
    • "securityAccountNumber": "string"

    },
  • "taxationInputAndResult": {

    • "before": {

      • "year": 0,
      • "annualShareProfitDelta": "string",
      • "annualShareLossDelta": "string",
      • "annualOtherProfitDelta": "string",
      • "annualOtherLossDelta": "string",
      • "annualDomesticDividendDelta": "string",
      • "annualDomesticDividendSection27Delta": "string",
      • "annualCreditableWithholdingTaxDelta": "string",
      • "annualLegacyNonFundProfitDelta": "string",
      • "annualLegacyNonFundLossDelta": "string",
      • "annualLegacyFundProfitDelta": "string",
      • "annualLegacyFundLossDelta": "string",
      • "annualWorthlessAssetLossDelta": "string",
      • "annualPrivateDisposalsWithinSpeculationDelta": "string",
      • "annualPrivateDisposalsOutsideSpeculationDelta": "string",
      • "counterP27": 0,
      • "federalStateIsoCodePerson1": "strin",
      • "religiousCommunityPerson1": "string",
      • "totalTaxableAmountPerson1": "string",
      • "totalCapitalGainsTaxPerson1": "string",
      • "totalSolidaritySurchargePerson1": "string",
      • "totalChurchTaxPerson1": "string",
      • "federalStateIsoCodePerson2": "strin",
      • "religiousCommunityPerson2": "string",
      • "totalTaxableAmountPerson2": "string",
      • "totalCapitalGainsTaxPerson2": "string",
      • "totalSolidaritySurchargePerson2": "string",
      • "totalChurchTaxPerson2": "string",
      • "totalTaxExemptAmountDueToNV": "string",
      • "totalTaxExemptAmountForForeignTaxpayers": "string",
      • "totalTaxExemptAmountForBusinessAssets": "string",
      • "totalTaxExemptAmountForCreditInstitutions": "string",
      • "totalShadowStockLossOffsetPool": "string",
      • "totalShadowOtherLossOffsetPool": "string",
      • "totalShadowWithholdingTaxOffsetPool": "string",
      • "totalFreeFsaAmountForLossRefNumber": "string",
      • "totalStockLossOffsetPool": "string",
      • "totalOtherLossesOffsetPool": "string",
      • "totalWithholdingTaxOffsetPool": "string"

      },
    • "delta": {

      • "year": 0,
      • "annualShareProfitDelta": "string",
      • "annualShareLossDelta": "string",
      • "annualOtherProfitDelta": "string",
      • "annualOtherLossDelta": "string",
      • "annualDomesticDividendDelta": "string",
      • "annualDomesticDividendSection27Delta": "string",
      • "annualCreditableWithholdingTaxDelta": "string",
      • "annualLegacyNonFundProfitDelta": "string",
      • "annualLegacyNonFundLossDelta": "string",
      • "annualLegacyFundProfitDelta": "string",
      • "annualLegacyFundLossDelta": "string",
      • "annualWorthlessAssetLossDelta": "string",
      • "annualPrivateDisposalsWithinSpeculationDelta": "string",
      • "annualPrivateDisposalsOutsideSpeculationDelta": "string",
      • "counterP27": 0,
      • "federalStateIsoCodePerson1": "strin",
      • "religiousCommunityPerson1": "string",
      • "totalTaxableAmountPerson1": "string",
      • "totalCapitalGainsTaxPerson1": "string",
      • "totalSolidaritySurchargePerson1": "string",
      • "totalChurchTaxPerson1": "string",
      • "federalStateIsoCodePerson2": "strin",
      • "religiousCommunityPerson2": "string",
      • "totalTaxableAmountPerson2": "string",
      • "totalCapitalGainsTaxPerson2": "string",
      • "totalSolidaritySurchargePerson2": "string",
      • "totalChurchTaxPerson2": "string",
      • "totalTaxExemptAmountDueToNV": "string",
      • "totalTaxExemptAmountForForeignTaxpayers": "string",
      • "totalTaxExemptAmountForBusinessAssets": "string",
      • "totalTaxExemptAmountForCreditInstitutions": "string",
      • "totalShadowStockLossOffsetPool": "string",
      • "totalShadowOtherLossOffsetPool": "string",
      • "totalShadowWithholdingTaxOffsetPool": "string",
      • "totalFreeFsaAmountForLossRefNumber": "string",
      • "totalStockLossOffsetPool": "string",
      • "totalOtherLossesOffsetPool": "string",
      • "totalWithholdingTaxOffsetPool": "string"

      },
    • "after": {

      • "year": 0,
      • "annualShareProfitDelta": "string",
      • "annualShareLossDelta": "string",
      • "annualOtherProfitDelta": "string",
      • "annualOtherLossDelta": "string",
      • "annualDomesticDividendDelta": "string",
      • "annualDomesticDividendSection27Delta": "string",
      • "annualCreditableWithholdingTaxDelta": "string",
      • "annualLegacyNonFundProfitDelta": "string",
      • "annualLegacyNonFundLossDelta": "string",
      • "annualLegacyFundProfitDelta": "string",
      • "annualLegacyFundLossDelta": "string",
      • "annualWorthlessAssetLossDelta": "string",
      • "annualPrivateDisposalsWithinSpeculationDelta": "string",
      • "annualPrivateDisposalsOutsideSpeculationDelta": "string",
      • "counterP27": 0,
      • "federalStateIsoCodePerson1": "strin",
      • "religiousCommunityPerson1": "string",
      • "totalTaxableAmountPerson1": "string",
      • "totalCapitalGainsTaxPerson1": "string",
      • "totalSolidaritySurchargePerson1": "string",
      • "totalChurchTaxPerson1": "string",
      • "federalStateIsoCodePerson2": "strin",
      • "religiousCommunityPerson2": "string",
      • "totalTaxableAmountPerson2": "string",
      • "totalCapitalGainsTaxPerson2": "string",
      • "totalSolidaritySurchargePerson2": "string",
      • "totalChurchTaxPerson2": "string",
      • "totalTaxExemptAmountDueToNV": "string",
      • "totalTaxExemptAmountForForeignTaxpayers": "string",
      • "totalTaxExemptAmountForBusinessAssets": "string",
      • "totalTaxExemptAmountForCreditInstitutions": "string",
      • "totalShadowStockLossOffsetPool": "string",
      • "totalShadowOtherLossOffsetPool": "string",
      • "totalShadowWithholdingTaxOffsetPool": "string",
      • "totalFreeFsaAmountForLossRefNumber": "string",
      • "totalStockLossOffsetPool": "string",
      • "totalOtherLossesOffsetPool": "string",
      • "totalWithholdingTaxOffsetPool": "string"

      }

    },
  • "taxationMasterData": {

    • "taxationId": 0,
    • "dateTimeCreate": "2019-08-24T14:15:22Z",
    • "lossReferenceNumber": 0,
    • "isResidentTaxpayer": true,
    • "nonAssessmentCertType": "_01",
    • "exemptionOrderId": 0,
    • "exemptionOrderSubmittedAmount": "string",
    • "exemptionOrderRemainingOrder": "string",
    • "assetType": "P",
    • "personId1": 0,
    • "federalStateIsoCodePerson1": "strin",
    • "churchTaxRatePerson1": "string",
    • "religiousCommunityPerson1": "string",
    • "personId2": 0,
    • "federalStateIsoCodePerson2": "strin",
    • "churchTaxRatePerson2": "string",
    • "religiousCommunityPerson2": "string",
    • "rawDomesticTaxpayer1": true,
    • "rawAssetType1": "P",
    • "rawFederalStateIsoCodePerson1": "strin",
    • "rawChurchTaxRatePerson1": "string",
    • "rawReligiousCommunityPerson1": "string",
    • "rawMarried": true,
    • "rawDomesticTaxpayer2": true,
    • "rawAssetType2": "P",
    • "rawFederalStateIsoCodePerson2": "strin",
    • "rawChurchTaxRatePerson2": "string",
    • "rawReligiousCommunityPerson2": "string"

    },
  • "taxationTaxableAmount": [

    • {

      • "taxationTaxableAmountId": 0,
      • "taxationId": 0,
      • "isin": "string",
      • "typeOfIncome": "string",
      • "taxBaseType": "string",
      • "taxBaseRate": "string",
      • "taxAmount": "string",
      • "gd505e": "s",
      • "gd504c": "s",
      • "partialExemptionRate": "string",
      • "fee": "string",
      • "fifoUsageId": 0,
      • "issuerFederalState": "strin"

      }

    ]

  },
• "jobParameter": {

  • "valueDate": "2024-09-10",
  • "newIsin": "DE0007100000",
  • "ratioNumerator": "",
  • "ratioDenominator": "",
  • "capitalIncreaseType": "",
  • "nonresidentTaxRelatedInstrument": "",
  • "caCluster": "",
  • "subscriptionPrice": "string",
  • "subscriptionPriceCurrency": "EUR",
  • "subscriptionPeriodStart": "string",
  • "subscriptionPeriodEnd": "string",
  • "nonTradableSubscriptionRight": "string",
  • "corporateActionClusterCode": "N",
  • "isinOfSubscriptionRights": "",
  • "instructionPeriodStart": "string",
  • "instructionPeriodEnd": "string",
  • "isinOfNewSecurities": "string",
  • "caClusterSubscriptionRight": "C",
  • "detachmentRatioNumerator": "",
  • "detachmentRatioDenominator": "",
  • "subscriptionRatioNumerator": "string",
  • "subscriptionRatioDenominator": "string",
  • "subscriptionRightsListingStartDate": "string",
  • "subscriptionRightsListingEndDate": "string",
  • "property1": null,
  • "property2": null

  },
• "jobProcessingParameter": {

  • "newNominal": "",
  • "property1": null,
  • "property2": null

  },
• "property1": null,
• "property2": null

}

Get corporate action with choice details for the customer notification

Returns the corporate action with choice details of the given id for the customer notification

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required

integer <int64> Corporate action id

Responses

/api/corporateActions/withChoice/{corporateActionId}/notification

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caId": 0,
• "caType": "string",
• "isin": "string",
• "depository": "CBF",
• "sectionCode": "E",
• "sectionNumber": "012021013000",
• "templateVersion": 3,
• "externalCaType": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "jobParameter": {

  • "meetingType": "s",
  • "meetingDateTime": "stringstringstringstri",
  • "meetingLocation": "string",
  • "lastDepositDate": "stringstri",
  • "contactPhone": "string",
  • "contactFax": "string",
  • "contactEmail": "string",
  • "informationAgent": "string"

  },
• "jobProcessings": [

  • {

    • "entitlementDate": "stringstri",
    • "entitledQuantity": "string",
    • "securityAccountNumber": "string",
    • "securityAccountId": "60259c88-7437-4a4b-95b2-e86e85891fcf",
    • "depository": "CBF"

    }

  ]

}

Returns the corporate action with choice records within the given date range.

Returns the corporate action with choice records within the given date range.

Authorizations:

BearerOpenIdConnect

query Parameters

startDate required	string <date-time> First Creation Date
endDate required	string <date-time> Last Creation Date

Responses

/api/corporateActions/withChoice

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

[

• {

  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "caJobId": 0,
  • "caType": "ADDS",
  • "isin": "stringstring",
  • "depository": "string",
  • "ag": "s",
  • "bid": "string",
  • "caTemplateVersion": 0,
  • "externalCaType": "string",
  • "createdDate": "2019-08-24T14:15:22Z"

  }

]

Get corporate action summary list for the dashboard

Returns the corporate action list for the dasboard with the given event status

Authorizations:

BearerOpenIdConnect

query Parameters

eventStatus	string Enum: "Upcoming" "Inprogress" "Completed" Status of the event
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/corporateActions

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "caJobId": 0,
    • "caType": "ADDS",
    • "typeName": "string",
    • "isinCode": "string",
    • "securityName": "string",
    • "eventName": "string",
    • "recordDate": "string",
    • "electionStartDate": "string",
    • "electionEndDate": "string",
    • "status": "Upcoming",
    • "electionType": "Mandatory"

    }

  ]

}

Get corporate action detail for the dashboard

Returns the corporate action detail for the selected ca from the dashboard list

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionType required	string Enum: "ADDS" "CAPG" "DVCA" "REOR" "MEET" "OPTI" "EXRI" "BONU" "DVOP" "SPLF" "SOFF" "MRGR" "LIQU" "INTR" "DVAP" Type of the corporate action
corporateActionId required	integer <int64> Corporate action id

Responses

/api/corporateActions/{corporateActionType}/{corporateActionId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "caJobId": 0,
• "caType": "ADDS",
• "typeName": "string",
• "isinCode": "string",
• "securityName": "string",
• "eventName": "string",
• "recordDate": "string",
• "electionStartDate": "string",
• "electionEndDate": "string",
• "electionType": "Mandatory",
• "status": "Upcoming",
• "corporateActionsDetailADDS": {

  • "tradingStartDate": "string",
  • "tradingEndDate": "string",
  • "ratioNumerator": 0,
  • "ratioDenominator": 0,
  • "ratioTermsText": "\r\n 1 for 5 \r\n ",
  • "exercisePrice": 42.75,
  • "exercisePriceCurrency": "\r\n EUR\r\n "

  },
• "corporateActionsDetailDVCA": {

  • "exDate": "string",
  • "paymentDate": "string",
  • "dividendPerShare": 0,
  • "dividendCurrency": "EUR",
  • "ratioTermsText": "\r\n 1 EUR per share\r\n "

  },
• "corporateActionsDetailREOR": {

  • "ratioNumerator": 0,
  • "ratioDenominator": 0,
  • "compensationPerShare": 0,
  • "compensationCurrency": "EUR",
  • "ratioTermsText": "\r\n 1 for 5 \r\n "

  },
• "corporateActionsDetailCAPG": {

  • "exDate": "string",
  • "paymentDate": "string",
  • "distributionPerShare": 0,
  • "distributionCurrency": "EUR",
  • "ratioTermsText": "\r\n 1 EUR per share\r\n "

  },
• "corporateActionsDetailINTR": {

  • "exDate": "string",
  • "paymentDate": "string",
  • "totalDividendOrIncome": 0,
  • "dividendOrIncomePercent": "%",
  • "dividendOrIncomeCurrency": "EUR",
  • "ratioTermsText": "\r\n 1 EUR per share\r\n "

  },
• "corporateActionsDetailEXRI": {

  • "rightsISINCode": "\r\n FR001400IRI9 \r\n ",
  • "tradingStartDate": "string",
  • "tradingEndDate": "string",
  • "ratioNumerator": 0,
  • "ratioDenominator": 0,
  • "ratioTermsText": "\r\n 1 for 5 \r\n ",
  • "exercisePrice": 42.75,
  • "exercisePriceCurrency": "\r\n EUR\r\n "

  },
• "corporateActionsDetailDVAP": {

  • "recordDate": "string",
  • "inflowDate": "string",
  • "taxableLumpSumPerUnit": 0,
  • "ratioTermsText": "\r\n 1 EUR per share\r\n "

  }

}

Get related security account list for the given corporate action

Get related security account list for the given corporate action

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionType required	string Enum: "ADDS" "CAPG" "DVCA" "REOR" "MEET" "OPTI" "EXRI" "BONU" "DVOP" "SPLF" "SOFF" "MRGR" "LIQU" "INTR" "DVAP" Type of the corporate action
corporateActionId required	integer <int64> Corporate action id

Responses

/api/corporateActions/eligibleSecurityAccounts/{corporateActionType}/{corporateActionId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

[

• {

  • "securityAccountId": "d7f34dd9-ac8d-4ad5-a706-5307ba58b452",
  • "securityAccountNumber": "string",
  • "alias": "string"

  }

]

Get instruction details of a voluntary corporate action for a spesific security account

Returns the voluntary ca instruction details and election options for the selected security account

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required	integer <int64> Corporate action id
securityAccountId required	string <uuid> Security account id

Responses

/api/corporateActions/instructionDetails/{corporateActionId}/securityAccount/{securityAccountId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "caJobId": 0,
• "caType": "ADDS",
• "securityAccountNumber": "string",
• "totalRightsAvailable": 0,
• "rightsSellingPrice": 0,
• "choices": [

  • {

    • "code": "\r\n EXER\r\n ",
    • "label": "\r\n Exercise All rights\r\n ",
    • "requiresQuantity": 1,
    • "isDefault": 0,
    • "subOptions": [

      • { }

      ]

    }

  ]

}

Submit customer instruction for a voluntary corporate action.

Creates new instruction and election records for the user's selected options (maker step). The record will appear in the approval queue; once approved, it becomes eligible for MT565 messaging.

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required	integer <int64> Corporate action id
securityAccountId required	string <uuid> Security account id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Details of the election

caJobId required	integer <int64> Corporate action job ID
securityAccountNumber required	string non-empty Safekeeping Account Number (MT565 :97A::SAFE//) The deposit account where the securities are held.
cashAccountNumber required	string non-empty Cash Account Number (MT565 :97A::CASH//) The cash account linked to the safekeeping account (e.g., IBAN).
required	Array of objects (CorporateActionInstructionElectionRequest) non-empty List of user instructions
instructionText	string or null Additional Instructions (MT565 :70E::INST//) Free text instructions or comments related to the election.

Responses

/api/corporateActions/instruction/{corporateActionId}/securityAccount/{securityAccountId}/submitInstruction

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "caJobId": 0,
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "optionNumber": "string",
    • "optionType": "EXER",
    • "quantity": 0,
    • "quantityType": "UNIT"

    }

  ],
• "instructionText": "string"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

Get list of instructions that pending approve

Returns the paged list for the instructions with status New

Authorizations:

BearerOpenIdConnect

query Parameters

pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/corporateActions/instruction/pendingApproval

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "caJobId": 0,
    • "corporateActionReference": "string",
    • "corporateActionEventIndicator": "ADDS",
    • "isin": "stringstring",
    • "instrumentName": "Erste Group Bank AG",
    • "securityAccountNumber": "string",
    • "cashAccountNumber": "string",
    • "instructionElections": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
        • "optionNumber": "str",
        • "optionType": "EXER",
        • "quantityType": "UNIT",
        • "quantity": 0,
        • "status": "WaitingApproval",
        • "swiftReferenceNumber": "string",
        • "swiftMessageDate": "2019-08-24T14:15:22Z",
        • "blockedPositionQuantity": 0,
        • "blockedCashAmount": 0,
        • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
        • "createdDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z",
        • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
        • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
        • "approvedDate": "2019-08-24T14:15:22Z",
        • "rejectReason": "string",
        • "processed": true,
        • "processedDate": "2019-08-24T14:15:22Z",
        • "errorInfo": "string",
        • "custodianStatusQualifier": "stri",
        • "custodianStatusCode": "stri",
        • "custodianReasonCode": "stri",
        • "custodianReasonNarrative": "string"

        }

      ],
    • "instructionText": "string",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "status": "WaitingApproval",
    • "rejectReason": "string"

    }

  ]

}

Cancel a previously submitted corporate action instruction (allowed until checker approval).

Cancels the instruction and its all elections if the status is pending approval. Once approved (or later), cancellation is not allowed via this endpoint.

Authorizations:

BearerOpenIdConnect

path Parameters

instructionId required

string <uuid> Instruction id (GUID)

Responses

/api/corporateActions/instruction/{instructionId}/cancel

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

Approve or reject a corporate action instruction

Approves or rejects an instruction. Only the instructions with status WaitingApproval are allowed.

Authorizations:

BearerOpenIdConnect

path Parameters

instructionId required

string <uuid> Instruction id (GUID)

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

CorporateActionElectionApproveRejectRequest

approval	boolean true => approve, false => reject
rejectReason	string or null Optional reason (used when rejected).

Responses

/api/corporateActions/instruction/{instructionId}/approve

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "approval": true,
• "rejectReason": "string"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

Cancel a single corporate action instruction election (allowed until checker approval).

Cancels the election if the status is pending approval. Once approved (or later), cancellation is not allowed via this endpoint.

Authorizations:

BearerOpenIdConnect

path Parameters

electionId required

string <uuid> Election id (GUID)

Responses

/api/corporateActions/election/{electionId}/cancel

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

Approve or reject single corporate action instruction election

Approves or rejects an election. Only the elections with status WaitingApproval are allowed.

Authorizations:

BearerOpenIdConnect

path Parameters

electionId required

string <uuid> Election id (GUID)

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

CorporateActionElectionApproveRejectRequest

approval	boolean true => approve, false => reject
rejectReason	string or null Optional reason (used when rejected).

Responses

/api/corporateActions/election/{electionId}/approve

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "approval": true,
• "rejectReason": "string"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

Get list of submitted elections for a ca job

Returns the paged list for the submitted elections for a corporate actions job

Authorizations:

BearerOpenIdConnect

path Parameters

corporateActionId required

integer <int64> Example: 270 Corporate action job id

query Parameters

pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/corporateActions/instruction/{corporateActionId}/submittedElections

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "caJobId": 0,
    • "corporateActionReference": "string",
    • "corporateActionEventIndicator": "ADDS",
    • "isin": "stringstring",
    • "instrumentName": "Erste Group Bank AG",
    • "securityAccountNumber": "string",
    • "cashAccountNumber": "string",
    • "instructionElections": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
        • "optionNumber": "str",
        • "optionType": "EXER",
        • "quantityType": "UNIT",
        • "quantity": 0,
        • "status": "WaitingApproval",
        • "swiftReferenceNumber": "string",
        • "swiftMessageDate": "2019-08-24T14:15:22Z",
        • "blockedPositionQuantity": 0,
        • "blockedCashAmount": 0,
        • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
        • "createdDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z",
        • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
        • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
        • "approvedDate": "2019-08-24T14:15:22Z",
        • "rejectReason": "string",
        • "processed": true,
        • "processedDate": "2019-08-24T14:15:22Z",
        • "errorInfo": "string",
        • "custodianStatusQualifier": "stri",
        • "custodianStatusCode": "stri",
        • "custodianReasonCode": "stri",
        • "custodianReasonNarrative": "string"

        }

      ],
    • "instructionText": "string",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "status": "WaitingApproval",
    • "rejectReason": "string"

    }

  ]

}

Update customer instruction for a voluntary corporate action.

Updates an existing instruction which is not approved yet or rejected by approver.

Authorizations:

BearerOpenIdConnect

path Parameters

instructionId required

string <uuid> Corporate action instruction id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Details of the update request

required	Array of objects (CorporateActionInstructionElectionRequest) non-empty List of user instructions
instructionText	string or null Additional Instructions (MT565 :70E::INST//) Free text instructions or comments related to the election.

Responses

/api/corporateActions/instruction/{instructionId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "instructionElections": [

  • {

    • "optionNumber": "string",
    • "optionType": "EXER",
    • "quantity": 0,
    • "quantityType": "UNIT"

    }

  ],
• "instructionText": "string"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "caJobId": 0,
• "corporateActionReference": "string",
• "corporateActionEventIndicator": "ADDS",
• "isin": "stringstring",
• "instrumentName": "Erste Group Bank AG",
• "securityAccountNumber": "string",
• "cashAccountNumber": "string",
• "instructionElections": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "corporateActionsInstructionId": "99cb1892-29ba-4ec9-a001-9842d582ab1b",
    • "optionNumber": "str",
    • "optionType": "EXER",
    • "quantityType": "UNIT",
    • "quantity": 0,
    • "status": "WaitingApproval",
    • "swiftReferenceNumber": "string",
    • "swiftMessageDate": "2019-08-24T14:15:22Z",
    • "blockedPositionQuantity": 0,
    • "blockedCashAmount": 0,
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvedUserId": "d0fd76ad-ef1b-4292-9c27-0ec9aa34cc01",
    • "approvedDate": "2019-08-24T14:15:22Z",
    • "rejectReason": "string",
    • "processed": true,
    • "processedDate": "2019-08-24T14:15:22Z",
    • "errorInfo": "string",
    • "custodianStatusQualifier": "stri",
    • "custodianStatusCode": "stri",
    • "custodianReasonCode": "stri",
    • "custodianReasonNarrative": "string"

    }

  ],
• "instructionText": "string",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "updatedDate": "2019-08-24T14:15:22Z",
• "status": "WaitingApproval",
• "rejectReason": "string"

}

DepositAccount

Create new deposit account

Creates a new deposit account for the client(s) corresponding to depositAccountRequest

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Deposit Account Request Informations

alias	string or null <= 70 characters Alias for the account.
clientIds	Array of strings or null <uuid> Owner(s) of the account. It may be a personal or joint account.
accountUsageType required	string Enum: "PortfolioManagement" "Brokerage"
accountScope	string or null Enum: "Customer" "PEA" "CPD" "RBA"

Responses

/api/depositAccount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "alias": "SomeAliasForThisAccount",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "alias": "Example alias",
• "status": "Active",
• "accountNumber": "000000089",
• "sortCode": "00000000",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Get list of deposit accounts

Returns the corresponding deposit accounts with the given criteria. At least one of the following parameters should be sent:

• accountId
• accountNumber
• dateTimeStart/dateTimeEnd

Authorizations:

BearerOpenIdConnect

query Parameters

clientId	string <uuid> Client Id
accountId	string <uuid> Deposit Account Id
accountNumber	string Example: accountNumber=0000000089 Account Number of the Deposit Account
accountStatuses	string Example: accountStatuses=Initial, Active Account Statuses of the Deposit Account
dateTimeStart	string <date-time> Example: dateTimeStart=2023-01-14T13:46:27.975Z Deposit Account Creation Date-Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2023-01-23T13:46:27.975Z Deposit Account Creation Date-End
createdUserId	string <uuid> Deposit Account Create User
accountScope	string Enum: "Customer" "PEA" "CPD" "RBA" Example: accountScope=Customer Scope of the Deposit Account
accountUsageType	string Enum: "PortfolioManagement" "Brokerage" Example: accountUsageType=PortfolioManagement Usage Type of the Deposit Account
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/depositAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "alias": "Example alias",
    • "status": "Active",
    • "accountNumber": "000000089",
    • "sortCode": "00000000",
    • "accountUsageType": "PortfolioManagement",
    • "accountScope": "Customer",
    • "clientIds": [

      • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ]

}

Update deposit account status

Updates the status of deposit account with initial, active, suspended or deleted

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required

string <uuid> Deposit Account Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Account Status Request

status required	string Enum: "Initial" "Active" "Suspended" "Deleted" "Closed" "InClosure" Requested status of the account.
closeOrDeleteReason	string or null <= 512 characters Account close or delete reason. Free format.Not required. Max length 512

Responses

/api/depositAccount/{depositAccountId}/status

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "status": "Active",
• "closeOrDeleteReason": "string"

}

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Update deposit account alias

Updates the alias of deposit account

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
alias required	string Example: SomeAliasForThisAccount New alias for the deposit account

Responses

/api/depositAccount/{depositAccountId}/alias/{alias}

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get a deposit account

Returns the corresponding deposit account with the given deposit account id.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required

string <uuid> Deposit Account Id

Responses

/api/depositAccount/{depositAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alias": "Example Alias",
• "status": "Initial",
• "accountNumber": "000000089",
• "sortCode": "00000000",
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get all open positions of a particular deposit account

Returns the list of TradePosition(s) with the given deposit account id.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required

string <uuid> Deposit Account Id

Responses

/api/depositAccount/{depositAccountId}/position

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "ICF",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "isinCode": "DE000CBK1001",
  • "shortCode": "CBK",
  • "instrumentName": "Erste Group Bank AG",
  • "instrumentType": "Stocks",
  • "type": "BUY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "EUR",
  • "priceAtLastExecution": 0,
  • "priceAverage": 0,
  • "profit": 0,
  • "quantity": 0,
  • "quantityAwaitingSellOrder": 0,
  • "lastBidPriceAtProfitCalculation": 0,
  • "depository": "Allfunds",
  • "depositAccountId": "556ff936-f750-4262-9bd5-2eaec4aeff90",
  • "blockedQuantity": 0,
  • "blockageDate": "2019-08-24T14:15:22Z",
  • "blockageUser": "92af80b6-2112-4818-a2b7-57299a671b11"

  }

]

Get an open position by id

Returns the corresponding TradePosition with the given deposit account id and position id.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
positionId required	string <uuid> Trade Position Id

Responses

/api/depositAccount/{depositAccountId}/position/{positionId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "provider": "ICF",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "isinCode": "DE000CBK1001",
• "shortCode": "CBK",
• "instrumentName": "Erste Group Bank AG",
• "instrumentType": "Stocks",
• "type": "BUY",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "currencyCode": "EUR",
• "priceAtLastExecution": 0,
• "priceAverage": 0,
• "profit": 0,
• "quantity": 0,
• "quantityAwaitingSellOrder": 0,
• "lastBidPriceAtProfitCalculation": 0,
• "depository": "Allfunds",
• "depositAccountId": "556ff936-f750-4262-9bd5-2eaec4aeff90",
• "blockedQuantity": 0,
• "blockageDate": "2019-08-24T14:15:22Z",
• "blockageUser": "92af80b6-2112-4818-a2b7-57299a671b11"

}

Get transactions of a particular deposit account

Returns the paged transactions response

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required

string <uuid> Deposit Account Id

query Parameters

Mark	string Enum: "Debit" "Credit" "Neutral"
Type	string Enum: "Deposit" "Withdrawal" "Buy" "Sell" "Dividend" "BlockageReserve" "BlockageRelease" "FractionsBuy" "FractionsSell" "SecurityTransferWOData" "SecurityTransferWithData" "SecurityReorganisation" "Maturity" "CapitalGainsTax" "SolidaritySurcharge" "ChurchTax" "TaxDeclaration" "Securities" "DepositReversal" "WithdrawalReversal" "BuyReversal" "SellReversal" "DividentReversal" "BlockageReserveReversal" "BlockageReleaseReversal" "FractionsBuyReversal" "FractionsSellReversal" "SecurityTransferWODataReversal" "SecurityTransferWithDataReversal" "SecurityReorganisationReversal" "MaturityReversal" "CapitalGainsTaxReversal" "SolidaritySurchargeReversal" "ChurchTaxReversal" "TaxDeclarationReversal" "SecuritiesReversal" "MoneySent" "MoneyReceived" "MoneySentReversal" "MoneyReceivedReversal" "Other" "OtherReversal" "InterestSettlement" "InterestSettlementReversal" "SepaDirectDebitDeposit" "SepaDirectDebitRefund" "CashBalanceAdjustment" "OneTimeFee" "OneTimeFeeReversal" "TaxRefund" "TaxRefundReversal"
IsinCode	string <= 12 characters Example: IsinCode=DE000CBK1001 International Securities Identification Number
ShortCode	string Example: ShortCode=CBK Shortened version of Isin code
InstrumentName	string Example: InstrumentName=Erste Group Bank AG Instrument of the name
PostingText	string Example: PostingText=BlockageReserve/LU0431139764x2,0/MARKET
MinAmount	number <decimal>
MaxAmount	number <decimal>
MinQuantity	number <decimal>
MaxQuantity	number <decimal>
DateBegin	string
DateEnd	string
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Page Number
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Records Per Page

Responses

/api/depositAccount/{depositAccountId}/transaction

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "mark": "Debit",
    • "type": "Deposit",
    • "dateTime": "2019-08-24T14:15:22Z",
    • "bookingDate": "2019-08-24",
    • "valueDate": "2019-08-24",
    • "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
    • "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "comment": "Transaction successful",
    • "txKeyId": 0,
    • "balanceInBookedDate": 0,
    • "balanceInTransactionDate": 0,
    • "balanceInValueDate": 0,
    • "isinCode": "DE000CBK1001",
    • "shortCode": "CBK",
    • "instrumentName": "Erste Group Bank AG",
    • "instrumentType": "Stocks",
    • "provider": "ICF",
    • "mic": "DUSD",
    • "quantity": 0,
    • "price": 0,
    • "priceCurrencyCode": "EUR",
    • "fxRate": 0,
    • "fxRateCalculationMethod": "DIVIDE",
    • "amount": 0,
    • "amountCurrencyCode": "EUR",
    • "isStatementCreatedAndProcessed": true

    }

  ]

}

Get a particular deposit account transaction by id

Returns the transaction response

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
depositAccountTransactionId required	string <uuid> Deposit Account Transaction Id

Responses

/api/depositAccount/{depositAccountId}/transaction/{depositAccountTransactionId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "mark": "Debit",
• "type": "Deposit",
• "dateTime": "2019-08-24T14:15:22Z",
• "bookingDate": "2019-08-24",
• "valueDate": "2019-08-24",
• "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
• "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "comment": "Transaction successful",
• "txKeyId": 0,
• "balanceInBookedDate": 0,
• "balanceInTransactionDate": 0,
• "balanceInValueDate": 0,
• "isinCode": "DE000CBK1001",
• "shortCode": "CBK",
• "instrumentName": "Erste Group Bank AG",
• "instrumentType": "Stocks",
• "provider": "ICF",
• "mic": "DUSD",
• "quantity": 0,
• "price": 0,
• "priceCurrencyCode": "EUR",
• "fxRate": 0,
• "fxRateCalculationMethod": "DIVIDE",
• "amount": 0,
• "amountCurrencyCode": "EUR",
• "isStatementCreatedAndProcessed": true

}

Get transaction tax data of a particular deposit account

Returns the paged transaction tax datas response

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
depositAccountTransactionId required	string <uuid> Deposit Account Id

Responses

/api/depositAccount/{depositAccountId}/transaction/{depositAccountTransactionId}/taxData

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "mark": "Debit",
    • "type": "Deposit",
    • "dateTime": "2019-08-24T14:15:22Z",
    • "bookingDate": "2019-08-24",
    • "valueDate": "2019-08-24",
    • "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
    • "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "comment": "Transaction successful",
    • "txKeyId": 0,
    • "balanceInBookedDate": 0,
    • "balanceInTransactionDate": 0,
    • "balanceInValueDate": 0,
    • "isinCode": "DE000CBK1001",
    • "shortCode": "CBK",
    • "instrumentName": "Erste Group Bank AG",
    • "instrumentType": "Stocks",
    • "provider": "ICF",
    • "mic": "DUSD",
    • "quantity": 0,
    • "price": 0,
    • "priceCurrencyCode": "EUR",
    • "fxRate": 0,
    • "fxRateCalculationMethod": "DIVIDE",
    • "amount": 0,
    • "amountCurrencyCode": "EUR",
    • "isStatementCreatedAndProcessed": true

    }

  ]

}

Get a particular deposit account statement

Returns the corresponding DepositAccountStatementResponse with the given deposit account id and statement identifier.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
year required	string = 4 characters ([0-9]{4}) Identifier - Year
fileNumber required	string = 4 characters ([0-9]{4}) Identifier - File Number

Responses

/api/depositAccount/{depositAccountId}/statement/{year}/{fileNumber}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "createdDate": "2023-01-10",
• "measurementDate": "2023-01-10",
• "contentType": "Application_Pdf",
• "year": "stri",
• "fileNumber": "stri",
• "fileData": "string"

}

Get deposit account statements

Returns the corresponding DepositAccountStatementResponses between given dates.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required

string <uuid> Deposit Account Id

query Parameters

creationDateBegin required	string <date> = 10 characters Example: creationDateBegin=2023-01-01 Date Begin
creationDateEnd required	string <date> = 10 characters Example: creationDateEnd=2023-01-20 Date End
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Page Number
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Records Per Page

Responses

/api/depositAccount/{depositAccountId}/statement

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "createdDate": "2023-01-10",
    • "measurementDate": "2023-01-10",
    • "contentType": "Application_Pdf",
    • "year": "stri",
    • "fileNumber": "stri"

    }

  ]

}

Get a particular deposit account transaction statement

Returns the corresponding DepositAccountTransactionStatement with the given deposit account id and deposit account transaction id.

Authorizations:

BearerOpenIdConnect

path Parameters

depositAccountId required	string <uuid> Deposit Account Id
depositAccountTransactionId required	string <uuid> Deposit Account Transaction Id

Responses

/api/depositAccount/{depositAccountId}/transaction/{depositAccountTransactionId}/statement

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "createdDate": "2019-08-24T14:15:22Z",
• "processed": true,
• "processedDate": "2019-08-24T14:15:22Z",
• "errorCode": 0,
• "errorInfo": "string",
• "statementData": "string",
• "contentType": "Unknown"

}

ExemptionOrder

Create or update an exemption order

Create a new exemption order on one or multiple clients. Update an existing exemption order. Only applicable to retail clients

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Exemption Order Create Request

clientIds required	Array of strings <uuid> [ 1 .. 2 ] items [ items <uuid > ] List of clients attached to this exemption order
applicableAmount required	number <decimal> Applicable amount minimum: 100.00
currencyCode required	string = 3 characters Currency of the applicable amount
validFrom required	string <date> = 10 characters Date from which the exemption order is valid.Must be specified and can only be 1st of January
validUntil	string or null <date> = 10 characters Date until which the exemption order is valid.May be empty but if specified; can only be 31st of December

Responses

/api/exemptionOrder

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "applicableAmount": 0,
• "currencyCode": "EUR",
• "validFrom": "2022-01-01",
• "validUntil": "2022-12-31"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "applicableAmount": 0,
• "currencyCode": "EUR",
• "validFrom": "2019-08-24",
• "validUntil": "2019-08-24",
• "clients": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ]

}

Revoke an existing exemption order

Revoke validUntil date of exemption order under the client Only applicable to retail clients

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Exemption Order Revoke Request

clientIds required	Array of strings <uuid> [ 1 .. 2 ] items [ items <uuid > ] List of clients attached to this exemption order
validUntil required	string <date> = 10 characters Date until which the exemption order is valid

Responses

/api/exemptionOrder/revoke

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "validUntil": "2022-12-31"

}

Response samples

• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Fee

Initiate one time fee request for a cash account

Initiate one time fee request for a cash account

Authorizations:

BearerOpenIdConnect

path Parameters

initiatorOneTimeFeeRequestId required

string initiator's own identifier for the one time fee request

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Informations for one time fee request

internalAccountId required	string <uuid> For which cash account the fee will be applied.
depositAccountId	string or null <uuid> Optional Deposit Account Id information requested by Disacon.
totalFeeAmount required	number <decimal> money x-format: numeric(15,2)
totalFeeCurrencyCode required	string = 3 characters Currency code of the total fee.
remittanceText required	string [ 1 .. 140 ] characters
valueDate	string or null <date> = 10 characters
	Array of objects or null (OneTimeFeeRequestFeeAmount) Fee details for the current one time fee.

Responses

/api/fee/oneTimeFeeRequest/{initiatorOneTimeFeeRequestId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "totalFeeAmount": 0,
• "totalFeeCurrencyCode": "EUR",
• "remittanceText": "string",
• "valueDate": "2019-08-24",
• "feeAmounts": [

  • {

    • "feeType": "WealthManagementFeeGeneral",
    • "feeAmount": 0,
    • "feeCurrencyCode": "EUR",
    • "feeBeneficiaryParty": "Tenant"

    }

  ]

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "totalFeeAmount": 0,
• "totalFeeCurrencyCode": "EUR",
• "remittanceText": "string",
• "valueDate": "2019-08-24",
• "feeAmounts": [

  • {

    • "feeType": "WealthManagementFeeGeneral",
    • "feeAmount": 0,
    • "feeCurrencyCode": "EUR",
    • "feeBeneficiaryParty": "Tenant"

    }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorOneTimeFeeRequestId": "ABC12345678",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "isAutoApproved": true,
• "approvalStatus": true,
• "approvalStatusUpdateDate": "2019-08-24T14:15:22Z",
• "approvalUserId": "f3f47d17-f721-42dc-9aa3-60120d66cf19",
• "processingStatus": true,
• "processingStatusUpdateDate": "2019-08-24T14:15:22Z",
• "processingResult": "One time fee request processed with success"

}

Get supported fee types

Returns the supported (active) fee types and fee details.

Authorizations:

BearerOpenIdConnect

Responses

/api/fee/oneTimeFeeRequest/supportedFeeTypes

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "feeType": "Provision",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "isActive": true,
  • "allowedMinAmount": 0,
  • "allowedMaxAmount": 0,
  • "currencyCode": "str",
  • "checkLowerAmountThreshold": true,
  • "checkHigherAmountThreshold": true,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

  }

]

Get one time fee requests

Returns the corresponding one time fee requests with the given criteria.

Authorizations:

BearerOpenIdConnect

query Parameters

timeStart	string <date-time> One Time Fee Request Creation Date-Begin
timeEnd	string <date-time> One Time Fee Request Creation Date-End
internalAccountId	string <uuid> Internal Account Id
feeType	string Enum: "Adjustment" "RegisterNameSharesToRegistryFee" "BalanceConfirmationFee" "WealthManagementFeeGeneral" "WealthManagementFeeNonShares" "WealthManagementFeeShares" Fee Type
approvalStatus	Array of booleans Status of the Requests.(approved or not)
processingStatus	Array of booleans Processing Status of the Requests.(processed or not)
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Page Number
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Records Per Page

Responses

/api/fee/oneTimeFeeRequest

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
    • "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
    • "totalFeeAmount": 0,
    • "totalFeeCurrencyCode": "EUR",
    • "remittanceText": "string",
    • "valueDate": "2019-08-24",
    • "feeAmounts": [

      • {

        • "feeType": "WealthManagementFeeGeneral",
        • "feeAmount": 0,
        • "feeCurrencyCode": "EUR",
        • "feeBeneficiaryParty": "Tenant"

        }

      ],
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorOneTimeFeeRequestId": "ABC12345678",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "isAutoApproved": true,
    • "approvalStatus": true,
    • "approvalStatusUpdateDate": "2019-08-24T14:15:22Z",
    • "approvalUserId": "f3f47d17-f721-42dc-9aa3-60120d66cf19",
    • "processingStatus": true,
    • "processingStatusUpdateDate": "2019-08-24T14:15:22Z",
    • "processingResult": "One time fee request processed with success"

    }

  ]

}

Get one time fee request by request Id

Returns the corresponding one time fee request with the given request id.

Authorizations:

BearerOpenIdConnect

path Parameters

oneTimeFeeRequestId required

string <uuid> One time fee request Id

Responses

/api/fee/oneTimeFeeRequest/{oneTimeFeeRequestId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "totalFeeAmount": 0,
• "totalFeeCurrencyCode": "EUR",
• "remittanceText": "string",
• "valueDate": "2019-08-24",
• "feeAmounts": [

  • {

    • "feeType": "WealthManagementFeeGeneral",
    • "feeAmount": 0,
    • "feeCurrencyCode": "EUR",
    • "feeBeneficiaryParty": "Tenant"

    }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorOneTimeFeeRequestId": "ABC12345678",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "isAutoApproved": true,
• "approvalStatus": true,
• "approvalStatusUpdateDate": "2019-08-24T14:15:22Z",
• "approvalUserId": "f3f47d17-f721-42dc-9aa3-60120d66cf19",
• "processingStatus": true,
• "processingStatusUpdateDate": "2019-08-24T14:15:22Z",
• "processingResult": "One time fee request processed with success"

}

Approve one time fee request

Approves or rejects the waiting one time fee request

Authorizations:

BearerOpenIdConnect

path Parameters

oneTimeFeeRequestId required

string <uuid> One Time Fee Request Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Status of the Request.(approved or not)

boolean

Responses

/api/fee/oneTimeFeeRequest/{oneTimeFeeRequestId}/approve

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

true

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "totalFeeAmount": 0,
• "totalFeeCurrencyCode": "EUR",
• "remittanceText": "string",
• "valueDate": "2019-08-24",
• "feeAmounts": [

  • {

    • "feeType": "WealthManagementFeeGeneral",
    • "feeAmount": 0,
    • "feeCurrencyCode": "EUR",
    • "feeBeneficiaryParty": "Tenant"

    }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorOneTimeFeeRequestId": "ABC12345678",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "isAutoApproved": true,
• "approvalStatus": true,
• "approvalStatusUpdateDate": "2019-08-24T14:15:22Z",
• "approvalUserId": "f3f47d17-f721-42dc-9aa3-60120d66cf19",
• "processingStatus": true,
• "processingStatusUpdateDate": "2019-08-24T14:15:22Z",
• "processingResult": "One time fee request processed with success"

}

Helpers

Returns list of all federal states

Authorizations:

BearerOpenIdConnect

Responses

/api/helpers/federalStates

Response samples

• 200
• 400
• 409
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Returns list of all employment sector definitons

Authorizations:

BearerOpenIdConnect

Responses

/api/helpers/employment/sector

Response samples

• 200
• 400
• 409
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Returns list of divisions for requested classification code

Authorizations:

BearerOpenIdConnect

path Parameters

classificationCode required

string Classification code

Responses

/api/helpers/employment/{classificationCode}/division

Response samples

• 200
• 400
• 409
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Returns list of possible event reports that can be generated by the system

Authorizations:

BearerOpenIdConnect

Responses

/api/helpers/eventReportDetails

Response samples

• 200
• 400
• 409
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Returns list of api return code details that can be generated by the order management api

Authorizations:

BearerOpenIdConnect

Responses

/api/helpers/returnCodeDetails

Response samples

• 200
• 400
• 409
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

InternalAccount

Create new internal account

Creates a new internal account for the client(s) corresponding to InternalAccountRequest

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Internal Account Request Informations

alias	string or null <= 70 characters Alias for the account.
clientIds	Array of strings or null <uuid> Owner(s) of the account. It may be a personal or joint account.
currencyCode required	string = 3 characters Currency code of the internal account. It should be a valid currency code. Otherwise service returns HTTP 400 (Bad Request) response.
accountUsageType required	string Enum: "PortfolioManagement" "Brokerage"
accountScope	string or null Enum: "Customer" "PEA" "CPD" "RBA"

Responses

/api/internalAccount

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "alias": "SomeAliasForThisAccount",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "currencyCode": "EUR",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer"

}

Response samples

• 200
• 400
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "alias": "ExampleAlias",
• "currencyCode": "EUR",
• "dispositionLimit": 12.34,
• "blockedAmount": 12.34,
• "status": "Active",
• "iban": "DE30000000000000000108",
• "bic": "DEUTDEFFXXX",
• "accountNumber": "00000089",
• "sortCode": "00000000",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "clientIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z"

}

Get list of internal accounts

Returns the corresponding internal accounts with the given criteria. At least one of the following parameters should be sent:

• accountId
• iban
• accountNumber
• dateTimeStart/dateTimeEnd

Authorizations:

BearerOpenIdConnect

query Parameters

clientId	string <uuid> Client Id
accountId	string <uuid> Internal Account Id
iban	string Example: iban=DE30000000000000000108 IBAN of the Internal Account
accountNumber	string Example: accountNumber=0000000089 Account Number of the Internal Account
accountStatuses	string Example: accountStatuses=Initial, Active Account Statuses of the Internal Account
dateTimeStart	string <date-time> Example: dateTimeStart=2023-01-01T13:46:27.975Z Internal Account Creation Date-Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2023-01-14T13:46:27.975Z Internal Account Creation Date-End
createdUserId	string <uuid> Internal Account Create User
accountScope	string Enum: "Customer" "PEA" "CPD" "RBA" Example: accountScope=Customer Scope of the Internal Account
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/internalAccount

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "alias": "ExampleAlias",
    • "currencyCode": "EUR",
    • "dispositionLimit": 12.34,
    • "blockedAmount": 12.34,
    • "status": "Active",
    • "iban": "DE30000000000000000108",
    • "bic": "DEUTDEFFXXX",
    • "accountNumber": "00000089",
    • "sortCode": "00000000",
    • "accountUsageType": "PortfolioManagement",
    • "accountScope": "Customer",
    • "clientIds": [

      • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ]

}

Update internal account status

Updates the status of internal account with initial, active, suspended or deleted

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Account Status Request

status required	string Enum: "Initial" "Active" "Suspended" "Deleted" "Closed" "InClosure" Requested status of the account.
closeOrDeleteReason	string or null <= 512 characters Account close or delete reason. Free format.Not required. Max length 512

Responses

/api/internalAccount/{internalAccountId}/status

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "status": "Active",
• "closeOrDeleteReason": "string"

}

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Initiate interest settlement process for the internal account, when account status is in InClosure

Initiate interest settlement process for the internal account, when account status is in InClosure

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Responses

/api/internalAccount/{internalAccountId}/interestSettlement

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Update internal account alias

Updates the alias of internal account

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
alias required	string Example: SomeAliasForThisAccount New alias for the internal account

Responses

/api/internalAccount/{internalAccountId}/alias/{alias}

Response samples

• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

Get an internal account

Returns the corresponding internal account with the given internal account id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Responses

/api/internalAccount/{internalAccountId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "alias": "Example alias",
• "currencyCode": "EUR",
• "dispositionLimit": 12.34,
• "blockedAmount": 12.34,
• "externalBlockedAmount": 12.34,
• "status": "Initial",
• "iban": "DE30000000000000000108",
• "bic": "DEUTDEFFXXX",
• "accountNumber": "00000089",
• "sortCode": "00000000",
• "clientList": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Onboarded",
    • "clientKey": "Example Client Key",
    • "name": "Max",
    • "surname": "Mustermann",
    • "email": "user@example.com",
    • "countryOfOrigin": "DEU",
    • "nationality": "DEU",
    • "dateOfBirth": "1980-11-03",
    • "placeOfBirth": "DEU",
    • "maritalStatus": "Married",
    • "partnerTo": "beeb189e-6602-4378-a7bd-346c1a7cf864",
    • "establishedDate": "2022-08-31",
    • "clientType": "Business",
    • "clientSubType": "DesignatedSponsor",
    • "riskClass": "Low",
    • "clientLEI": "stringstringstringst",
    • "identityNumberType": "NotSet",
    • "identityNumber": "345678901234",
    • "liableToTax": true,
    • "federalState": "DE-HE",
    • "defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
    • "defaultInternalAccountId": "8e43b8da-398f-45d7-b542-31497dfc86d1",
    • "defaultDepositAccountId": "80b4b163-78a4-4081-9548-2a6753682aed",
    • "hasIdentityUser": true,
    • "birthName": "Max",
    • "title": "Prof.",
    • "gender": "Male",
    • "salutation": "Mrs.",
    • "language": "de_DE",
    • "communicationWithPostAllowed": true,
    • "communicationWithEmailAllowed": true,
    • "communicationWithPhoneAllowed": true,
    • "contractualPartnerCode": "CP0001",
    • "occupationGroup": "Other",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759"

    }

  ],
• "closeOrDeleteReason": "string",
• "accountUsageType": "PortfolioManagement",
• "accountScope": "Customer",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get available withdrawal balance for any internal account

Returns the available withdrawal balance of the account with the given internal account id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Responses

/api/internalAccount/{internalAccountId}/availableWithdrawalBalance

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "balance": 0,
• "currencyCode": "EUR"

}

Get total balance for any internal account

Returns the total balance of the account with the given internal account id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Responses

/api/internalAccount/{internalAccountId}/totalBalance

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "balance": 0,
• "currencyCode": "EUR"

}

Get available trade balance for any internal account

Returns the available trade balance of the account with the given internal account id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

Responses

/api/internalAccount/{internalAccountId}/availableTradeBalance

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "balance": 0,
• "currencyCode": "EUR"

}

Get transactions of a particular internal account

Returns the paged transactions response

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

query Parameters

Mark	string Enum: "Debit" "Credit" "Neutral"
Type	string Enum: "Deposit" "Withdrawal" "Buy" "Sell" "Dividend" "BlockageReserve" "BlockageRelease" "FractionsBuy" "FractionsSell" "SecurityTransferWOData" "SecurityTransferWithData" "SecurityReorganisation" "Maturity" "CapitalGainsTax" "SolidaritySurcharge" "ChurchTax" "TaxDeclaration" "Securities" "DepositReversal" "WithdrawalReversal" "BuyReversal" "SellReversal" "DividentReversal" "BlockageReserveReversal" "BlockageReleaseReversal" "FractionsBuyReversal" "FractionsSellReversal" "SecurityTransferWODataReversal" "SecurityTransferWithDataReversal" "SecurityReorganisationReversal" "MaturityReversal" "CapitalGainsTaxReversal" "SolidaritySurchargeReversal" "ChurchTaxReversal" "TaxDeclarationReversal" "SecuritiesReversal" "MoneySent" "MoneyReceived" "MoneySentReversal" "MoneyReceivedReversal" "Other" "OtherReversal" "InterestSettlement" "InterestSettlementReversal" "SepaDirectDebitDeposit" "SepaDirectDebitRefund" "CashBalanceAdjustment" "OneTimeFee" "OneTimeFeeReversal" "TaxRefund" "TaxRefundReversal"
PostingText	string Example: PostingText=BlockageReserve/LU0431139764x2,0/MARKET
MinAmount	number <decimal>
MaxAmount	number <decimal>
DateBegin	string
DateEnd	string
pageNumber	integer <int32> Default: 1 Page Number
recordsPerPage	integer <int32> Default: 100 Records Per Page

Responses

/api/internalAccount/{internalAccountId}/transaction

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "mark": "Debit",
    • "type": "Deposit",
    • "dateTime": "2019-08-24T14:15:22Z",
    • "bookingDate": "2019-08-24",
    • "valueDate": "2019-08-24",
    • "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
    • "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "comment": "Transaction successful",
    • "txKeyId": 0,
    • "balanceInBookedDate": 0,
    • "balanceInTransactionDate": 0,
    • "balanceInValueDate": 0,
    • "amount": 0,
    • "amountCurrencyCode": "EUR",
    • "counterAccountHolderName": "Max Mustermann",
    • "counterAccountBic": "DEUTDEFFXXX",
    • "counterAccountIban": "DE89370400440532013000",
    • "counterAccountNumber": "1234567890",
    • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
    • "isStatementCreatedAndProcessed": true,
    • "bookedMetadata": {

      • "automaticInterestSettlement": {

        • "batchSize": 0,
        • "cycle": "M",
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"

        },
      • "interestSettlement": {

        • "accountNumber": "string",
        • "cycle": "S",
        • "interestMethod": "string",
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"

        },
      • "interestSettlementAmount": [

        • {

          • "balance": "string",
          • "dateFrom": "2019-08-24",
          • "dateTo": "2019-08-24",
          • "yearDays": 0,
          • "interestDays": 0,
          • "interestRate": "string",
          • "currency": "EUR",
          • "interestAmount": "string"

          }

        ]

      }

    }

  ]

}

Get a particular internal account transaction by id

Returns the transaction response

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
internalAccountTransactionId required	string <uuid> Internal Account Transaction Id

Responses

/api/internalAccount/{internalAccountId}/transaction/{internalAccountTransactionId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "mark": "Debit",
• "type": "Deposit",
• "dateTime": "2019-08-24T14:15:22Z",
• "bookingDate": "2019-08-24",
• "valueDate": "2019-08-24",
• "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
• "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
• "comment": "Transaction successful",
• "txKeyId": 0,
• "balanceInBookedDate": 0,
• "balanceInTransactionDate": 0,
• "balanceInValueDate": 0,
• "amount": 0,
• "amountCurrencyCode": "EUR",
• "counterAccountHolderName": "Max Mustermann",
• "counterAccountBic": "DEUTDEFFXXX",
• "counterAccountIban": "DE89370400440532013000",
• "counterAccountNumber": "1234567890",
• "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
• "isStatementCreatedAndProcessed": true,
• "bookedMetadata": {

  • "automaticInterestSettlement": {

    • "batchSize": 0,
    • "cycle": "M",
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24"

    },
  • "interestSettlement": {

    • "accountNumber": "string",
    • "cycle": "S",
    • "interestMethod": "string",
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24"

    },
  • "interestSettlementAmount": [

    • {

      • "balance": "string",
      • "dateFrom": "2019-08-24",
      • "dateTo": "2019-08-24",
      • "yearDays": 0,
      • "interestDays": 0,
      • "interestRate": "string",
      • "currency": "EUR",
      • "interestAmount": "string"

      }

    ]

  }

}

Get transaction tax data of a particular internal account

Returns the paged transaction tax datas response

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
internalAccountTransactionId required	string <uuid> Internal Account Transaction Id

Responses

/api/internalAccount/{internalAccountId}/transaction/{internalAccountTransactionId}/taxData

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "mark": "Debit",
    • "type": "Deposit",
    • "dateTime": "2019-08-24T14:15:22Z",
    • "bookingDate": "2019-08-24",
    • "valueDate": "2019-08-24",
    • "postingText": "BlockageReserve/LU0431139764x2,0/MARKET",
    • "endToEndId": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "customerReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bookingReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "bankReference": "02849937-8ef2-4290-bc9b-c03d4d1060b7",
    • "comment": "Transaction successful",
    • "txKeyId": 0,
    • "balanceInBookedDate": 0,
    • "balanceInTransactionDate": 0,
    • "balanceInValueDate": 0,
    • "isinCode": "DE000CBK1001",
    • "shortCode": "CBK",
    • "instrumentName": "Erste Group Bank AG",
    • "instrumentType": "Stocks",
    • "provider": "ICF",
    • "mic": "DUSD",
    • "quantity": 0,
    • "price": 0,
    • "priceCurrencyCode": "EUR",
    • "fxRate": 0,
    • "fxRateCalculationMethod": "DIVIDE",
    • "amount": 0,
    • "amountCurrencyCode": "EUR",
    • "isStatementCreatedAndProcessed": true

    }

  ]

}

Withdraw money from an internal account

Creates a withdrawal request with waiting approval status. Requests will be automatically approved if it is less than the determined amount

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
initiatorWithdrawalRequestId required	string initiator's own identifier for the withdrawal request

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Informations for withdrawal request

clientId required	string <uuid> Id of the client
bankAccountId required	string <uuid> Bank account of the withdrawal request.
currencyCode required	string = 3 characters Currency code of the withdrawal request.
withdrawalAmount required	number <decimal> Amount of the withdrawal request.

Responses

/api/internalAccount/{internalAccountId}/withdrawalRequest/{initiatorWithdrawalRequestId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "clientId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "bankAccountId": "9861F349-F5EF-4B59-4514-08DBD0272F4F",
• "currencyCode": "EUR",
• "withdrawalAmount": 4

}

Response samples

• 200
• 400
• 409
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "bankAccountId": "9861F349-F5EF-4B59-4514-08DBD0272F4F",
• "currencyCode": "EUR",
• "withdrawalAmount": 4,
• "id": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "initiatorWithdrawalRequestId": "ABC12345678",
• "tenantId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "createdDate": "2023-06-19 11:51:57.8449356",
• "createdUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "approvalStatus": true,
• "approvalStatusUpdateDate": "2023-06-19 12:14:24.3666667",
• "approvalUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "processingStatus": true,
• "processingStatusUpdateDate": "2023-06-19 12:14:24.3666667",
• "processingResult": "withdrawal request processed with success"

}

Get internal account withdrawal request by withdrawal request id

Returns the corresponding internal account withdrawal request of an internal account.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
initiatorWithdrawalRequestId required	string Initiator Withdrawal Request Id

Responses

/api/internalAccount/{internalAccountId}/withdrawalRequest/{initiatorWithdrawalRequestId}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "clientId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "bankAccountId": "9861F349-F5EF-4B59-4514-08DBD0272F4F",
• "currencyCode": "EUR",
• "withdrawalAmount": 4,
• "id": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "initiatorWithdrawalRequestId": "ABC12345678",
• "tenantId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "createdDate": "2023-06-19 11:51:57.8449356",
• "createdUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "approvalStatus": true,
• "approvalStatusUpdateDate": "2023-06-19 12:14:24.3666667",
• "approvalUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "processingStatus": true,
• "processingStatusUpdateDate": "2023-06-19 12:14:24.3666667",
• "processingResult": "withdrawal request processed with success"

}

Get internal account withdrawal requests by internal account

Returns the corresponding internal account withdrawal requests of an internal account.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

query Parameters

timeStart required	string <date-time> Example: timeStart=2024-01-01 Internal Account Withdrawal Request Creation Date-Begin
timeEnd required	string <date-time> Example: timeEnd=2024-01-10 Internal Account Withdrawal Request Creation Date-End

Responses

/api/internalAccount/{internalAccountId}/withdrawalRequest

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "clientId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
  • "bankAccountId": "9861F349-F5EF-4B59-4514-08DBD0272F4F",
  • "currencyCode": "EUR",
  • "withdrawalAmount": 4,
  • "id": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
  • "initiatorWithdrawalRequestId": "ABC12345678",
  • "tenantId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
  • "internalAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
  • "createdDate": "2023-06-19 11:51:57.8449356",
  • "createdUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
  • "approvalStatus": true,
  • "approvalStatusUpdateDate": "2023-06-19 12:14:24.3666667",
  • "approvalUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
  • "processingStatus": true,
  • "processingStatusUpdateDate": "2023-06-19 12:14:24.3666667",
  • "processingResult": "withdrawal request processed with success"

  }

]

Get a particular internal account statement

Returns the corresponding InternalAccountStatementResponse with the given internal account id and statement identifier.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
year required	string = 4 characters ([0-9]{4}) Statement Identifier - Year
fileNumber required	string = 4 characters ([0-9]{4}) Statement Identifier - File Number

Responses

/api/internalAccount/{internalAccountId}/statement/{year}/{fileNumber}

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "createdDate": "2023-01-10",
• "dateFrom": "2023-01-10",
• "dateTo": "2023-01-15",
• "currency": "EUR",
• "startBalance": 15,
• "endBalance": 10.25,
• "contentType": "Application_Pdf",
• "year": "stri",
• "fileNumber": "stri",
• "fileData": "string"

}

Get internal account statements

Returns the corresponding InternalAccountStatementResponses between given dates.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

query Parameters

creationDateBegin required	string <date> = 10 characters Example: creationDateBegin=2023-01-01 Date Begin
creationDateEnd required	string <date> = 10 characters Example: creationDateEnd=2023-01-20 Date End
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Page Number
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Records Per Page

Responses

/api/internalAccount/{internalAccountId}/statement

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "createdDate": "2023-01-10",
    • "dateFrom": "2023-01-10",
    • "dateTo": "2023-01-15",
    • "currency": "EUR",
    • "startBalance": 15,
    • "endBalance": 10.25,
    • "contentType": "Application_Pdf",
    • "year": "stri",
    • "fileNumber": "stri"

    }

  ]

}

Get available floating balance for any internal account

Returns the available floating balance of the account with the given internal account id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required

string <uuid> Internal Account Id

query Parameters

tradeProvider required	string Enum: "ICF" "AllFunds" "TickTS" "Unknown" Trade Provider
cutoffDate required	string Internal Account Id
cutoffTime required	string Internal Account Id

Responses

/api/internalAccount/{internalAccountId}/availableFloatingBalance

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "balance": 0,
• "currencyCode": "EUR"

}

Get a particular internal account transaction statement

Returns the corresponding InternalAccountTransactionStatement with the given internal account id and internal account transaction id.

Authorizations:

BearerOpenIdConnect

path Parameters

internalAccountId required	string <uuid> Internal Account Id
internalAccountTransactionId required	string <uuid> Internal Account Transaction Id

Responses

/api/internalAccount/{internalAccountId}/transaction/{internalAccountTransactionId}/statement

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "createdDate": "2019-08-24T14:15:22Z",
• "processed": true,
• "processedDate": "2019-08-24T14:15:22Z",
• "errorCode": 0,
• "errorInfo": "string",
• "statementData": "string",
• "contentType": "Unknown"

}

MoneyManagement

Create a SEPA direct debit mandate creditor for the tenant

Returns created SEPA direct debit mandate creditor entity

Authorizations:

BearerOpenIdConnect

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SEPA Direct Debit Mandate Creditor base

creditorId required	string [ 1 .. 35 ] characters Creditor Id (A.k.a: Glaubiger-Id in Germany)
creditorName required	string [ 1 .. 70 ] characters Creditor name
pspName	string or null <= 70 characters PSP name of the Creditor
nameExtension	string or null <= 35 characters Name extension. E.g. second first Name or salutation etc.
streetOrPostOfficeBox required	string [ 1 .. 35 ] characters Street, house number or post office box
cityZipCountry required	string [ 1 .. 35 ] characters City, zip code and country
isoCountryAlpha2Code required	string = 2 characters Iso country code (alpha 2 code)

Responses

/api/moneyManagement/sepaDirectDebitMandateCreditor

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE"

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397"

}

Get existing SEPA direct mandate creditors created for the tenant

Returns all SEPA direct debit mandate creditor entities that are linked to the tenant

Authorizations:

BearerOpenIdConnect

query Parameters

sepaDirectDebitMandateCreditorId	string Id of the SEPA Direct Debit Mandate Creditor
creditorName	string Name of the SEPA Direct Debit Mandate Creditor
pspName	string PSP Name of the SEPA Direct Debit Mandate Creditor
createdUserId	string <uuid> SEPA Direct Debit Mandate Creditor Create User
dateTimeStart	string <date-time> Example: dateTimeStart=2023-01-01T13:46:27.975Z SEPA Direct Debit Mandate Creditor Creation Date-Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2023-01-14T13:46:27.975Z SEPA Direct Debit Mandate Creditor Creation Date-End
isValid	boolean Validation Status of the SEPA Direct Debit Mandate Creditor
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/moneyManagement/sepaDirectDebitMandateCreditor

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "creditorId": "DE02ZZZ1234567890",
    • "creditorName": "Max Mustermann",
    • "pspName": "PSP",
    • "nameExtension": "Mr.",
    • "streetOrPostOfficeBox": "34",
    • "cityZipCountry": "CityName, 34000, CountryName",
    • "isoCountryAlpha2Code": "DE",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "isValid": true,
    • "invalidatedAt": "2019-08-24T14:15:22Z",
    • "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397"

    }

  ]

}

Update SEPA direct debit mandate creditor for the tenant

Returns updated SEPA direct debit mandate creditor entity

Authorizations:

BearerOpenIdConnect

path Parameters

sepaDirectDebitMandateCreditorId required

string <uuid>

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SEPA Direct Debit Mandate Creditor base

creditorId required	string [ 1 .. 35 ] characters Creditor Id (A.k.a: Glaubiger-Id in Germany)
creditorName required	string [ 1 .. 70 ] characters Creditor name
pspName	string or null <= 70 characters PSP name of the Creditor
nameExtension	string or null <= 35 characters Name extension. E.g. second first Name or salutation etc.
streetOrPostOfficeBox required	string [ 1 .. 35 ] characters Street, house number or post office box
cityZipCountry required	string [ 1 .. 35 ] characters City, zip code and country
isoCountryAlpha2Code required	string = 2 characters Iso country code (alpha 2 code)

Responses

/api/moneyManagement/sepaDirectDebitMandateCreditor/{sepaDirectDebitMandateCreditorId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE"

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397"

}

Get an existing SEPA direct debit mandate creditor by id

Returns corresponding SEPA direct debit mandate creditor entity

Authorizations:

BearerOpenIdConnect

path Parameters

sepaDirectDebitMandateCreditorId required

string <uuid> Id of the target SEPA Direct Debit Mandate Creditor

Responses

/api/moneyManagement/sepaDirectDebitMandateCreditor/{sepaDirectDebitMandateCreditorId}

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397"

}

Invalidate an existing SEPA direct debit mandate creditor

Returns updated SEPA direct debit mandate creditor entity

Authorizations:

BearerOpenIdConnect

path Parameters

sepaDirectDebitMandateCreditorId required

string <uuid> Id of the target SEPA Direct Debit Mandate Creditor

Responses

/api/moneyManagement/sepaDirectDebitMandateCreditor/{sepaDirectDebitMandateCreditorId}/invalidate

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "creditorId": "DE02ZZZ1234567890",
• "creditorName": "Max Mustermann",
• "pspName": "PSP",
• "nameExtension": "Mr.",
• "streetOrPostOfficeBox": "34",
• "cityZipCountry": "CityName, 34000, CountryName",
• "isoCountryAlpha2Code": "DE",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397"

}

Create a SEPA direct debit mandate on a particular bank account

Returns created SEPA direct debit mandate entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Id of the source bank account

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SEPA Direct Debit Mandate request

mandateReference required	string [ 1 .. 35 ] characters Reference text for the mandate
mandateType required	string Enum: "Electronic" "Paper"
directDebitType required	string Enum: "CORE" "COR1" "B2B"
allowedSequenceTypes required	string Enum: "OnlySingleDebit" "OnlyRecurring" "All"
mandateDate required	string <date> = 10 characters YYYY-MM-DD date
validFrom required	string <date> = 10 characters YYYY-MM-DD date
validUntil required	string <date> = 10 characters YYYY-MM-DD date
sepaDirectDebitMandateCreditorId required	string <uuid> System Generated Id of the Sepa Direct Debit Mandate Creditor
defaultClientId required	string <uuid> If banking partner does not support multiple account owner structure, then information of this client is used to derive debitor information. Should be set to one of the owner's of the bank account
	Array of objects or null (UploadedDocumentBase)

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "mandateReference": "123456",
• "mandateType": "Electronic",
• "directDebitType": "CORE",
• "allowedSequenceTypes": "OnlySingleDebit",
• "mandateDate": "2023-01-11",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "sepaDirectDebitMandateCreditorId": "5b70d8dc-8ed1-4403-8284-0ae9ffc60282",
• "defaultClientId": "0115d593-59ee-4a8f-a207-9b4e14d1c73d",
• "uploadedDocuments": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31"

    }

  ]

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "mandateReference": "123456",
• "mandateType": "Electronic",
• "directDebitType": "CORE",
• "allowedSequenceTypes": "OnlySingleDebit",
• "mandateDate": "2023-01-11",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
• "debitor": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bic": "DEUTDEFFXXX",
  • "iban": "DE30000000000000000108",
  • "isoCurrencyCode": "EUR",
  • "accountHolderName": "Max Mustermann",
  • "name": "Max",
  • "surname": "Mustermann",
  • "ultimateDebitorName": "Max Mustermann",
  • "nameExtension": "Mrs.",
  • "addressLine1": "Address line 1",
  • "addressLine2": "Address line 2",
  • "postalCode": "12345",
  • "city": "Some city",
  • "region": "Some region",
  • "countryCode": "DEU",
  • "languageCode": "de",
  • "email": "somebody@somewhere.com",
  • "phoneNumber": "+14155554345"

  },
• "sepaDirectDebitMandateCreditorId": "5b70d8dc-8ed1-4403-8284-0ae9ffc60282",
• "uploadedDocuments": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "isExpired": true,
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397",
• "sepaDirectDebitInstructions": [

  • {

    • "instructedAmount": 0,
    • "isoCurrencyCode": "EUR",
    • "sequenceType": "SingleDebit",
    • "requestedExecutionDate": "2022-06-03",
    • "executionDay": "At1st",
    • "validUntil": "2023-06-03",
    • "remittanceText": "Example Remittance Text",
    • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
    • "status": "Initial",
    • "executions": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
        • "sequenceType": "First",
        • "status": "Initial",
        • "memo": "string",
        • "executionDate": "2019-08-24",
        • "uploadDate": "2019-08-24",
        • "moneyReceivedDate": "2019-08-24",
        • "paymentRevertionDate": "2019-08-24",
        • "postEvaluationStatus": "Waiting",
        • "postEvaluationProcessingStatus": "Waiting",
        • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
        • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
        • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
        • "isAutoDenyWithoutAML": true,
        • "refundId": "string",
        • "isMoneyInCPDAccount": true,
        • "insertDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "cancellationDate": "2019-08-24T14:15:22Z",
    • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get existing SEPA direct debit mandates on a particular bank account

Returns all SEPA direct debit mandate entities that are linked to a particular bank account

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required

string <uuid> Bank Account Id of the target SEPA Direct Debit Mandate

query Parameters

sepaDirectDebitMandateId	string <uuid> Id of the target SEPA Direct Debit Mandate
sepaDirectDebitMandateCreditorId	string <uuid> Creditor Id of the target SEPA Direct Debit Mandate
name	string Name of the target SEPA Direct Debit Mandate Debitor
surname	string Surname of the target SEPA Direct Debit Mandate Debitor
email	string Email of the target SEPA Direct Debit Mandate Debitor
accountHolderName	string Example: accountHolderName=Max Mustermann Account holder name of the target SEPA Direct Debit Mandate Debitor
iban	string Example: iban=DE30000000000000000108 IBAN of the target SEPA Direct Debit Mandate Debitor
bic	string Bic of the target SEPA Direct Debit Mandate Debitor
city	string City of the target SEPA Direct Debit Mandate Debitor
isoCountryAlpha3Code	string Country code of the target SEPA Direct Debit Mandate Debitor
mandateReference	string Mandate Reference of the target SEPA Direct Debit Mandate
directDebitType	string Enum: "CORE" "COR1" "B2B" Direct Debit Type of the target SEPA Direct Debit Mandate
allowedSequenceTypes	string Enum: "OnlySingleDebit" "OnlyRecurring" "All" Allowed Sequence Types of the target SEPA Direct Debit Mandate
mandateType	string Enum: "Electronic" "Paper" Mandate Type of the target SEPA Direct Debit Mandate
createdUserId	string <uuid> SEPA Direct Debit Mandate Create User
firstCreationDate	string <date-time> Example: firstCreationDate=2023-01-01T13:46:27.975Z SEPA Direct Debit Mandate Creation Date-Begin
lastCreationDate	string <date-time> Example: lastCreationDate=2023-01-14T13:46:27.975Z SEPA Direct Debit Mandate Creation Date-End
mandateStartDate	string <date-time> Example: mandateStartDate=2023-01-01T13:46:27.975Z SEPA Direct Debit Mandate Date-Begin of the Mandate Date
mandateEndDate	string <date-time> Example: mandateEndDate=2023-01-14T13:46:27.975Z SEPA Direct Debit Mandate Date-End of the Mandate Date
isValid	boolean Validation Status of the SEPA Direct Debit Mandate
isExpired	boolean Expiration Status of the SEPA Direct Debit Mandate
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "mandateReference": "123456",
    • "mandateType": "Electronic",
    • "directDebitType": "CORE",
    • "allowedSequenceTypes": "OnlySingleDebit",
    • "mandateDate": "2023-01-11",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
    • "debitor": {

      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "bic": "DEUTDEFFXXX",
      • "iban": "DE30000000000000000108",
      • "isoCurrencyCode": "EUR",
      • "accountHolderName": "Max Mustermann",
      • "name": "Max",
      • "surname": "Mustermann",
      • "ultimateDebitorName": "Max Mustermann",
      • "nameExtension": "Mrs.",
      • "addressLine1": "Address line 1",
      • "addressLine2": "Address line 2",
      • "postalCode": "12345",
      • "city": "Some city",
      • "region": "Some region",
      • "countryCode": "DEU",
      • "languageCode": "de",
      • "email": "somebody@somewhere.com",
      • "phoneNumber": "+14155554345"

      },
    • "sepaDirectDebitMandateCreditorId": "5b70d8dc-8ed1-4403-8284-0ae9ffc60282",
    • "uploadedDocuments": [

      • {

        • "contentType": "Image_Bmp",
        • "fileData": "0x646174613A696D6...",
        • "label": "A document",
        • "comment": "Some information about this document",
        • "documentType": "Unknown",
        • "fileName": "file_name.jpg",
        • "validFrom": "2023-01-01",
        • "validUntil": "2023-12-31",
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "createdDate": "2019-08-24T14:15:22Z",
        • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
        • "updatedDate": "2019-08-24T14:15:22Z",
        • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

        }

      ],
    • "isExpired": true,
    • "isValid": true,
    • "invalidatedAt": "2019-08-24T14:15:22Z",
    • "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397",
    • "sepaDirectDebitInstructions": [

      • {

        • "instructedAmount": 0,
        • "isoCurrencyCode": "EUR",
        • "sequenceType": "SingleDebit",
        • "requestedExecutionDate": "2022-06-03",
        • "executionDay": "At1st",
        • "validUntil": "2023-06-03",
        • "remittanceText": "Example Remittance Text",
        • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
        • "status": "Initial",
        • "executions": [

          • {

            • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
            • "sequenceType": "First",
            • "status": "Initial",
            • "memo": "string",
            • "executionDate": "2019-08-24",
            • "uploadDate": "2019-08-24",
            • "moneyReceivedDate": "2019-08-24",
            • "paymentRevertionDate": "2019-08-24",
            • "postEvaluationStatus": "Waiting",
            • "postEvaluationProcessingStatus": "Waiting",
            • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
            • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
            • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
            • "isAutoDenyWithoutAML": true,
            • "refundId": "string",
            • "isMoneyInCPDAccount": true,
            • "insertDate": "2019-08-24T14:15:22Z",
            • "updatedDate": "2019-08-24T14:15:22Z"

            }

          ],
        • "createdDate": "2019-08-24T14:15:22Z",
        • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
        • "updatedDate": "2019-08-24T14:15:22Z",
        • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
        • "cancellationDate": "2019-08-24T14:15:22Z",
        • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ]

}

Invalidate an existing SEPA direct debit mandate

Returns updated SEPA direct debit mandate entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the target bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}/invalidate

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "mandateReference": "123456",
• "mandateType": "Electronic",
• "directDebitType": "CORE",
• "allowedSequenceTypes": "OnlySingleDebit",
• "mandateDate": "2023-01-11",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
• "debitor": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bic": "DEUTDEFFXXX",
  • "iban": "DE30000000000000000108",
  • "isoCurrencyCode": "EUR",
  • "accountHolderName": "Max Mustermann",
  • "name": "Max",
  • "surname": "Mustermann",
  • "ultimateDebitorName": "Max Mustermann",
  • "nameExtension": "Mrs.",
  • "addressLine1": "Address line 1",
  • "addressLine2": "Address line 2",
  • "postalCode": "12345",
  • "city": "Some city",
  • "region": "Some region",
  • "countryCode": "DEU",
  • "languageCode": "de",
  • "email": "somebody@somewhere.com",
  • "phoneNumber": "+14155554345"

  },
• "sepaDirectDebitMandateCreditorId": "5b70d8dc-8ed1-4403-8284-0ae9ffc60282",
• "uploadedDocuments": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "isExpired": true,
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397",
• "sepaDirectDebitInstructions": [

  • {

    • "instructedAmount": 0,
    • "isoCurrencyCode": "EUR",
    • "sequenceType": "SingleDebit",
    • "requestedExecutionDate": "2022-06-03",
    • "executionDay": "At1st",
    • "validUntil": "2023-06-03",
    • "remittanceText": "Example Remittance Text",
    • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
    • "status": "Initial",
    • "executions": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
        • "sequenceType": "First",
        • "status": "Initial",
        • "memo": "string",
        • "executionDate": "2019-08-24",
        • "uploadDate": "2019-08-24",
        • "moneyReceivedDate": "2019-08-24",
        • "paymentRevertionDate": "2019-08-24",
        • "postEvaluationStatus": "Waiting",
        • "postEvaluationProcessingStatus": "Waiting",
        • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
        • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
        • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
        • "isAutoDenyWithoutAML": true,
        • "refundId": "string",
        • "isMoneyInCPDAccount": true,
        • "insertDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "cancellationDate": "2019-08-24T14:15:22Z",
    • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get an existing SEPA direct debit mandate by id

Returns corresponding SEPA direct debit mandate entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the target bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "mandateReference": "123456",
• "mandateType": "Electronic",
• "directDebitType": "CORE",
• "allowedSequenceTypes": "OnlySingleDebit",
• "mandateDate": "2023-01-11",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
• "debitor": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bic": "DEUTDEFFXXX",
  • "iban": "DE30000000000000000108",
  • "isoCurrencyCode": "EUR",
  • "accountHolderName": "Max Mustermann",
  • "name": "Max",
  • "surname": "Mustermann",
  • "ultimateDebitorName": "Max Mustermann",
  • "nameExtension": "Mrs.",
  • "addressLine1": "Address line 1",
  • "addressLine2": "Address line 2",
  • "postalCode": "12345",
  • "city": "Some city",
  • "region": "Some region",
  • "countryCode": "DEU",
  • "languageCode": "de",
  • "email": "somebody@somewhere.com",
  • "phoneNumber": "+14155554345"

  },
• "sepaDirectDebitMandateCreditorId": "5b70d8dc-8ed1-4403-8284-0ae9ffc60282",
• "uploadedDocuments": [

  • {

    • "contentType": "Image_Bmp",
    • "fileData": "0x646174613A696D6...",
    • "label": "A document",
    • "comment": "Some information about this document",
    • "documentType": "Unknown",
    • "fileName": "file_name.jpg",
    • "validFrom": "2023-01-01",
    • "validUntil": "2023-12-31",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

    }

  ],
• "isExpired": true,
• "isValid": true,
• "invalidatedAt": "2019-08-24T14:15:22Z",
• "invalidationUserId": "44d79b64-3223-496b-9abd-fd314b777397",
• "sepaDirectDebitInstructions": [

  • {

    • "instructedAmount": 0,
    • "isoCurrencyCode": "EUR",
    • "sequenceType": "SingleDebit",
    • "requestedExecutionDate": "2022-06-03",
    • "executionDay": "At1st",
    • "validUntil": "2023-06-03",
    • "remittanceText": "Example Remittance Text",
    • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
    • "status": "Initial",
    • "executions": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
        • "sequenceType": "First",
        • "status": "Initial",
        • "memo": "string",
        • "executionDate": "2019-08-24",
        • "uploadDate": "2019-08-24",
        • "moneyReceivedDate": "2019-08-24",
        • "paymentRevertionDate": "2019-08-24",
        • "postEvaluationStatus": "Waiting",
        • "postEvaluationProcessingStatus": "Waiting",
        • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
        • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
        • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
        • "isAutoDenyWithoutAML": true,
        • "refundId": "string",
        • "isMoneyInCPDAccount": true,
        • "insertDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "cancellationDate": "2019-08-24T14:15:22Z",
    • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Create a new SEPA direct debit instruction

Returns corresponding SEPA direct debit instruction entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the source bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate
initiatorSepaDirectDebitInstructionId required	string Initiator's own identifier for the SEPA Direct Debit Mandate Instruction

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SEPA Direct Debit Instruction Request

instructedAmount required	number <decimal> Instructed amount
isoCurrencyCode required	string = 3 characters ISO currency code of the account. Default value is 'EUR'
sequenceType required	string Enum: "SingleDebit" "Recurring"
requestedExecutionDate	string or null <date> = 10 characters YYYY-MM-DD date / Desired execution date of the order. Should be at least 1 business day later than today. Only applicable if SequenceType = SingleDebit. If left empty for a SingleDebit request instruction will be submitted to the SEPA network as soon as possible, usually at next business day.
executionDay	string or null Enum: "At1st" "At2nd" "At3rd" "At4th" "At5th" "At6th" "At7th" "At8th" "At9th" "At10th" "At11th" "At12th" "At13th" "At14th" "At15th" "At16th" "At17th" "At18th" "At19th" "At20th" "At21st" "At22nd" "At23rd" "At24th" "At25th" "At26th" "At27th" "At28th" "LastThirdDayOfMonth" "SecondToLastDayOfMonth" "LastDayOfMonth" Desired execution day of the order Required and only applicable if SequenceType = Recurring REMARK: For recurring direct debit instructions, the system will upload the instruction to the banking provider on the specified day of the month. This means the actual execution of the instruction in the SEPA network will occur on the next business day.
validUntil	string or null <date> = 10 characters YYYY-MM-DD date Required and only applicable if SequenceType = Recurring
remittanceText required	string [ 0 .. 140 ] characters Remittance Text
internalAccountId required	string <uuid> Internal Account Id (Cash Account) Of The Client where system will deposit the incoming amount

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}/sepaDirectDebitInstruction/{initiatorSepaDirectDebitInstructionId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "sequenceType": "SingleDebit",
• "requestedExecutionDate": "2022-06-03",
• "executionDay": "At1st",
• "validUntil": "2023-06-03",
• "remittanceText": "Example Remittance Text",
• "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2"

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 421
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "sequenceType": "SingleDebit",
• "requestedExecutionDate": "2022-06-03",
• "executionDay": "At1st",
• "validUntil": "2023-06-03",
• "remittanceText": "Example Remittance Text",
• "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorSepaDirectDebitInstructionId": "ABC12345678",
• "status": "Initial",
• "executions": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
    • "sequenceType": "First",
    • "status": "Initial",
    • "memo": "string",
    • "executionDate": "2019-08-24",
    • "uploadDate": "2019-08-24",
    • "moneyReceivedDate": "2019-08-24",
    • "paymentRevertionDate": "2019-08-24",
    • "postEvaluationStatus": "Waiting",
    • "postEvaluationProcessingStatus": "Waiting",
    • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
    • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
    • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
    • "isAutoDenyWithoutAML": true,
    • "refundId": "string",
    • "isMoneyInCPDAccount": true,
    • "insertDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "cancellationDate": "2019-08-24T14:15:22Z",
• "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

}

Cancel an existing SEPA direct debit instruction (If not uploaded to bank yet)

Returns updated SEPA direct debit instruction entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the target bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate
sepaDirectDebitInstructionId required	string <uuid> Id of the target SEPA Direct Debit Instruction

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}/sepaDirectDebitInstruction/{sepaDirectDebitInstructionId}/cancel

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "sequenceType": "SingleDebit",
• "requestedExecutionDate": "2022-06-03",
• "executionDay": "At1st",
• "validUntil": "2023-06-03",
• "remittanceText": "Example Remittance Text",
• "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorSepaDirectDebitInstructionId": "ABC12345678",
• "status": "Initial",
• "executions": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
    • "sequenceType": "First",
    • "status": "Initial",
    • "memo": "string",
    • "executionDate": "2019-08-24",
    • "uploadDate": "2019-08-24",
    • "moneyReceivedDate": "2019-08-24",
    • "paymentRevertionDate": "2019-08-24",
    • "postEvaluationStatus": "Waiting",
    • "postEvaluationProcessingStatus": "Waiting",
    • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
    • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
    • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
    • "isAutoDenyWithoutAML": true,
    • "refundId": "string",
    • "isMoneyInCPDAccount": true,
    • "insertDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "cancellationDate": "2019-08-24T14:15:22Z",
• "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

}

Get existing SEPA direct debit instructions using the filter parameters

Returns all SEPA direct debit instructions entities that match with the given criteria

Authorizations:

BearerOpenIdConnect

query Parameters

firstCreationDate required	string <date-time> Example: firstCreationDate=2023-01-01T13:46:27.975Z SEPA Direct Debit Instruction Creation Date-Begin
lastCreationDate required	string <date-time> Example: lastCreationDate=2023-01-14T13:46:27.975Z SEPA Direct Debit Instruction Creation Date-End
bankAccountId	string <uuid> Id of the target bank account
sepaDirectDebitMandateId	string <uuid> Id of the target SEPA Direct Debit Mandate
internalAccountId	string <uuid> Id of the target internal account
sepaDirectDebitInstructionId	string <uuid> Id of the target SEPA Direct Debit Instruction
remittanceText	string Remittance Text of the target SEPA Direct Debit Instruction
sequenceType	string Enum: "SingleDebit" "Recurring" Sequence Type of the target SEPA Direct Debit Instruction
instructedAmount	number <decimal> Instructed Amount of the target SEPA Direct Debit Instruction
executionDay	string Enum: "At1st" "At2nd" "At3rd" "At4th" "At5th" "At6th" "At7th" "At8th" "At9th" "At10th" "At11th" "At12th" "At13th" "At14th" "At15th" "At16th" "At17th" "At18th" "At19th" "At20th" "At21st" "At22nd" "At23rd" "At24th" "At25th" "At26th" "At27th" "At28th" "LastThirdDayOfMonth" "SecondToLastDayOfMonth" "LastDayOfMonth" Execution Day of the target SEPA Direct Debit Instruction
requestedExecutionDateStartDate	string <date-time> Example: requestedExecutionDateStartDate=2023-01-01T13:46:27.975Z SEPA Direct Debit Instruction Date-Begin of the Requested Execution Date
requestedExecutionDateEndDate	string <date-time> Example: requestedExecutionDateEndDate=2023-01-14T13:46:27.975Z SEPA Direct Debit Instruction Date-End of the Requested Execution Date
createdUserId	string <uuid> SEPA Direct Debit Instruction Create User
status	string Enum: "Initial" "Cancelled" "Active" "Uploaded" "Expired" "AMLRejected" "AMLWaitingApproval" Status of the target SEPA Direct Debit Instruction
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/moneyManagement/apiMoneyManagementSepaDirectDebitInstruction

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "instructedAmount": 0,
    • "isoCurrencyCode": "EUR",
    • "sequenceType": "SingleDebit",
    • "requestedExecutionDate": "2022-06-03",
    • "executionDay": "At1st",
    • "validUntil": "2023-06-03",
    • "remittanceText": "Example Remittance Text",
    • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
    • "status": "Initial",
    • "executions": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
        • "sequenceType": "First",
        • "status": "Initial",
        • "memo": "string",
        • "executionDate": "2019-08-24",
        • "uploadDate": "2019-08-24",
        • "moneyReceivedDate": "2019-08-24",
        • "paymentRevertionDate": "2019-08-24",
        • "postEvaluationStatus": "Waiting",
        • "postEvaluationProcessingStatus": "Waiting",
        • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
        • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
        • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
        • "isAutoDenyWithoutAML": true,
        • "refundId": "string",
        • "isMoneyInCPDAccount": true,
        • "insertDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "cancellationDate": "2019-08-24T14:15:22Z",
    • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

    }

  ]

}

Get existing SEPA direct debit instructions on a particular mandate

Returns all SEPA direct debit instructions entities that are linked to a particular mandate

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the target bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate

query Parameters

pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}/sepaDirectDebitInstruction

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "instructedAmount": 0,
    • "isoCurrencyCode": "EUR",
    • "sequenceType": "SingleDebit",
    • "requestedExecutionDate": "2022-06-03",
    • "executionDay": "At1st",
    • "validUntil": "2023-06-03",
    • "remittanceText": "Example Remittance Text",
    • "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "initiatorSepaDirectDebitInstructionId": "ABC12345678",
    • "status": "Initial",
    • "executions": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
        • "sequenceType": "First",
        • "status": "Initial",
        • "memo": "string",
        • "executionDate": "2019-08-24",
        • "uploadDate": "2019-08-24",
        • "moneyReceivedDate": "2019-08-24",
        • "paymentRevertionDate": "2019-08-24",
        • "postEvaluationStatus": "Waiting",
        • "postEvaluationProcessingStatus": "Waiting",
        • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
        • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
        • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
        • "isAutoDenyWithoutAML": true,
        • "refundId": "string",
        • "isMoneyInCPDAccount": true,
        • "insertDate": "2019-08-24T14:15:22Z",
        • "updatedDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdDate": "2019-08-24T14:15:22Z",
    • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "cancellationDate": "2019-08-24T14:15:22Z",
    • "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

    }

  ]

}

Get an existing SEPA direct debit instruction by id

Returns corresponding SEPA direct debit instruction entity

Authorizations:

BearerOpenIdConnect

path Parameters

bankAccountId required	string <uuid> Id of the target bank account
sepaDirectDebitMandateId required	string <uuid> Id of the target SEPA Direct Debit Mandate
sepaDirectDebitInstructionId required	string <uuid> Id of the target SEPA Direct Debit Instruction

Responses

/api/moneyManagement/bankAccount/{bankAccountId}/sepaDirectDebitMandate/{sepaDirectDebitMandateId}/sepaDirectDebitInstruction/{sepaDirectDebitInstructionId}

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "sequenceType": "SingleDebit",
• "requestedExecutionDate": "2022-06-03",
• "executionDay": "At1st",
• "validUntil": "2023-06-03",
• "remittanceText": "Example Remittance Text",
• "internalAccountId": "e408f878-4fac-40bb-8bdc-8640840744e2",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "initiatorSepaDirectDebitInstructionId": "ABC12345678",
• "status": "Initial",
• "executions": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "endToEndId": "DE932AE3-89E6-4A48-9932-201226C6C5EF",
    • "sequenceType": "First",
    • "status": "Initial",
    • "memo": "string",
    • "executionDate": "2019-08-24",
    • "uploadDate": "2019-08-24",
    • "moneyReceivedDate": "2019-08-24",
    • "paymentRevertionDate": "2019-08-24",
    • "postEvaluationStatus": "Waiting",
    • "postEvaluationProcessingStatus": "Waiting",
    • "postEvaluationDecisionDateTime": "2019-08-24T14:15:22Z",
    • "postEvaluationDecisionUserId": "2c3ceb7e-cf52-4661-a28d-e2f77f3c07cb",
    • "postEvaluationProcessingDateTime": "2019-08-24T14:15:22Z",
    • "isAutoDenyWithoutAML": true,
    • "refundId": "string",
    • "isMoneyInCPDAccount": true,
    • "insertDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "cancellationDate": "2019-08-24T14:15:22Z",
• "cancellationUser": "2bc2bdfe-0fc9-41dc-909a-d20bc9655ea0"

}

Create a new Payment Instruction

Create a new Payment Instruction from a particular internal account towards a known bank account

Authorizations:

BearerOpenIdConnect

path Parameters

initiatorPaymentId required

string [ 1 .. 36 ] characters Initiator's own identifier for the Single Payment Instruction

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Payment Instruction Request

fromInternalAccountId required	string <uuid> Internal Account Id (Cash Account) Of The Client where system will deposit the incoming amount
toBankAccountId required	string <uuid> Bank Account Id (Reference Account) Of The Client where system will transfer the incoming amount
instructedAmount required	number <decimal> Instructed amount
isoCurrencyCode required	string = 3 characters ISO currency code of the account. Default value is 'EUR'
remittanceText required	string [ 0 .. 105 ] characters Remittance Text

Responses

/api/moneyManagement/paymentInstruction/{initiatorPaymentId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "fromInternalAccountId": "8b24b558-7699-4bdd-a12d-194280adf805",
• "toBankAccountId": "38d097e9-4618-4614-9f04-45e431137594",
• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "remittanceText": "Example Remittance Text"

}

Response samples

• 200
• 400
• 409
• 412
• 413
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "fromInternalAccountId": "8b24b558-7699-4bdd-a12d-194280adf805",
• "toBankAccountId": "38d097e9-4618-4614-9f04-45e431137594",
• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "remittanceText": "Example Remittance Text",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "paymentId": "string",
• "status": "Unknown",
• "source": "Unknown",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

Get an existing Payment Instruction by Initiator's own identifier

Returns corresponding Payment Instruction entity

Authorizations:

BearerOpenIdConnect

path Parameters

initiatorPaymentId required

string [ 1 .. 36 ] characters Initiator's own identifier for the target Payment Instruction

Responses

/api/moneyManagement/paymentInstruction/{initiatorPaymentId}

Response samples

• 200
• 400
• 409
• 412
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "fromInternalAccountId": "8b24b558-7699-4bdd-a12d-194280adf805",
• "toBankAccountId": "38d097e9-4618-4614-9f04-45e431137594",
• "instructedAmount": 0,
• "isoCurrencyCode": "EUR",
• "remittanceText": "Example Remittance Text",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "paymentId": "string",
• "status": "Unknown",
• "source": "Unknown",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"

}

OutgoingDepositTransfer

Get an Outgoing Deposit Transfer Batch

Returns the corresponding Outgoing Deposit Transfer Batch with the given outgoingDepositTransferBatchId.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required

string <uuid> Outgoing Deposit Transfer Batch Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
• "initiatorRequestId": "ABC12345678",
• "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
• "depositAccountNumber": "0000000089",
• "status": "Draft",
• "changeOfOwnership": true,
• "typeOfTransfer": "Paid",
• "specialFeaturesOfTransfer": "Gift",
• "createdDate": "2023-06-19 11:51:57.8449356",
• "createdUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "updatedDate": "2019-08-24T14:15:22Z",
• "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
• "approvalUpdateDate": "2023-06-19 12:14:24.3666667",
• "approvalUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
• "note": "string",
• "signatureChecked": true,
• "targetBank": {

  • "name": "string",
  • "depositAccountNumber": "string",
  • "bic": "DEUTDEFFXXX",
  • "taxBic": "DEUTDEFFXXX",
  • "cblDepositAccountNumber": "string",
  • "cbfDepositAccountNumber": "string",
  • "allFundsDepositAccountNumber": "string",
  • "zipCode": "string",
  • "city": "string",
  • "alpha3CountryCode": "DEU",
  • "custodian": "Clearstream"

  },
• "targetBeneficiaries": [

  • {

    • "accountHolderName": "string",
    • "dateOfBirthOrEstablishment": "1980-11-03",
    • "street": "string",
    • "buildingNo": "string",
    • "zipCode": "string",
    • "city": "string",
    • "alpha3CountryCode": "DEU",
    • "liableToTax": true,
    • "taxId": "string",
    • "id": 0

    }

  ]

}

Get list of Outgoing Deposit Transfer Batch

Returns the corresponding Outgoing Deposit Transfer Batch records with the given criteria. At least one of the following parameters should be sent:

• outgoingDepositTransferBatchId
• initiatorRequestId
• depositAccountId
• transferStatuses
• dateTimeStart/dateTimeEnd

Authorizations:

BearerOpenIdConnect

query Parameters

outgoingDepositTransferBatchId	string <uuid> Outgoing Deposit Transfer Batch Id
initiatorRequestId	string [ 1 .. 36 ] characters Initiator Request Id
depositAccountId	string <uuid> Deposit Account Id
depositAccountNumber	string Example: depositAccountNumber=0000000089 Account Number of the Deposit Account
transferStatuses	string Example: transferStatuses=PendingApproval, Completed Statuses of the Outgoing Deposit Transfer Batch
dateTimeStart	string <date-time> Example: dateTimeStart=2023-01-01T13:46:27.975Z Outgoing Deposit Transfer Batch Creation Date-Begin
dateTimeEnd	string <date-time> Example: dateTimeEnd=2023-01-14T13:46:27.975Z Outgoing Deposit Transfer Batch Creation Date-End
createdUserId	string <uuid> Outgoing Deposit Transfer Batch Create User
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of the list
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page in the list

Responses

/api/depositTransfer/outgoing

Response samples

• 200
• 400
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "pageNumber": 1,
• "recordsPerPage": 50,
• "totalRecordCount": 120,
• "isLastPage": false,
• "data": [

  • {

    • "id": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "initiatorRequestId": "ABC12345678",
    • "depositAccountId": "D49A62B1-4F0A-4419-A282-032AC0B6A378",
    • "depositAccountNumber": "0000000089",
    • "status": "Draft",
    • "changeOfOwnership": true,
    • "typeOfTransfer": "Paid",
    • "specialFeaturesOfTransfer": "Gift",
    • "createdDate": "2023-06-19 11:51:57.8449356",
    • "createdUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee",
    • "approvalUpdateDate": "2023-06-19 12:14:24.3666667",
    • "approvalUserId": "76003F4F-5BAB-4117-9A3F-AA7AE0008FFC",
    • "note": "string",
    • "signatureChecked": true,
    • "targetBank": {

      • "name": "string",
      • "depositAccountNumber": "string",
      • "bic": "DEUTDEFFXXX",
      • "taxBic": "DEUTDEFFXXX",
      • "cblDepositAccountNumber": "string",
      • "cbfDepositAccountNumber": "string",
      • "allFundsDepositAccountNumber": "string",
      • "zipCode": "string",
      • "city": "string",
      • "alpha3CountryCode": "DEU",
      • "custodian": "Clearstream"

      },
    • "targetBeneficiaries": [

      • {

        • "accountHolderName": "string",
        • "dateOfBirthOrEstablishment": "1980-11-03",
        • "street": "string",
        • "buildingNo": "string",
        • "zipCode": "string",
        • "city": "string",
        • "alpha3CountryCode": "DEU",
        • "liableToTax": true,
        • "taxId": "string",
        • "id": 0

        }

      ]

    }

  ]

}

Get Outgoing Deposit Transfer Document

Get Outgoing Deposit Transfer Document with document data under an existing Outgoing Deposit Transfer Batch.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required	string <uuid> Outgoing Deposit Transfer Batch Id
outgoingDepositTransferDocumentId required	string <uuid> Outgoing Deposit Transfer Document Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}/document/{outgoingDepositTransferDocumentId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "contentType": "Image_Bmp",
• "fileData": "0x646174613A696D6...",
• "label": "A document",
• "comment": "Some information about this document",
• "documentType": "Unknown",
• "fileName": "file_name.jpg",
• "validFrom": "2023-01-01",
• "validUntil": "2023-12-31",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "outgoingDepositTransferBatchId": "71a56563-4264-4edb-9cf9-832d73b93b66",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

}

Remove Outgoing Deposit Transfer Document

Remove Outgoing Deposit Transfer Document with document data under an existing Outgoing Deposit Transfer Batch.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required	string <uuid> Outgoing Deposit Transfer Batch Id
outgoingDepositTransferDocumentId required	string <uuid> Outgoing Deposit Transfer Document Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}/document/{outgoingDepositTransferDocumentId}

Response samples

• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "property1": null,
• "property2": null

}

List Outgoing Deposit Transfer Documents

Lists Outgoing Deposit Transfer Documents without document data under an existing Outgoing Deposit Transfer Batch.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required

string <uuid> Outgoing Deposit Transfer Batch Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}/document

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "contentType": "Image_Bmp",
  • "fileData": "0x646174613A696D6...",
  • "label": "A document",
  • "comment": "Some information about this document",
  • "documentType": "Unknown",
  • "fileName": "file_name.jpg",
  • "validFrom": "2023-01-01",
  • "validUntil": "2023-12-31",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outgoingDepositTransferBatchId": "71a56563-4264-4edb-9cf9-832d73b93b66",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe"

  }

]

List Trade Positions To Transfer

Lists Trade Positions To Transfer under an existing Outgoing Deposit Transfer Batch.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required

string <uuid> Outgoing Deposit Transfer Batch Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}/tradePositionsToTransfer

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "isinCode": "stringstring",
  • "requestedQuantity": 0,
  • "id": 0,
  • "outgoingDepositTransferBatchId": "71a56563-4264-4edb-9cf9-832d73b93b66",
  • "instrumentName": "Erste Group Bank AG",
  • "shortCode": "CBK",
  • "instrumentType": "Stocks",
  • "originalQuantity": 0,
  • "positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
  • "swiftReferenceNumber": "stringstringstri",
  • "settlementLocation": "str",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "status": "Initial",
  • "bookingReference": "dfca5cfd-2db8-4073-9c32-5120b80443d0",
  • "bookingKey": "string",
  • "custodianMessages": [

    • {

      • "id": 0,
      • "holdingToTransferId": 0,
      • "isOutGoing": true,
      • "recordDate": "2019-08-24T14:15:22Z",
      • "fileName": "string",
      • "messageContent": "string"

      }

    ]

  }

]

List Outgoing Deposit Transfer Custodian Messages

Lists Outgoing Deposit Transfer Custodian Messages of an Trade Position To Transfer under an existing Outgoing Deposit Transfer Batch.

Authorizations:

BearerOpenIdConnect

path Parameters

outgoingDepositTransferBatchId required	string <uuid> Outgoing Deposit Transfer Batch Id
tradePositionToTransferId required	integer <int64> Trade Position To Transfer Id

Responses

/api/depositTransfer/outgoing/{outgoingDepositTransferBatchId}/tradePositionToTransfer/{tradePositionToTransferId}/custodianMessages

Response samples

• 200
• 400
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": 0,
  • "holdingToTransferId": 0,
  • "isOutGoing": true,
  • "recordDate": "2019-08-24T14:15:22Z",
  • "fileName": "string",
  • "messageContent": "string"

  }

]

Report

Get list of top traded instruments

Returns a list of traded instrument based on several filters

Authorizations:

BearerOpenIdConnect

path Parameters

timeOption required	integer <int32> Time option in days. Should be between 7 and 365
slice required	integer <int32> Top n number instruments. Should be between 10 and 100
side required	string Enum: "BUY" "SELL" "BUYMINUS" "SELLPLUS" "SELLSHORT" "SELLSHORTEXEMPT" "UNDISCLOSED" "CROSS" "CROSSSHORT" "CROSSSHORTEXEMPT" "ASDEFINED" "OPPOSITE" Order side

Responses

/api/reports/topTradedInstruments/{timeOption}/top/{slice}/orderSide/{side}

Response samples

• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

List Position Holdings

Returns a list of Position Holdings based on the filters given.

Authorizations:

BearerOpenIdConnect

query Parameters

isinCode	string ISIN Code
bookedDate	string Position Booked Date
recordsPerPage	integer <int32> [ 1 .. 2147483647 ] Default: 100 Example: recordsPerPage=10 Number of Records Per Page In The List
pageNumber	integer <int32> [ 1 .. 2147483647 ] Default: 1 Example: pageNumber=1 Requested Page Of The List

Responses

/api/reports/trading/positionHoldings

Response samples

• 200
• 400
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Get IFR Metrics

Returns IFR daily calculated metrics for the given date range

Authorizations:

BearerOpenIdConnect

query Parameters

startDate required	string <date> = 7 characters Example: startDate=2025-10 Start Date (YYYY-MM)
endDate required	string <date> = 7 characters Example: endDate=2025-11 End Date (YYYY-MM)

Responses

/api/reports/ifrReport

Response samples

• 200
• 400
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tenant

Unsubscribe a report event

Unsubscribes a report event for the given tenant. Any change in data will propagate to online system within one hour

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string <uuid> Tenant Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Type of the event report

string

Enum: "TradeExecutionReport" "TradeExecutionAccountBooking" "TradeExecutionReversal" "TradeOrderCancelReject" "TradeOrderModifyReject" "TradeCaptureReport" "TradeCaptureReportSno" "PaymentSDDInstructionUploaded" "PaymentSDDInstructionReceived" "PaymentSDDInstructionReverted" "PaymentSDDInstructionFailed" "ClientKistamQueryResultReceived" "NewInternalAccountStatement" "NewDepositAccountStatement" "BONewClientCreate" "BONewDepositAccountCreate" "BONewInternalAccountCreate" "BONewBankAccountCreate" "BOClientStateUpdate" "BOInternalAccountStateUpdate" "BODepositAccountStateUpdate" "BOBankAccountStateUpdate" "NewInternalAccountTransaction" "NewDepositAccountTransaction" "KycCreate" "KycUpdate" "ClientUpdate" "WithdrawalUpdate" "BankAccountAMLClosure" "PaymentSCTInstructionUpdated" "TradeExecutionStatement" "TradeExecutionReversalStatement" "LossThresholdReport" "CorporateActionStatement" "CorporateActionMetadata" "CorporateActionWithChoiceNotif"

Holds list of different event report types supported by the system

Responses

/api/tenant/{tenantId}/eventReportUnsubscription

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"TradeExecutionReport"

Response samples

• 200
• 400
• 413
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Subscribe a report event

Subscribes a report event for the given tenant. Any change in data will propagate to online system within one hour

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string <uuid> Tenant Id

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Type of the event report

string

Enum: "TradeExecutionReport" "TradeExecutionAccountBooking" "TradeExecutionReversal" "TradeOrderCancelReject" "TradeOrderModifyReject" "TradeCaptureReport" "TradeCaptureReportSno" "PaymentSDDInstructionUploaded" "PaymentSDDInstructionReceived" "PaymentSDDInstructionReverted" "PaymentSDDInstructionFailed" "ClientKistamQueryResultReceived" "NewInternalAccountStatement" "NewDepositAccountStatement" "BONewClientCreate" "BONewDepositAccountCreate" "BONewInternalAccountCreate" "BONewBankAccountCreate" "BOClientStateUpdate" "BOInternalAccountStateUpdate" "BODepositAccountStateUpdate" "BOBankAccountStateUpdate" "NewInternalAccountTransaction" "NewDepositAccountTransaction" "KycCreate" "KycUpdate" "ClientUpdate" "WithdrawalUpdate" "BankAccountAMLClosure" "PaymentSCTInstructionUpdated" "TradeExecutionStatement" "TradeExecutionReversalStatement" "LossThresholdReport" "CorporateActionStatement" "CorporateActionMetadata" "CorporateActionWithChoiceNotif"

Holds list of different event report types supported by the system

Responses

/api/tenant/{tenantId}/eventReportUnsubscription

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

"TradeExecutionReport"

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Gets unsubscribed report events for a tenant

Gets unsubscribed report events for the given tenant.

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string <uuid> Tenant Id

Responses

/api/tenant/{tenantId}/eventReportUnsubscription

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Replay Event Report

Resend option for records that have been processed incorrectly and whose retry count has expired in the webhook monitoring report

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string

query Parameters

eventId

string <uuid> Event Report Id

Responses

/api/tenant/{tenantId}/eventReportReplay

Response samples

• 200
• 400
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Get investment decision makers with scope = DealingDesk

Returns list of the investment decision makers with scope = DealingDesk

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string

Responses

/api/tenant/{tenantId}/investmentDecisionMaker

Response samples

• 200
• 400
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Create new investment decision maker with scope = DealingDesk

Create new investment decision maker with scope = DealingDesk

Authorizations:

BearerOpenIdConnect

path Parameters

tenantId required

string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

name	string or null <= 128 characters
surname	string or null <= 128 characters
countryCode required	string = 2 characters Iso country alpha 2 code
dateOfBirth	string or null <date> = 10 characters Birth data of the decision maker
email	string or null <email> <= 320 characters

Responses

/api/tenant/{tenantId}/investmentDecisionMaker

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com"

}

Response samples

• 200
• 400
• 404
• 409
• 412
• 413
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Update investment decision maker

Update investment decision maker

Authorizations:

BearerOpenIdConnect

path Parameters

investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id
tenantId required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Investment Decision Maker Request

name	string or null <= 128 characters
surname	string or null <= 128 characters
countryCode required	string = 2 characters Iso country alpha 2 code
dateOfBirth	string or null <date> = 10 characters Birth data of the decision maker
email	string or null <email> <= 320 characters

Responses

/api/tenant/{tenantId}/investmentDecisionMaker/{investmentDecisionMakerId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "name": "string",
• "surname": "string",
• "countryCode": "DE",
• "dateOfBirth": "1970-01-01",
• "email": "user@example.com"

}

Response samples

• 200
• 400
• 413
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Update default investment decision maker

Change default investment decision maker

Authorizations:

BearerOpenIdConnect

path Parameters

investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id
tenantId required	string

Responses

/api/tenant/{tenantId}/investmentDecisionMaker/{investmentDecisionMakerId}/defaultInvestmentDecisionMaker

Response samples

• 200
• 400
• 413
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Update investment decision maker set IsActive to false

Update investment decision maker set IsActive to false

Authorizations:

BearerOpenIdConnect

path Parameters

investmentDecisionMakerId required	string <uuid> Investment Decision Maker Id
tenantId required	string

Responses

/api/tenant/{tenantId}/investmentDecisionMaker/{investmentDecisionMakerId}/activeInvestmentDecisionMaker

Response samples

• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample