Loading...

API docs by Redocly

Angela (1.0.1091)

DISACON API Team: apiteam@disacon.de URL: https://www.disacon.de

Interface to DISACON CORE plattform

Accounts

Account data, balances, statements, and account lifecycle actions

Create internal account

Create a new internal (system) account

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_type
required
string

Account type as available for client configuration, see e.g. GET /configuration/account_type

memo
required
string <= 18 characters

Memorizable identifier of the account

name
required
string <= 80 characters

Name of the account

currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Currency of the account in case of a cash account

Responses

Response Schema: application/json
account_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "account_type": "string",
  • "memo": "string",
  • "name": "string",
  • "currency": "CAD"
}

Response samples

Content type
application/json
{
  • "account_id": 0
}

List portfolio account mappings

List porfolio account mappings; optionally filtered by different parameters

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
string <= 18 characters

Account number of an internal account

memo
string <= 18 characters

MEMO of an internal account

account_type_id
integer

Account type of an internal account (for a list of valid account types use GET /account_types)

business_type_id
integer

ID of the business type assigned to the portfolio account mapping

kv_nr
string <= 5 characters

KV-Nr. assigned to the portfolio account mapping

acc_profit_center
string <= 5 characters

Accounting profit center assigned to the portfolio account mapping

clearer
string <= 10 characters

Clearer assigned to the portfolio account mapping

Responses

Response Schema: application/json
Array
portfolio_account_mapping_id
required
integer <int64>

Internal ID of the portfolio account mapping

depository
string

Assigned depository if applicable

clearer
string <= 10 characters

Assigned clearer if applicable

business_type
required
string <= 80 characters

The business type groups portofolio account mappings into categories

currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Assigned currency

kv_nr
string <= 5 characters

Assigned "Kassenvereinsnummer" if applicable

acc_profit_center
string <= 5 characters

Accounting profit center (ReWe-Kostenstelle) if applicable

securities_account_number
string <= 18 characters

Account number of the nostro securities account if there is any

securities_account_memo
string <= 18 characters

MEMO of the nostro securities account if there is any

cash_account_number
string <= 18 characters

Account number of the nostro cash account if there is any

cash_account_memo
string <= 18 characters

MEMO of the nostro cash account if there is any

margin_cash_account_number
string <= 18 characters

Account number of the margin securities account if there is any

margin_cash_account_memo
string <= 18 characters

MEMO of the margin securities account if there is any

Response samples

Content type
application/json
[
  • {
    }
]

Create a new portfolio account mapping

Create a new portfolio account mapping or simuliate its creation

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
business_type
required
string
Enum: "Wertpapiergeschäft" "BOEGA Vermittlung"

The business type categorizes the portfolio account mapping

currency
required
string
Value: "EUR"

Currency of the portfolio account mapping

clearer
required
string <= 10 characters

Assigned clearer if applicable

kv_nr
string <= 5 characters

Assigned "Kassenvereinsnummer" if applicable

required
Array of objects (mapping_account)
do_save
required
boolean
Default: false

If TRUE, then the data is to be saved. i.e. the portfolio account mapping is to be created, otherwise just checked/simulated

Responses

Response Schema: application/json
One of
portfolio_account_mapping_id
required
integer <int64>

Internal ID of the portfolio account mapping

Request samples

Content type
application/json
{
  • "business_type": "Wertpapiergeschäft",
  • "currency": "EUR",
  • "clearer": "string",
  • "kv_nr": "strin",
  • "accounts": [
    ],
  • "do_save": false
}

Response samples

Content type
application/json
[ ]

Details of a portfolio account mapping

Get all details of a specific portfolio account mapping

Authorizations:
oidc_headerbasicAuth
path Parameters
portfolio_account_mapping_id
required
integer <int64>

ID of a specific portfolio account mapping

Responses

Response Schema: application/json
portfolio_account_mapping_id
required
integer <int64>

Internal ID of the portfolio account mapping

person_create_name
required
string <= 80 characters

Name of the person that created the portfolio account mapping

person_create_given_name
string <= 80 characters

Given name of the person that created the portfolio account mapping

business_type
required
string <= 80 characters

The business type groups portofolio account mappings into categories

currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Assigned currency

clearer
string <= 10 characters

Assigned clearer if applicable

depository
string

Assigned depository if applicable

kv_nr
string <= 5 characters

Assigned "Kassenvereinsnummer" if applicable

acc_profit_center
string <= 5 characters

Accounting profit center (ReWe-Kostenstelle) if applicable

securities_account_number
string <= 18 characters

Account number of the nostro securities account if there is any

securities_account_memo
string <= 18 characters

MEMO of the nostro securities account if there is any

cash_account_number
string <= 18 characters

Account number of the nostro cash account if there is any

cash_account_memo
string <= 18 characters

MEMO of the nostro cash account if there is any

margin_cash_account_number
string <= 18 characters

Account number of the margin securities account if there is any

margin_cash_account_memo
string <= 18 characters

MEMO of the margin securities account if there is any

Array of objects (mapping_account)

Response samples

Content type
application/json
{
  • "portfolio_account_mapping_id": 0,
  • "person_create_name": "string",
  • "person_create_given_name": "string",
  • "business_type": "string",
  • "currency": "CAD",
  • "clearer": "BIW",
  • "depository": "string",
  • "kv_nr": "strin",
  • "acc_profit_center": "strin",
  • "securities_account_number": "string",
  • "securities_account_memo": "string",
  • "cash_account_number": "string",
  • "cash_account_memo": "string",
  • "margin_cash_account_number": "string",
  • "margin_cash_account_memo": "string",
  • "accounts": [
    ]
}

Update a portfolio account mapping

Edit the accounts of a specific portfolio account mapping

Authorizations:
oidc_headerbasicAuth
path Parameters
portfolio_account_mapping_id
required
integer <int64>

ID of a specific portfolio_account_mapping

Request Body schema: application/json
required
Array of objects (mapping_account)

Responses

Request samples

Content type
application/json
{
  • "accounts": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Portfolio account mapping creation advice

Get an suggestion on how to create a new portfolio account mapping based on the provided input

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
business_type
required
string
Enum: "Wertpapiergeschäft" "BOEGA Vermittlung"

The business type groups portofolio account mappings into categories

currency
required
string
Value: "EUR"

The currency to be assigned

clearer
required
string <= 10 characters

The clearer to be assigned

kv_nr
string <= 5 characters

If applicable the "Kassenvereinsnummer" to be assigned

account_number_suffix_bank
string <= 4 characters

Suffix of the account numbers to be used (to identify the bank)

account_number_suffix_number
string <= 4 characters

Suffix of the account numbers to be used (to identify the account at the bank)

bonds
required
boolean
Default: true

Configure accounts for security group bonds Y/N

futures
required
boolean
Default: false

Configure accounts for security group futures Y/N

options
required
boolean
Default: false

Configure accounts for security group options Y/N

stocks
required
boolean
Default: true

Configure accounts for security group stocks Y/N

warrants
required
boolean
Default: true

Configure accounts for security group warrants Y/N

own_stocks
required
boolean
Default: true

Configure accounts for own stocks Y/N

own_bonds
required
boolean
Default: true

Configure accounts for own bonds Y/N

Array of objects (mapping_account)

Configure using the given accounts or account parameters

Responses

Response Schema: application/json
business_type
required
string
Enum: "Wertpapiergeschäft" "BOEGA Vermittlung"

The business type categorizes the portfolio account mapping

currency
required
string
Value: "EUR"

Currency of the portfolio account mapping

clearer
required
string <= 10 characters

Assigned clearer if applicable

kv_nr
string <= 5 characters

Assigned "Kassenvereinsnummer" if applicable

account_number_suffix_bank
string <= 4 characters

Suffix of the account numbers to identify the bank

account_number_suffix_number
string <= 4 characters

Suffix of the account numbers to identify the account at the bank

Array of objects (mapping_account)

The accounts associated with the portfolio account mapping

Request samples

Content type
application/json
{
  • "business_type": "Wertpapiergeschäft",
  • "currency": "EUR",
  • "clearer": "string",
  • "kv_nr": "strin",
  • "account_number_suffix_bank": "BIW",
  • "account_number_suffix_number": 999,
  • "bonds": true,
  • "futures": false,
  • "options": false,
  • "stocks": true,
  • "warrants": true,
  • "own_stocks": true,
  • "own_bonds": true,
  • "accounts": [
    ]
}

Response samples

Content type
application/json
{
  • "business_type": "Wertpapiergeschäft",
  • "currency": "EUR",
  • "clearer": "string",
  • "kv_nr": "strin",
  • "account_number_suffix_bank": "stri",
  • "account_number_suffix_number": "stri",
  • "accounts": [
    ]
}

Account statement configuration

Configure the account statement generation schedule

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a customer cash account

query Parameters
cycle
required
string
Enum: "D" "W" "M" "Q" "S" "Y"
  • D - daily
  • W - weekly
  • M - monthly
  • Q - quarterly
  • S - semestrial
  • Y - yearly

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Account statement overview

Overview of the last account statement generation

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a customer cash account

Responses

Response Schema: application/json
last_person_id_create
integer <int64>

ID of the person that requested the account statement

last_person_create
string <= 161 characters

Given name and name of the person that requested the account statement

last_creation_date
string <date>

Creation date

last_identifier
string <= 9 characters

Identifier

last_date_from
string <date>

Start date

last_date_to
string <date>

End date

last_number_of_transactions
integer

Number of transactions included in the account statement

next_date_scheduled
string <date>

Date of next scheduled account statement creation

current_cycle
required
string
Enum: "D" "W" "M" "Q" "S" "Y"
  • D - daily
  • W - weekly
  • M - monthly
  • Q - quarterly
  • S - semestrial
  • Y - yearly

Response samples

Content type
application/json
{
  • "last_person_id_create": 0,
  • "last_person_create": "string",
  • "last_creation_date": "2019-08-24",
  • "last_identifier": "string",
  • "last_date_from": "2019-08-24",
  • "last_date_to": "2019-08-24",
  • "last_number_of_transactions": 0,
  • "next_date_scheduled": "2019-08-24",
  • "current_cycle": "D"
}

Schedule an account statement

Schedule the generation of an account statement (indepentent of the configuration)

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a customer cash account

query Parameters
date_scheduled
string <date>

Date on which the account statement should be created (if not specified then a.s.a.p.)

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Account activity

Get the account's activity within the specified time interval

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash account

query Parameters
balance_type
required
string
Default: "B"
Enum: "B" "V" "T"
  • B - booking date
  • V - value date
  • T - transaction date
date_from
required
string <date>

Start date (incl.)

date_to
required
string <date>

End date (incl.)

hide_reversal
boolean
Default: false

If TRUE, then cancelled transactions are omitted

Responses

Response Headers
x-result-total
integer

The (actual) total of postings to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema:
account_number
required
string <= 18 characters

Account number of a cash account

balance_type
required
string
Enum: "B" "V" "T"
  • B - booking date balance
  • V - value date balance
  • T - transaction date balance
start_balance
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Start balance (for beginning of start date)

start_available_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Available balance for beginning of start date

start_booked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Booked balance for beginning of start date

start_blocked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Blocked balance for beginning of start date

start_date
required
string <date>

Start date

end_balance
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

End balance (for end date)

end_available_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Available balance for end date

end_booked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Booked balance for end date

end_blocked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Blocked balance for end date

end_date
required
string <date>

End date

last_transaction_date
string <date>

Date of the last booking

currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Account currency

Array of objects

Response samples

Content type
{
  • "account_number": "string",
  • "balance_type": "B",
  • "start_balance": "string",
  • "start_available_balance": "string",
  • "start_booked_balance": "string",
  • "start_blocked_balance": "string",
  • "start_date": "2019-01-01",
  • "end_balance": "string",
  • "end_available_balance": "string",
  • "end_booked_balance": "string",
  • "end_blocked_balance": "string",
  • "end_date": "2019-01-01",
  • "last_transaction_date": "2019-01-01",
  • "currency": "CAD",
  • "postings": [
    ]
}

Account balance

Get the account's balance on a given date

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account Number of a cash account

Responses

Response Schema: application/json
available_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Available balance

booked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Booked balance

blocked_balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

Blocked balance

last_date
string <date>

The last booking, value, or transaction date depending on the requested balance type

currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Balance amount currency

as_of_timestamp
required
string <date-time>

The timestamp, the balance was retrieved

Response samples

Content type
application/json
{
  • "available_balance": "string",
  • "booked_balance": "string",
  • "blocked_balance": "string",
  • "last_date": "2019-08-24",
  • "currency": "CAD",
  • "as_of_timestamp": "2019-08-24T14:15:22Z"
}

Account details

Account details for a cash or security account

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash or security account

Responses

Response Schema: application/json
account_number
required
string <= 18 characters

Account number (internal)

name
required
string <= 80 characters

Account name

currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Account currency in case of a cash account

state
required
string
Enum: "A" "B" "C"
  • A - Active
  • B - Blocked
  • C - Closed
state_change_date
required
string <date-time>

Date and time the last state change happened

iban
string <= 34 characters [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN

memo
string <= 18 characters

Memorizable (alphanumeric) identfier of an internal account

opening_date
required
string <date-time>

Account opening date and time

last_transaction
string <date-time>

Date and time (system booking time) of the last transaction

custom_name
string <= 80 characters

A custom account name as set by the user

Array of objects
account_class
required
string
Enum: "S" "C"
  • 'S'ysten account (aka. internal account)
  • 'C'ustomer account
account_kind
string
Enum: "A" "D"
  • cash 'A'ccount
  • securities account ('D'epot)

Response samples

Content type
application/json
{
  • "account_number": "0000000012",
  • "name": "Max Mustermann",
  • "currency": "CAD",
  • "state": "A",
  • "state_change_date": "2019-08-24T14:15:22Z",
  • "iban": "string",
  • "memo": "NLZB",
  • "opening_date": "2019-08-24T14:15:22Z",
  • "last_transaction": "2019-08-24T14:15:22Z",
  • "custom_name": "my personal account name",
  • "tx_limits": [
    ],
  • "account_class": "S",
  • "account_kind": "A"
}

Account's booked T&C fee packages

The details on booked fee packages

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

account number of a customer cash account

query Parameters
hide_used
required
boolean
Default: false

When TRUE then show only where usage smaller max. usage

Responses

Response Schema: application/json
Array
object

Response samples

Content type
application/json
[
  • { }
]

Account's T&C interest rate model

The interest rates applied to the given cash account

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a customer cash account

Responses

Response Schema: application/json
Array
description
required
string <= 80 characters

A decsription of the interest rate

amount_currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Balance currency

amount_from
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

The balance amount (incl.) from which the interest rate applies

amount_to
string^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

The balance amount (excl.) until which the interest rate applies

interest_rate
required
string[0-9]{1,12}(\.[0-9]{1,13})?

The interest rate (in %)

Response samples

Content type
application/json
[
  • {
    }
]

Persons related to an account

Get all persons related to the given cash or security account

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash or securities account

Responses

Response Schema: application/json
Array
person_id
required
integer <int64>

ID of a person

role
required
string
Enum: "O" "A"
  • O - account owner
  • A - authorized person
given_name_and_name
required
string <= 161 characters

Given name and name of the person

Response samples

Content type
application/json
[
  • {
    }
]

List OP accounts

List all accounts from the portfolio account mapping with business type "OP" (open postings) and given account number

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of an internal account

Responses

Response Schema: application/json
Array
account_id
required
integer <int64>

ID of an accout

account_number
required
string <= 18 characters

Account number

memo
string <= 18 characters

Memorizable identfier of an account

name
required
string <= 80 characters

Account name

account_type
required
string <= 80 characters

Type (description) of an account

posting_related
required
string
Enum: "P" "R"
  • P - posting account
  • R - related account

Response samples

Content type
application/json
[
  • {
    }
]

Block or un-block a account

Block (set state to blocked) or un-block (set state to active)

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash or securities account

query Parameters
state
required
string
Enum: "A" "B"

The new account state

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Set account limit

Set a user defined account limit to a cash account

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash account

limit_type_id
required
integer <int64>

The ID (as displayed in account details) of the limit to be changed

Request Body schema: application/json
required
limit_value
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Responses

Request samples

Content type
application/json
{
  • "limit_value": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Reset account limit

Reset a user defined account limit to its system default value

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a cash account

limit_type_id
required
integer <int64>

The ID (as displayed in account details) of the limit to be changed

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Annual securities account statement

Request creation of annual securities account (Depot) statement

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Securities account activity

Get the securties account's (Depot) activity within the specified time interval

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a securities account

query Parameters
balance_type
required
string
Default: "B"
Enum: "B" "V" "T"
  • B - booking date
  • V - value date
  • T - transaction date
date_from
required
string <date>

Start date (incl.)

date_to
required
string <date>

End date (incl.)

isin
string = 12 characters

ISIN

Responses

Response Headers
x-result-total
integer

The (actual) total of postings to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema:
account_number
required
string <= 18 characters

Account number of a securities account

date_from
string <date>

Start date

date_to
string <date>

End date

balance_type
required
string
Enum: "B" "V" "T"
  • B - booking date balance
  • V - value date balance
  • T - transaction date balance
isin
string <= 12 characters

ISIN

Array of objects

Response samples

Content type
{
  • "account_number": "string",
  • "date_from": "2026-01-01",
  • "date_to": "2026-12-31",
  • "balance_type": "B",
  • "isin": "string",
  • "postings": [
    ]
}

FiFo activity

Get the securtites account's FiFo activity

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a securities account

query Parameters
isin
required
string = 12 characters

ISIN

date_from
required
string <date>

Start date

date_to
required
string <date>

End date

Responses

Response Headers
x-result-total
integer

The (actual) total of postings to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
account_number
required
string <= 18 characters

Account number of a securitites account

isin
required
string <= 12 characters

ISIN

date_from
required
string <date>

Start date

date_to
required
string <date>

End date

Array of objects (fifo_posting)

Response samples

Content type
application/json
{
  • "account_number": "string",
  • "isin": "string",
  • "date_from": "2026-01-01",
  • "date_to": "2026-12-31",
  • "fifo_postings": [
    ]
}

Holdings of a securities account

Get holdings of a securities account

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a securities account (Depot)

query Parameters
date
required
string <date>

Show holdings as of date

balance_type
required
string
Default: "B"
Enum: "B" "V" "T"
  • B - booking date
  • V - value date
  • T - transaction date
isin
string = 12 characters

Filter by ISIN

show_zero_balances
required
boolean
Default: false

Show holdings of securities that used to held but are zero as of date

Responses

Response Schema: application/json
Array
isin
required
string <= 12 characters

ISIN

wkn
string <= 6 characters

WKN

security_description
string <= 61 characters

Short description of the security

balance
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

Holdings

available
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

Available holdings

block_securities_reason_id
integer

Reason for blocking code

block_securities_reason
string <= 80 characters

Reason for blocking

subbalance_description
required
string <= 80 characters

Sub-balance description, e.g. a depository

subbalance_id
required
integer

Sub-balance ID

Response samples

Content type
application/json
[
  • {
    }
]

Securities account interest rate

The interest rates applied to the given securities account's holdings

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a customer securities account

Responses

Response Schema: application/json
Array
description
required
string <= 80 characters

A decsription of the interest rate

isin
required
string^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$

ISIN

amount_from
string^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

The holdings amount (incl.) from which the interest rate applies

amount_to
string^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

The holdings amount (excl.) until which the interest rate applies

interest_rate
required
string[0-9]{1,12}(\.[0-9]{1,13})?

The interest rate (in MONEY/UNIT)

interest_currency
required
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Currency for booking the interest amount

Response samples

Content type
application/json
[
  • {
    }
]

Securities account statement overview

Overview of the last securities account statement generation

Authorizations:
oidc_headerbasicAuth
path Parameters
account_number
required
string <= 18 characters

Account number of a securities account (Depot)

Responses

Response Schema: application/json
last_person_id_create
integer <int64>

ID of the person that requested the securities account statement

last_person_create
string <= 161 characters

Given name and name of the person that requested the securities account statement

last_creation_date
string <date>

Creation date

last_identifier
string <= 9 characters

Identifier

last_measurement_date
string <date>

Last measurement date (Bewertungsstichtag)

Response samples

Content type
application/json
{
  • "last_person_id_create": 0,
  • "last_person_create": "string",
  • "last_creation_date": "2019-08-24",
  • "last_identifier": "string",
  • "last_measurement_date": "2019-08-24"
}

Approvals

Approval requests and approval workflow actions

Approval request details

Details on the approval request including the request causing an approval request

Authorizations:
oidc_headerbasicAuth
path Parameters
approval_request_id
required
integer <int64>

ID of the approval request

Responses

Response Schema: application/json
approval_request_id
required
integer <int64>

ID of the approval request

datetime_create
required
string <date-time>

Timestamp the approval request was created

created_by_person_id
required
integer <int64>

ID of the person that created the approval request (i.e. the underlying request)

created_by_person_name
string <= 80 characters

Name of the person that created the approval request (i.e. the underlying request)

created_by_person_given_name
string <= 80 characters

Given name of the person that created the approval request (i.e. the underlying request)

created_by_person_email
string <= 255 characters

Email address of the person that created the approval request (i.e. the underlying request)

client
required
string <= 20 characters

The client (application) where the approval request was created

status
required
string
Enum: "W" "R" "A"

State of the approval request

required_approvals
required
integer <int32>

Number of required approvals

approval_count
required
integer <int32>

Number of registered approvals

approval_rule
required
string <= 20 characters

The applying approval rule

datetime_last_updated
string <date-time>

Timestamp of the last approval/rejection

last_updated_by_person_id
integer <int64>

ID of the person providing the last approval/rejection

last_updated_by_person_name
string <= 80 characters

Name of the person providing the last approval/rejection

last_updated_by_person_given_name
string <= 80 characters

Given name of the person providing the last approval/rejection

last_updated_by_person_email
string <= 255 characters

Email address of the person providing the last approval/rejection

handler_module_name
required
string

Name of the handler module to be called after full approval

error
required
string

Error text indicating the reason for approval request creation

person_id
integer <int64>

ID of the person the original request acts on

account_ids
Array of integers <int64> [ items <int64 > ]

Accouns IDs of the original request acts on

ta_id
integer <int64>

TA ID the original request acts on

transaction_id
integer <int64>

Transaction ID the original request acts on

related_ids
required
Array of integers <int64> [ items <int64 > ]

Other related ID the original request acts on

request
object

Original API request

context
object

Original API request context

person_can_approve
boolean

Indicates if the person calling the endpoint may approve the request

Response samples

Content type
application/json
{
  • "approval_request_id": 0,
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "created_by_person_id": 0,
  • "created_by_person_name": "string",
  • "created_by_person_given_name": "string",
  • "created_by_person_email": "string",
  • "client": "string",
  • "status": "W",
  • "required_approvals": 0,
  • "approval_count": 0,
  • "approval_rule": "string",
  • "datetime_last_updated": "2019-08-24T14:15:22Z",
  • "last_updated_by_person_id": 0,
  • "last_updated_by_person_name": "string",
  • "last_updated_by_person_given_name": "string",
  • "last_updated_by_person_email": "string",
  • "handler_module_name": "string",
  • "error": "string",
  • "person_id": 0,
  • "account_ids": [
    ],
  • "ta_id": 0,
  • "transaction_id": 0,
  • "related_ids": [
    ],
  • "request": { },
  • "context": { },
  • "person_can_approve": true
}

Approve or reject

Approve or reject an approval request

Authorizations:
oidc_headerbasicAuth
path Parameters
approval_request_id
required
integer <int64>

ID of the approval request

query Parameters
action
required
string (approval_action)
Enum: "A" "R"

The action to perform on the approval request

Responses

Response Schema: application/json
triggered_state
required
string
Enum: "S" "E" "N"

New state of the approval request

required
object

Details on the approval request

triggered_event_result
object

The response of the request triggered by approval

Response samples

Content type
application/json
{
  • "triggered_state": "S",
  • "approval_request": {
    },
  • "triggered_event_result": { }
}

List approval requests

List approval requests filterd by various parameters

Authorizations:
oidc_headerbasicAuth
query Parameters
user_can_approve
required
boolean
Default: true

Show only approval request that may be approved by current user

approval_request_id
integer <int64>

Filter by ID

status
Array of strings (approval_request_status)
Items Enum: "W" "R" "A"

Filter by one or more states

approval_rule
string <= 20 characters

Filter by the approval rule MEMO as returned by GET /approval_rules

person_id_affected
integer <int64>

Filter by ID of the person affected by the original request

account_id_affected
integer <int64>

Filter by ID of an account affected by the original request

person_id_create
integer <int64>

Filter by ID of the person who created by the approval request

person_create
string <= 161 characters

filter by name of the person who created the approval request

date_create_from
string <date>

Filter by approval request creation greater or equal

date_create_to
string <date>

Filter by approval request creation less or equal

date_last_updated_from
string <date>

Filter by timestamp of last update greater or equal

date_last_updated_to
string <date>

Filter by timestamp of last update less or equal

Responses

Response Headers
x-result-total
integer

the (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
approval_request_id
required
integer <int64>

ID of the approval request

datetime_create
required
string <date-time>

Timestamp the approval request was created

created_by_person_id
required
integer <int64>

ID of the person that created the approval request (i.e. the underlying request)

created_by_person_name
string <= 80 characters

Name of the person that created the approval request (i.e. the underlying request)

created_by_person_given_name
string <= 80 characters

Given name of the person that created the approval request (i.e. the underlying request)

created_by_person_email
string <= 255 characters

Email address of the person that created the approval request (i.e. the underlying request)

client
required
string <= 20 characters

The client (application) where the approval request was created

status
required
string
Enum: "W" "R" "A"

State of the approval request

required_approvals
required
integer <int32>

Number of required approvals

approval_count
required
integer <int32>

Number of registered approvals

approval_rule
required
string <= 20 characters

The applying approval rule

datetime_last_updated
string <date-time>

Timestamp of the last approval/rejection

last_updated_by_person_id
integer <int64>

ID of the person providing the last approval/rejection

last_updated_by_person_name
string <= 80 characters

Name of the person providing the last approval/rejection

last_updated_by_person_given_name
string <= 80 characters

Given name of the person providing the last approval/rejection

last_updated_by_person_email
string <= 255 characters

Email address of the person providing the last approval/rejection

handler_module_name
required
string

Name of the handler module to be called after full approval

error
required
string

Error text indicating the reason for approval request creation

person_id
integer <int64>

ID of the person the original request acts on

account_ids
Array of integers <int64> [ items <int64 > ]

Accouns IDs of the original request acts on

ta_id
integer <int64>

TA ID the original request acts on

transaction_id
integer <int64>

Transaction ID the original request acts on

related_ids
required
Array of integers <int64> [ items <int64 > ]

Other related ID the original request acts on

request
object

Original API request

context
object

Original API request context

Response samples

Content type
application/json
[
  • {
    }
]

List approval rules

List of the configured approval rules

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
approval_rule_id
required
integer <int32>

ID of the approval rule

memo
required
string <= 20 characters

Memorizable identifier of the approval rule

description
required
string

Description of the approval rule

error_code
required
integer <int32>

Error code indicating, that an approval is required for the action

required_approvals
required
integer <int32>

Number of approvals required

creator_can_approve
required
boolean

Indicator, whether the creator of an approval request may provide one of the required approvals or reject

roles_approve
required
Array of strings

A list of the user roles, thay may approve or reject

Response samples

Content type
application/json
[
  • {
    }
]

Attachemnts

File and attachment upload/download and metadata

Fetch an attachment

Fetch a specific attachment as binary sting

Authorizations:
oidc_headerbasicAuth
path Parameters
attachment_id
required
integer <int64> (id_number)

ID of the attachment to fetch

source
required
string
Enum: "request_money" "transaction" "email"

Source of the attachment to fetch

ta_id
required
integer <int64> (id_number)

The ta_id of the attachment to fetch

id
required
integer <int64> (id_number)

Id in the source table of the attachment to fetch

query Parameters
token
required
string
Example: token=ABCDEFGH

A security token

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Audit trail

Audit trail access for compliance and change tracking

Audit trail details of the address

Get the audit trail details of a person's address

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the email address

Get the audit trail details of a person's email address

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the FSA

Get the audit trail details of a person's FSA

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the NV

Get the audit trail details of a person's NV

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Overview on a person's audit trail

Get the complete audit trail (history) of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
Array
changed_datetime
required
string <date-time>

Timestamp the data was changed

changed_by_person_id
required
integer <int64>

ID of the person that changed the data

changed_by_person_class
required
string
Enum: "C" "B" "S" "X"

Class of the person that changed the data

changed_by_person_name
required
string <= 80 characters

Name of the person that changed the data

changed_by_person_given_name
string <= 80 characters

Given name of the person that changed the data

object_type
required
string
Enum: "address" "email_address" "fsa" "nv" "person_church_tax" "person_config" "person_data" "person_external_identifier" "person_married" "person_taxid" … 2 more

The kind of data that was changed

Response samples

Content type
application/json
[
  • {
    }
]

Audit trail details of the church tax data

Get the audit trail details of a person's chruch tax data

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the configuration

Get the audit trail details of a person's configuration

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the person data

Get the audit trail details of a person's data

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the external IDs

Get the audit trail details of a person's external IDs

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the marital status

Get the audit trail details of a person's marital status

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the tax IDs

Get the audit trail details of a person's tax IDs

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the phone number

Get the audit trail details of a person's phone number

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Audit trail details of the VSN

Get the audit trail details of a person's VSN (Verluststammnummer)

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
sort_order
required
Array of strings (sort_order)

Instruction for the FE on how to arrange fields

Array of objects

Response samples

Content type
application/json
{
  • "sort_order": [
    ],
  • "data": [
    ]
}

Back office

Back-office administration of users, configurations, and operational data

Get data of a third person

Get data of a third person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
person_id
required
integer <int64>

ID of the person

datetime_create
required
string <date-time>

Date and time this person was created

datetime_update
required
string <date-time>

Date and time this entry was last updated

state
required
string
Enum: "S" "V" "I" "C"

State of the person

name
string <= 80 characters

The person's name

given_name
string <= 80 characters

The person's given name

birth_date
string <date>

The person's birth date

gender
string
Enum: "M" "F" "X"

The person's gender

nationality
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

The person's nationality

primary_email_address
string <email> <= 255 characters

The (verified) primary email address of the person

primary_phone_number
string <= 30 characters

The primary phone number of the person in format E.164

is_merchant
required
boolean

Indicates if the person is a merchant/company

company_name
string <= 80 characters

Name of the company in case of a merchant/company

birth_city
string <= 80 characters

City or municipality the person was born

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

person_alias
string

The person's alias

client_type
string
Enum: "B" "R"

Type of the person

Array of objects

Response samples

Content type
application/json
{
  • "person_id": 0,
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "datetime_update": "2019-08-24T14:15:22Z",
  • "state": "S",
  • "name": "example",
  • "given_name": "user",
  • "birth_date": "1970-12-24",
  • "gender": "M",
  • "nationality": "ABW",
  • "primary_email_address": "anna@domain.tld",
  • "primary_phone_number": 49123456789,
  • "is_merchant": false,
  • "company_name": "ibm",
  • "birth_city": "Berlin",
  • "pep": true,
  • "fatca": true,
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "person_alias": "string",
  • "client_type": "B",
  • "external_identifiers": [
    ]
}

Change data of a third person

Change data of a third person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Request Body schema: application/json
required

The person's updated data

gender
string
Enum: "M" "F" "X"

Gender of the person

birth_date
string <date>

Birth date of the person

birth_city
string <= 80 characters

Birth city or municipality of the person

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

name
string <= 100 characters

Name of the person

given_name
string <= 100 characters

Given name of the person

person_alias
string

Alias of the person

Responses

Request samples

Content type
application/json
{
  • "gender": "M",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "pep": true,
  • "fatca": true,
  • "name": "Mustermann",
  • "given_name": "Max",
  • "person_alias": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Delete a third person

Initiate closure of a third person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

query Parameters
reason
required
string
Enum: "ClientRequest" "AMLTechnicalError" "Other3rdPartyRequest" "ImmediateClosure"

Reason for closure

comment
string <= 100 characters

Free text comment

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Reset password of a third person

Request e-mail for resetting a third person's password

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

query Parameters
email_address
string <email>

Optionally add a new e-mail address in case no validated e-mail address exists

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Create or update an exemption order

Submit new or updated exemption order (Freistellungsauftrag)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
person_ids
required
Array of integers <int64> [ 1 .. 2 ] items [ items <int64 > ]

IDs of all persons related to the exemption order

amount
required
string[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)
minimum: 0.00

Applicable FSA amount

currency
required
string
Value: "EUR"

Currency of the applicable FSA amount

valid_from
required
string <date>

Date from which the exemption order is valid; can only be 1st of January

valid_until
string <date>

Date until which the exemption order is valid; can only be 31st of December

Responses

Request samples

Content type
application/json
{
  • "person_ids": [
    ],
  • "amount": "string",
  • "currency": "EUR",
  • "valid_from": "2019-08-24",
  • "valid_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Revoke an exemption order

Revoke an exemption order (identified by end date)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
person_ids
required
Array of integers <int64> [ 1 .. 2 ] items [ items <int64 > ]

IDs of all persons related to the exemption order to be revoked

valid_until
required
string <date>

Date until which the existing exemption order is valid (identifies the FSA)

Responses

Request samples

Content type
application/json
{
  • "person_ids": [
    ],
  • "valid_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Delete an exemption order

Removal of a exemption order; only to be used in case of incorrect submitted data on the test environments; for e.g. changing validity, use PUT

Authorizations:
oidc_headerbasicAuth
path Parameters
exemption_order_id
required
integer <int64>

ID of the exemption order

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Initiate KISTAM Regelanfrage

Initiate creation of data for KISTAM Regelanfrage

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Create a new back-office user

Create a new back-office user using name, given name and e-mail address. The submitted e-mail address will receive an e-mail to activate the account.

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

New back-office user

name
required
string <= 80 characters

Name of the person

given_name
required
string <= 80 characters

Given name of the person

email_address
required
string <email> <= 255 characters

E-mail address to use for verification

language
string
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

Initial user language settings

role_ids
Array of integers (editable_role_id)
Items Enum: 2 3 4 6 8 9 10 11

User roles (for permissions)

Responses

Response Schema: application/json
person_id
required
integer <int64> (id_number)

An internal ID

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "name": "Mustermann",
  • "given_name": "Max",
  • "email_address": "max.mustermann@domain.tld",
  • "language": "en",
  • "role_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "person_id": 0
}

Create a new customer

Create a new customer using name, given name and e-mail address. The submitted e-mail address will receive an e-mail to activate the account.

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

New customer

name
required
string <= 80 characters

Name of the person

given_name
required
string <= 80 characters

Given name of the person

email_address
required
string <email> <= 255 characters

E-mail address to use for verification

language
string
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

Initial user language settings

client_type
required
string (client_type)
Enum: "B" "R"

Property of the client

  • B - Business
  • R - Retail

Responses

Response Schema: application/json
person_id
required
integer <int64> (id_number)

An internal ID

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "name": "Mustermann",
  • "given_name": "Max",
  • "email_address": "max.mustermann@domain.tld",
  • "language": "en",
  • "client_type": "B"
}

Response samples

Content type
application/json
{
  • "person_id": 0
}

Create a non-assessment certificate

Submit a new non-assessment certificate (NV)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
person_ids
required
Array of integers <int64> [ 1 .. 2 ] items [ items <int64 > ]

IDs of all related persons

type
required
string
Enum: "01" "02" "02_35" "02_36" "02_37" "03"

The type of non-assessment certificate

  • '01' - natural persons (natürliche Personen)
  • '02' - Körperschaften, Personenvereinigungen, Vermögensmassen
  • '03' - unbeschränkt steuerpflichtige und nicht steuerbefreite Körperschaften, Personenvereinigungen, Vermögensmassen
date_from
required
string <date>

Date from which the non-assessment certificate is valid; can only be 1st of January

date_to
required
string <date>

Date until which the non-assessment certificate is valid; can only be 31st of December

external_identifier
required
string <string> <= 25 characters

External identifier of the non-assessment certificate (NV-Nummer)

Responses

Request samples

Content type
application/json
{
  • "person_ids": [
    ],
  • "type": "01",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "external_identifier": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Revoke a non-assessment certificate

Revoke a non-assessment certificate (NV)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
person_ids
required
Array of integers <int64> [ 1 .. 2 ] items [ items <int64 > ]

IDs of all related persons

date_from
required
string <date>

Start date of the existing non-assessment certificate for identifying it

date_revoke_from
required
string <date>

Date starting from which the non-assessment certificate is not valid anymore; can only be 1st of January

Responses

Request samples

Content type
application/json
{
  • "person_ids": [
    ],
  • "date_from": "2019-08-24",
  • "date_revoke_from": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Remove a non-assessment certificate (NV)

Delete a non assessment certificate from a test environment in case of incorrectly submitted data; for revoking use PUT

Authorizations:
oidc_headerbasicAuth
path Parameters
nv_id
required
integer <int64>

Internal identifier of the NV

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

List accounts of a (third) person

Get all accounts that a person is the account holder of or is authorized

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

ID of a person

Responses

Response Schema: application/json
Array
account_number
required
string <= 18 characters

Account number (internal)

name
required
string <= 80 characters

Account name

currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Account currency in case of a cash account

account_kind
required
string
Enum: "A" "D"

Cash "A"ccount or securities account ("D"epot)

memo
string <= 18 characters

Memorizable identifier

iban
string <= 34 characters

IBAN

account_type
string <= 80 characters

Type (description) of the account

Response samples

Content type
application/json
[
  • {
    }
]

Get addresses of a (third) person

Get address or adresses (living and deliery) of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of a person

Responses

Response Schema: application/json
Array
address_id
required
integer <int64>

ID of the address

address_type
required
string (address_type)
Default: "L"
Enum: "L" "D"

Address_Type:

  • 'L' - Living Address
  • 'D' - Delivery Address
datetime_update
required
string <date-time>

Date and time this data was last updated

street
string <= 80 characters

Name of street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Response samples

Content type
application/json
[
  • {
    }
]

Add a new address of a person

Add a new address to an already created person Per person max. 1 living address is allowed. Trying to add more than one living address throws an error, address update might be the better choice in those cases.

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of a person

Request Body schema: application/json
required

The new address to add

address_type
string
Default: "L"
Enum: "L" "D"

Type of the address

street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Response Schema: application/json
address_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "address_type": "L",
  • "street": "Hauptstr.",
  • "building_identifier": "1",
  • "suite_identifier": "A",
  • "floor_identifier": "1",
  • "district_name": "1",
  • "post_box": "POB123",
  • "post_code": "12345",
  • "city": "Bernau",
  • "country_subentity": "Brandenburg",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "address_id": 0
}

Change address of a (third) person

Change an already existing address of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of a person

address_id
required
integer <int64> (id_number)

ID of an address

Request Body schema: application/json
required

Address to set

address_type
string
Default: "L"
Enum: "L" "D"

Type of the address

street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Request samples

Content type
application/json
{
  • "address_type": "L",
  • "street": "Hauptstr.",
  • "building_identifier": "1",
  • "suite_identifier": "A",
  • "floor_identifier": "1",
  • "district_name": "1",
  • "post_box": "POB123",
  • "post_code": "12345",
  • "city": "Bernau",
  • "country_subentity": "Brandenburg",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Delete address

Limit the validity of a person's address

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of a person

address_id
required
integer <int64> (id_number)

ID of an address

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get person's verification codes

get info on sent out verification codes

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

query Parameters
filter_by_receiver_type
string
Enum: "E" "S" "P"

optionally filter receiver type

  • 'E'mailaddress
  • 'S'ms number
  • 'P'ush token

Responses

Response Schema: application/json
Array
receiver_type
required
string
Enum: "E" "S" "P"
  • 'E'mailaddress
  • 'S'ms number
  • 'P'ush token
receiver
required
string

the receiver of the verification code

datetime_create
required
string <date-time>

date and time the verification code was created

invalid_from
required
string <date-time>
datetime_update
string <date-time>

date and time the verification code used or its state updated

record_state
required
string
Enum: "A" "U" "D" "T"
  • 'A'ctive
  • 'D'eactivated
  • 'U'sed
  • 'T'imed out
process_type
required
string
Enum: "S" "B" "R" "2" "M" "E"
  • self 'S'ign-up
  • 'B'ackoffice sign-up
  • 'R'eset password
  • '2'-factor-athentification
  • s'M's phone verification
  • 'E'mail address change

Response samples

Content type
application/json
[
  • {
    }
]

get person data

get data of a third person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
person_id
required
integer <int64>

ID of the person

datetime_create
required
string <date-time>

Date and time this person was created

datetime_update
required
string <date-time>

Date and time this entry was last updated

state
required
string
Enum: "S" "V" "I" "C"

State of the person

name
string <= 80 characters

The person's name

given_name
string <= 80 characters

The person's given name

birth_date
string <date>

The person's birth date

gender
string
Enum: "M" "F" "X"

The person's gender

nationality
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

The person's nationality

primary_email_address
string <email> <= 255 characters

The (verified) primary email address of the person

primary_phone_number
string <= 30 characters

The primary phone number of the person in format E.164

is_merchant
required
boolean

Indicates if the person is a merchant/company

company_name
string <= 80 characters

Name of the company in case of a merchant/company

birth_city
string <= 80 characters

City or municipality the person was born

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

person_alias
string

The person's alias

client_type
string
Enum: "B" "R"

Type of the person

Array of objects

Response samples

Content type
application/json
{
  • "person_id": 0,
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "datetime_update": "2019-08-24T14:15:22Z",
  • "state": "S",
  • "name": "example",
  • "given_name": "user",
  • "birth_date": "1970-12-24",
  • "gender": "M",
  • "nationality": "ABW",
  • "primary_email_address": "anna@domain.tld",
  • "primary_phone_number": 49123456789,
  • "is_merchant": false,
  • "company_name": "ibm",
  • "birth_city": "Berlin",
  • "pep": true,
  • "fatca": true,
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "person_alias": "string",
  • "client_type": "B",
  • "external_identifiers": [
    ]
}

change other persons data

change other persons data

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required

the persons data

gender
string
Enum: "M" "F" "X"

Gender of the person

birth_date
string <date>

Birth date of the person

birth_city
string <= 80 characters

Birth city or municipality of the person

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

name
string <= 100 characters

Name of the person

given_name
string <= 100 characters

Given name of the person

person_alias
string

Alias of the person

Responses

Request samples

Content type
application/json
{
  • "gender": "M",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "pep": true,
  • "fatca": true,
  • "name": "Mustermann",
  • "given_name": "Max",
  • "person_alias": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete a person

initiate async deletion of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

query Parameters
reason
required
string
Enum: "ClientRequest" "AMLTechnicalError" "Other3rdPartyRequest" "ImmediateClosure"
comment
string <= 100 characters

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get settings

get current settings for selected person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
language
required
string (language)
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

ISO-639-1 language code

timezone
string (timezone) <= 50 characters

time zone name see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fortaleza - America/Fort_Nelson - America/Fort_Wayne - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indianapolis - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Porto_Acre - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/Stanley - Atlantic/St_Helena - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/North - Australia/NSW - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/East-Saskatchewan - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - CET - Chile/Continental - Chile/EasterIsland - CST6CDT - Cuba - EET - Egypt - Eire - EST - EST5EDT - Etc/GMT - Etc/GMT0 - Etc/GMT-0 - Etc/GMT+0 - Etc/GMT-1 - Etc/GMT+1 - Etc/GMT-10 - Etc/GMT+10 - Etc/GMT-11 - Etc/GMT+11 - Etc/GMT-12 - Etc/GMT+12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT+2 - Etc/GMT-3 - Etc/GMT+3 - Etc/GMT-4 - Etc/GMT+4 - Etc/GMT-5 - Etc/GMT+5 - Etc/GMT-6 - Etc/GMT+6 - Etc/GMT-7 - Etc/GMT+7 - Etc/GMT-8 - Etc/GMT+8 - Etc/GMT-9 - Etc/GMT+9 - Etc/Greenwich - Etc/UCT - Etc/Universal - Etc/UTC - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT0 - GMT-0 - GMT+0 - Greenwich - Hongkong - HST - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - MST - MST7MDT - Navajo - NZ - NZ-CHAT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - posixrules - PRC - PST8PDT - ROC - ROK - Singapore - Turkey - UCT - Universal - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/Eastern - US/East-Indiana - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - WET - W-SU - Zulu

person_data
object

opaque object where the frontend can store data

Response samples

Content type
application/json
{
  • "language": "de",
  • "timezone": "UTC",
  • "person_data": {
    }
}

replace setting

set current settings for selected person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required

the settings

language
required
string (language)
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

ISO-639-1 language code

timezone
string (timezone) <= 50 characters

time zone name see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fortaleza - America/Fort_Nelson - America/Fort_Wayne - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indianapolis - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Porto_Acre - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/Stanley - Atlantic/St_Helena - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/North - Australia/NSW - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/East-Saskatchewan - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - CET - Chile/Continental - Chile/EasterIsland - CST6CDT - Cuba - EET - Egypt - Eire - EST - EST5EDT - Etc/GMT - Etc/GMT0 - Etc/GMT-0 - Etc/GMT+0 - Etc/GMT-1 - Etc/GMT+1 - Etc/GMT-10 - Etc/GMT+10 - Etc/GMT-11 - Etc/GMT+11 - Etc/GMT-12 - Etc/GMT+12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT+2 - Etc/GMT-3 - Etc/GMT+3 - Etc/GMT-4 - Etc/GMT+4 - Etc/GMT-5 - Etc/GMT+5 - Etc/GMT-6 - Etc/GMT+6 - Etc/GMT-7 - Etc/GMT+7 - Etc/GMT-8 - Etc/GMT+8 - Etc/GMT-9 - Etc/GMT+9 - Etc/Greenwich - Etc/UCT - Etc/Universal - Etc/UTC - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT0 - GMT-0 - GMT+0 - Greenwich - Hongkong - HST - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - MST - MST7MDT - Navajo - NZ - NZ-CHAT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - posixrules - PRC - PST8PDT - ROC - ROK - Singapore - Turkey - UCT - Universal - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/Eastern - US/East-Indiana - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - WET - W-SU - Zulu

person_data
object

opaque object where the frontend can store data

Responses

Request samples

Content type
application/json
{
  • "language": "de",
  • "timezone": "UTC",
  • "person_data": {
    }
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get recent passport

get recent passport/id card of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
passport_id
integer <int64> (id_number)

An internal ID

document_type
string (id_document_type)
Enum: "I" "P"
  • I - ID card * P - passport
name
string <= 80 characters

the persons name

given_name
string <= 80 characters

the persons given name

birth_date
string <date>

the persons birth date

birth_city
string <= 80 characters

City or municipality

nationality
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

issuing_country
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

birth_name
string <= 80 characters
academic_title_id
integer
passport_number
string <= 16 characters

Response samples

Content type
application/json
{
  • "passport_id": 0,
  • "document_type": "I",
  • "name": "example",
  • "given_name": "user",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "nationality": "ABW",
  • "issuing_country": "ABW",
  • "birth_name": "string",
  • "academic_title_id": 0,
  • "passport_number": "string"
}

save passport

save passport of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required
document_type
required
string (id_document_type)
Enum: "I" "P"
  • I - ID card * P - passport
name
required
string <= 80 characters

the persons name

given_name
required
string <= 80 characters

the persons given name

birth_date
required
string <date>

the persons birth date

birth_city
required
string <= 80 characters

City or municipality

nationality
required
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

issuing_country
required
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

birth_name
string <= 80 characters
academic_title_id
required
integer <int32>
object (new_address_from_passport)

an address

passport_number
required
string <= 16 characters

Responses

Response Schema: application/json
passport_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "document_type": "I",
  • "name": "Nachname",
  • "given_name": "Vorname",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "nationality": "ABW",
  • "issuing_country": "ABW",
  • "birth_name": "string",
  • "academic_title_id": 0,
  • "address": {
    },
  • "passport_number": "string"
}

Response samples

Content type
application/json
{
  • "passport_id": 0
}

get email addresses

get all email addresses of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
Array
email_address_id
integer <int64> (id_number)

An internal ID

email_address
required
string <email> <= 255 characters

the email address

state
required
string
Enum: "V" "C"
  • V = verified
  • C = not verified; have valid code for verification
datetime_confirmed
string <date-time>

date and time this email address was confirmed

is_primary
boolean

indicate a primary email_address

Response samples

Content type
application/json
[
  • {
    }
]

add email address to person

add a new email address to an already created person. this email address will receive a confirmation link. using this link one can confirm the email address.

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required

Address to add

email_address
required
string <email> <= 255 characters

the email address

Responses

Request samples

Content type
application/json
{
  • "email_address": "anna@domain.tld"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

address_delete

limit the validity of the connection person - email address

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

email_address_id
required
integer <int64> (id_number)

id of the email address

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

make an email address the primary email address

make the current email address the primary email address

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

email_address_id
required
integer <int64> (id_number)

id of the email address

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

set pin

updates a persons pin code to a given number

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required

the pin

pin
required
string <[0-9].*> (pin_type)

the pin code to authorize actions on the atm

Responses

Request samples

Content type
application/json
{
  • "pin": "123131"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

reset password

request mail for resetting a persons password

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

query Parameters
email_address
string <email>

optionally add a new email address in case no validated email address exists

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get phone numbers

get all phone numbers of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
Array
phone_number_id
required
integer <int64> (id_number)

An internal ID

is_primary
required
boolean

indicate a primary phone number

datetime_update
required
string <date-time>

date and time this entry was last updated

phone_number
required
string <= 30 characters
phone_number_type
required
string (phone_number_type)
Enum: "M" "F"

Phone Number Type:

  • 'M' - Mobile
  • 'F' - Fixed Network
is_validated
required
boolean

indicates if a phone number has been validated via sms code

Response samples

Content type
application/json
[
  • {
    }
]

add phone to person

add a new phone to an already created person. please note: only mobile phone number will be accepted and the phone number needs to be verified through the sms code sent to it

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: application/json
required

Phone to add

phone_number
required
string <= 30 characters

Phone number

default_region
string
Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" … 235 more

Default region

phone_number_type
string
Enum: "M" "F"

Type of the phone number

Responses

Response Schema: application/json
phone_number_id
integer <int64> (id_number)

An internal ID

need_verification
required
boolean

if the client allows fixed line phone numbers, they cannot be validated using sms. there we have no chance besides trust. in such cases no phone number validation is need and the number is active right away

Request samples

Content type
application/json
{
  • "phone_number": "+(681) 821235",
  • "default_region": "DE",
  • "phone_number_type": "M"
}

Response samples

Content type
application/json
{
  • "phone_number_id": 0,
  • "need_verification": true
}

delete phone

limit the validity of the connection person - phone

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

phone_number_id
required
integer <int64> (id_number)

id of the phone

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

make a phone number the primary phone number

make the current number the primary phone number

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

phone_number_id
required
integer <int64> (id_number)

id of the phone

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get all face images

Get all face images of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Responses

Response Schema: application/json
Array
face_id
required
integer <int64> (id_number)

An internal ID

datetime_update
required
string <date-time>

date and time this entry was last updated

type
required
string
Enum: "image/bmp" "image/jpeg" "image/png"

Response samples

Content type
application/json
[
  • {
    }
]

add face to person

add a new face to an already created person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

Request Body schema: multipart/form-data
required

Face to add

file
required
string <binary>

if available, the image that is stored on the passport

Responses

Response Schema: application/json
face_id
required
integer <int64> (id_number)

An internal ID

Response samples

Content type
application/json
{
  • "face_id": 0
}

get a face image

get a specific face image

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

face_id
required
integer <int64> (id_number)

id of the face

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete a face

limit the validity of the connection person - face

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

face_id
required
integer <int64> (id_number)

id of the face

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get a face image to display it to a third person

get a specific face image

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

id of person to fetch

query Parameters
token
required
string
Example: token=AABBCCCD

a security_token

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

list the most recent tax pot balances

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

Responses

Response Schema: application/json
year
required
string = 4 characters
betrag_versteuert_1_currency
required
string
Value: "EUR"
betrag_versteuert_1
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_1_currency
required
string
Value: "EUR"
kest_1
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_1_currency
required
string
Value: "EUR"
soli_1
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_1_currency
required
string
Value: "EUR"
kist_1
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

betrag_versteuert_2_currency
required
string
Value: "EUR"
betrag_versteuert_2
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_2_currency
required
string
Value: "EUR"
kest_2
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_2_currency
required
string
Value: "EUR"
soli_2
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_2_currency
required
string
Value: "EUR"
kist_2
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_nv_currency
required
string
Value: "EUR"
frei_nv
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_aus_currency
required
string
Value: "EUR"
frei_aus
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_bv_currency
required
string
Value: "EUR"
frei_bv
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_ki_currency
required
string
Value: "EUR"
frei_ki
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_avvt_currency
string
Value: "EUR"
schatt_avvt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_svvt_currency
string
Value: "EUR"
schatt_svvt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_qvt_currency
string
Value: "EUR"
schatt_qvt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

vsn_fsa_currency
required
string
Value: "EUR"
vsn_fsa
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

avvt_currency
required
string
Value: "EUR"
avvt
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

svvt_currency
required
string
Value: "EUR"
svvt
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

qvt_currency
required
string
Value: "EUR"
qvt
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

gewinn_vor_fsa
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
application/json
{
  • "year": "stri",
  • "betrag_versteuert_1_currency": "EUR",
  • "betrag_versteuert_1": "string",
  • "kest_1_currency": "EUR",
  • "kest_1": "string",
  • "soli_1_currency": "EUR",
  • "soli_1": "string",
  • "kist_1_currency": "EUR",
  • "kist_1": "string",
  • "betrag_versteuert_2_currency": "EUR",
  • "betrag_versteuert_2": "string",
  • "kest_2_currency": "EUR",
  • "kest_2": "string",
  • "soli_2_currency": "EUR",
  • "soli_2": "string",
  • "kist_2_currency": "EUR",
  • "kist_2": "string",
  • "frei_nv_currency": "EUR",
  • "frei_nv": "string",
  • "frei_aus_currency": "EUR",
  • "frei_aus": "string",
  • "frei_bv_currency": "EUR",
  • "frei_bv": "string",
  • "frei_ki_currency": "EUR",
  • "frei_ki": "string",
  • "schatt_avvt_currency": "EUR",
  • "schatt_avvt": "string",
  • "schatt_svvt_currency": "EUR",
  • "schatt_svvt": "string",
  • "schatt_qvt_currency": "EUR",
  • "schatt_qvt": "string",
  • "vsn_fsa_currency": "EUR",
  • "vsn_fsa": "string",
  • "avvt_currency": "EUR",
  • "avvt": "string",
  • "svvt_currency": "EUR",
  • "svvt": "string",
  • "qvt_currency": "EUR",
  • "qvt": "string",
  • "gewinn_vor_fsa": "string"
}

the persons tax activity

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

ID of the person

query Parameters
date_from
required
string <date>

filter by date

date_to
required
string <date>

filter by date

Responses

Response Headers
x-result-total
integer

the (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
ta_id
integer <int64>
transaction_id
integer <int64>
identifier
string
datetime_create
string <date-time>
akti_gewinn_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

akti_verlust_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

sons_gewinn_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

sons_verlust_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

inl_div_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

inl_div_p27_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

anr_qst_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_non_fonds_gewinn_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_non_fonds_verlust_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_fonds_gewinn_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_fonds_verlust_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

wertlos_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

pvg_innerhalb_speku_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

pvg_ausserhalb_speku_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

betrag_versteuert_1_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_1_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_1_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_1_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

betrag_versteuert_2_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_2_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_2_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_2_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_nv_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_aus_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_bv_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_ki_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_avvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_svvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_qvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

vsn_fsa_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

avvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

svvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

qvt_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

akti_gewinn_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

akti_verlust_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

sons_gewinn_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

sons_verlust_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

inl_div_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

inl_div_p27_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

anr_qst_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_non_fonds_gewinn_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_non_fonds_verlust_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_fonds_gewinn_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

altfall_fonds_verlust_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

wertlos_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

pvg_innerhalb_speku_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

pvg_ausserhalb_speku_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

betrag_versteuert_1_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_1_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_1_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_1_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

betrag_versteuert_2_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kest_2_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

soli_2_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

kist_2_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_nv_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_aus_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_bv_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

frei_ki_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_avvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_svvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

schatt_qvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

vsn_fsa_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

avvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

svvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

qvt_balance
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
application/json
[
  • {
    }
]

get tax data such as IDs of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

Responses

Response Schema: application/json
german_tax_resident
boolean

TRUE if the person is a german tax resident

german_tax_id
string

the german tax ID

Array of objects (tin)
church_tax_rate
number

church tax rate, e.g. 0.075 for a rate of 7.5%

Response samples

Content type
application/json
{
  • "german_tax_resident": true,
  • "german_tax_id": "string",
  • "tax_ids": [
    ],
  • "church_tax_rate": 0.075
}

add or update tax IDs

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>
Request Body schema: application/json
required

all current tax IDs

Array
tin
required
string

identification number

tin_country
required
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

type
required
string
Enum: "tax_id" "tax_number" "vat"
  • tax ID (Steuer ID)
  • tax number (Steuernummer)
  • VAT number (Umsatzsteuer-Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

list all persons the given person is/was married to or equivalent

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

Responses

Response Schema: application/json
Array
person_id
required
integer <int64>
name
required
string <= 80 characters
given_name
required
string <= 80 characters
date_from
required
string <date>
date_to
required
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

state that 2 persons are married to each other or equivalent

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

unique ID of a person

person_id_married_to
required
integer <int64>

unique ID of a person

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

divorce, split-up, or death of one of the partners

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

unique ID of a person

person_id_married_to
required
integer <int64>

unique ID of a person

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete incorrectly submitted data

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

unique ID of a person

person_id_married_to
required
integer <int64>

unique ID of a person

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

list all exemption orders of the person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

Responses

Response Schema: application/json
Array
exemption_order_id
required
integer <int64>
external_identifier
string <uuid> (UUID)
valid_from
required
string <date>
valid_until
required
string <date>
currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
partner_person_id
integer <int64>

Response samples

Content type
application/json
[
  • {
    }
]

list all non-assessment certificates of the person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>

Responses

Response Schema: application/json
Array
nv_id
required
integer <int64>

internal identifier

external_identifier
required
string <= 25 characters
type
required
string <= 5 characters
type_description
required
string
date_from
required
string <date>
date_to
required
string <date>
partner_person_id
integer <int64>

Response samples

Content type
application/json
[
  • {
    }
]

save or edit german tax resident flag

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64>
query Parameters
german_tax_resident
required
boolean

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

request KISTAM Anlassanfrage for person

add person to queue for KISTAM Anlassanfrage

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person to request KISTAM for

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

list all church tax rates of the person

Authorizations:
oidc_headerbasicAuth
path Parameters
person_id
required
integer <int64> (id_number)

ID of the person

Responses

Response Schema: application/json
Array
state
required
string <= 25 characters
kistam_request_date
string <date>
kistam_response_received
string <date>
church_tax_rate
string[0-9]{1,3}(\.[0-9]{1})?

church tax rate (in %)

tax_raising_organisational_unit_identifier
string <= 6 characters
tax_raising_organisational_unit_description
string <= 140 characters
year
integer

year in which the tax rate applies

Response samples

Content type
application/json
[
  • {
    }
]

Booking statistics

Booking statistics and booking-related summaries

Booking statistics

Statistics on booking states and durations for given time interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
Example: date_from=2022-12-24

Start date w.r.t. transaction creation

date_to
required
string <date>
Example: date_to=2022-12-24

End date w.r.t. transaction creation

Responses

Response Schema: application/json
Array
name
string

Name of the transaction source

date_create
string <date>

Date of transaction creation

unbooked_txn
integer <int64>

Number of transactions waiting for booking

failed_txn
integer <int64>

Number of transactions where booking failed

number_of_txn
integer <int64>

Total number of transactions

min_timeused
number <double>

Min. booking duration

avg_timeused
number <double>

Avg. booking duration

med_timeused
number <double>

Med. booking duration

p99_timeused
number <double>

P99 booking duration

max_timeused
number <double>

Max. booking duration

Response samples

Content type
application/json
[
  • {
    }
]

Booking statistics daily

Statistics on booking states and durations of today

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
name
string

Name of the transaction source

booked_txn
integer <int64>

Number of booked transactions

unbooked_txn
integer <int64>

Number of transactions waiting for booking

failed_txn
integer <int64>

Number of transactions where booking failed

min_timeused
number <double>

Min. booking duration

med_timeused
number <double>

Med. booking duration

avg_timeused
number <double>

Avg. booking duration

p99_timeused
number <double>

P99 booking duration

max_timeused
number <double>

Max. booking duration

Response samples

Content type
application/json
[
  • {
    }
]

Corporate actions

Corporate action jobs, processing, and reference data

List CA job batches

List all CA job batches created in the specified time interval

Authorizations:
oidc_headerbasicAuth
query Parameters
creation_date_from
required
string <date>

Start date of CA job batch creation

creation_date_to
required
string <date>

End date of CA job batch creation

Responses

Response Schema: application/json
Array
ca_batch_processing_id
integer <int64>

ID of the CA processing batch

person_id_create
integer <int64>

ID of the person that created the batch

person_create
string <= 161 characters

given name and name of the person that created the batch

datetime_create
string <date-time>

date and time the CA batch was created

datetime_start
string <date-time>

date and time the CA batch processing started

datetime_finish
string <date-time>

date and time the CA batch processing finished

ca_job_ids
Array of integers <int64> [ items <int64 > ]

Response samples

Content type
application/json
[
  • {
    }
]

Create a CA job batch

Batch CA jobs so they can be processed together

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json

The CA jobs to batch

ca_job_ids
required
Array of integers <int64> [ items <int64 > ]

Responses

Response Schema: application/json
ca_batch_processing_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "ca_job_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "ca_batch_processing_id": 0
}

CA job batch details

Get an overviee of the batched CA jobs

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_batch_processing_id
required
integer <int64>

ID of the CA job batch

Responses

Response Schema: application/json
Array
ca_job_id
integer <int64>

ID of the CA job

ca_type
string <= 6 characters

memo of the CA type

ca_template_version
integer <int32>

version of the parameter template

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
ag
string <= 1 characters

WM AG (Arbeitsgebiet)

bid
string <= 12 characters

WM BID

depository_id
integer <int32>

ID of the depository

depository_name
string <= 30 characters

name of the depository, e.g. CBF

record_date
string <date>

record date

state
string (ca_job_state)
Enum: "C" "Q" "R" "P" "F" "W" "X" "Y" "Z" "D"
  • C - Created
  • Q - Pending release
  • R - Released
  • P - Processing
  • F - Finished
  • W - Pending reversal release
  • X - Reversal released
  • Y - Reversal processing
  • Z - Reversal finished
  • D - Discarded
state_description
string <= 80 characters

description of the CA job state

number_of_accounts
integer <int64>

number of all security accounts affecetd by the CA job

number_of_transactions_total
integer <int64>

number of all transactions created by the CA job

number_of_transactions_successful
integer <int64>

number of successfully booked transactions

numner_of_transactions_failed
integer <int64>

number of failed transactions

Response samples

Content type
application/json
[
  • {
    }
]

Process a CA job batch

Trigger processing of all CA jobs within a batch

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_batch_processing_id
required
integer <int64>

ID of the CA job batch

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Create CA job

Create a new CA job (possibly with basic parameters only)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json

Parameters of the new CA job

Any of
ca_type
required
string <= 6 characters
isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}
depository_id
required
integer <int64>
Deprecated

get list of allowed IDs via GET /parameter_enums

depository
string <= 30 characters

depository to be used, get it from attribute name of GET /ca/depositories

ag
string = 1 characters
bid
string <= 12 characters
wm_data
object

Responses

Response Schema: application/json
ca_job_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "ca_type": "string",
  • "isin": "string",
  • "depository_id": 0,
  • "depository": "string",
  • "ag": "s",
  • "bid": "string",
  • "wm_data": { }
}

Response samples

Content type
application/json
{
  • "ca_job_id": 0
}

Discard CA job

Discard a created CA job

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Get CA job parameters

Get the parameters of ca job including header parameters

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of the CA job

Responses

Response Schema: application/json
ca_job_id
required
integer <int64>
ca_type
required
string <= 6 characters
isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}
wkn
string <= 6 characters
security_description
string <= 61 characters
record_date
string <date>
state
required
string (ca_job_state)
Enum: "C" "Q" "R" "P" "F" "W" "X" "Y" "Z" "D"
  • C - Created
  • Q - Pending release
  • R - Released
  • P - Processing
  • F - Finished
  • W - Pending reversal release
  • X - Reversal released
  • Y - Reversal processing
  • Z - Reversal finished
  • D - Discarded
ca_template_version
required
integer
ag
string <= 1 characters
bid
string <= 12 characters
depository
string <= 30 characters
parameter
object
required
Array of objects (ca_template_parameter)
coaf
string <= 16 characters

COAF (Corporate Action Event Reference)

corp
string <= 16 characters

CORP (Corporate Action Reference)

caev
string (caev) = 4 characters

CAEV (Corporate Action Event Indicator)

Response samples

Content type
application/json
{
  • "ca_job_id": 0,
  • "ca_type": "string",
  • "isin": "string",
  • "wkn": "string",
  • "security_description": "string",
  • "record_date": "2019-08-24",
  • "state": "C",
  • "ca_template_version": 0,
  • "ag": "s",
  • "bid": "string",
  • "depository": "string",
  • "parameter": { },
  • "parameter_template": [
    ],
  • "coaf": "string",
  • "corp": "string",
  • "caev": "stri"
}

Edit CA job parameters

Edit the parameters of a CA job including header parameters

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of the CA job

Request Body schema: application/json

The edited CA job parameters

record_date
required
string <date>

set record date here, in case it could not be extracted from WM data

parameter
required
object

parameters as described in template

coaf
string <= 16 characters

COAF (Corporate Action Event Reference)

corp
string <= 16 characters

CORP (Corporate Action Reference)

caev
string (caev) = 4 characters

CAEV (Corporate Action Event Indicator)

Responses

Request samples

Content type
application/json
{
  • "record_date": "2019-08-24",
  • "parameter": { },
  • "coaf": "string",
  • "corp": "string",
  • "caev": "stri"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

CA job parameter history

Get the parameter history of a CA job

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response Schema: application/json
Array
valid_from
required
string <date-time>

date and time the parameters were saved

invalid_from
string <date-time>

date and time the parameters were updated

person_id_create
required
integer

ID of the person that saved the parameters; 0 for system

person_name_create
string <= 80 characters

name of the person that saved the parameters if applicable

person_given_name_create
string <= 80 characters

given name of the person that saved the parameters if applicable

parameter
required
object

the CA job parameter

Response samples

Content type
application/json
[
  • {
    }
]

Release a CA job

Release a created CA job (1st or 2nd release)

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Re-process a CA job

Process a finished CA job again

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Abort CA job reversal

Abort the reversal (pending or released) of CA job

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Reverse CA job

Release reversal of a CA job (1st and 2nd release)

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Suspend a CA job

Move a released CA job back to state "created"

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_job_id
required
integer <int64>

ID of a CA job

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

CA job actions

List allowed CA job actions for different CA job states

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
state
required
string <= 1 characters
actions
required
Array of strings

Response samples

Content type
application/json
[
  • {
    }
]

CA job states

List CA job states and thier descriptions

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
state
required
string <= 1 characters
description
required
string <= 80 characters

Response samples

Content type
application/json
[
  • {
    }
]

Get CA job template

Get the parameter template for a CA type and version

Authorizations:
oidc_headerbasicAuth
path Parameters
ca_type
required
string <= 6 characters

CA type

version
required
integer <int32>

Verion of the CA job template

Responses

Response Schema: application/json
Array
name
required
string
required
required
boolean
type
required
string
format
string
maxLength
integer
minLength
integer
minimum
integer <int64>
maximum
integer <int64>
exclusiveMinimum
boolean
exclusiveMaximum
boolean
precision
integer
scale
integer
pattern
string
enum
Array of strings
position
required
integer <int32>
grouping
required
string <= 10 characters
x-format
string
Array of objects

Response samples

Content type
application/json
[
  • {
    }
]

List CA jobs

List CA jobs for given parameters (at least 1 parameter must be given!)

Authorizations:
oidc_headerbasicAuth
query Parameters
ca_job_id
integer <int64>

ID of a CA job

ca_type
string <= 6 characters

Type of a CA job

isin
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}

ISIN

record_date
string <date>

Record date (Bestandsstichtag)

state
string (ca_job_state)
Enum: "C" "Q" "R" "P" "F" "W" "X" "Y" "Z" "D"

State of the CA job

user_can_release
boolean

If true, show only jobs then can be released (incl. release of reversal) by the user

Responses

Response Headers
x-result-total
integer

The (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
ca_job_id
required
integer <int64>
ca_type
required
string <= 6 characters
isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}
record_date
string <date>
state
required
string (ca_job_state)
Enum: "C" "Q" "R" "P" "F" "W" "X" "Y" "Z" "D"
  • C - Created
  • Q - Pending release
  • R - Released
  • P - Processing
  • F - Finished
  • W - Pending reversal release
  • X - Reversal released
  • Y - Reversal processing
  • Z - Reversal finished
  • D - Discarded
ca_template_version
required
integer

Response samples

Content type
application/json
[
  • {
    }
]

CA types

List CA types

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ca_type
required
string <= 6 characters
description
required
string

Response samples

Content type
application/json
[
  • {
    }
]

List CAEV's

List of CAEV (Corporate Action Event Indicator)

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
caev
required
string (caev) = 4 characters

CAEV (Corporate Action Event Indicator)

short_text
required
string <= 80 characters

Response samples

Content type
application/json
[
  • {
    }
]

List of depositories

List all depositories

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
depository_id
required
integer
name
required
string

Response samples

Content type
application/json
[
  • {
    }
]

Master data for security

Get master data from system for given search parameter (max. 10 best matches)

Authorizations:
oidc_headerbasicAuth
query Parameters
qsearch_parameter
required
string <= 61 characters

E.g. ISIN, WKN, description

Responses

Response Schema: application/json
Array
isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
wkn
string = 6 characters
ticker_symbol
string <= 4 characters
security_quotation_unit
string <= 25 characters

description of the quotation unit

security_description
string <= 61 characters
product_category_segmentation
string <= 80 characters

Response samples

Content type
application/json
[
  • {
    }
]

WMDaten details

Get WMDaten details for a specific ISIN, AG, and BID

Authorizations:
oidc_headerbasicAuth
query Parameters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
Example: isin=DE0007100000

ISIN

ag
required
string <= 1 characters

AG ("Arbeitsgebiet")

bid
required
string <= 12 characters

BID ("Bezugsidentifikationsnummer")

Responses

Response Schema: application/json
isinCode
string
ag
string
bid
string
lastModification
string <date-time>
datFields
object
txtFields
object
object (table_detail)

Response samples

Content type
application/json
{
  • "isinCode": "string",
  • "ag": "string",
  • "bid": "string",
  • "lastModification": "2019-08-24T14:15:22Z",
  • "datFields": { },
  • "txtFields": { },
  • "table": {
    }
}

WMDaten details for list of BIDs

Just for testing! Get WMDaten details for a list of ISIN, AG, and BID

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
Array
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
ag
required
string <= 1 characters
bid
required
string <= 12 characters

Responses

Response Schema: application/json
Array
isinCode
string
ag
string
bid
string
lastModification
string <date-time>
datFields
object
txtFields
object
object (table_detail)

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List CA events

List all CA events for a given ISIN

Authorizations:
oidc_headerbasicAuth
path Parameters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
Example: DE0007100000

ISIN

query Parameters
ag
string <= 1 characters

AG ("Arbeitsgebiet")

date_from
string <date>

Start date

date_to
string <date>

End date

Responses

Response Schema: application/json
Array
isinCode
string
ag
string
bid
string
lastModification
string <date-time>
typeOfEvent
string
sourceOfEvent
string
relevantDate
string
sourceOfDate
string

Response samples

Content type
application/json
[
  • {
    }
]

Configuration

System-wide configuration and feature settings

List of salutations/ titles

Get a list of possible salutations/ titles

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
academic_title_id
required
integer

ID of the academic title

description
required
string <= 10 characters

Description of the academic title

Response samples

Content type
application/json
[
  • {
    }
]

List of account types

List all configured account types

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
account_type_id
required
integer <int32>

ID of the account type

description
required
string

Unique name/ description

account_kind
required
string
Enum: "A" "D"
  • A - cash account
  • D - securities account (Depot)
account_class
required
string
Enum: "C" "S"
  • C - customer
  • S - system
memo
required
string

Unique memorizable name of the account type

Response samples

Content type
application/json
[
  • {
    }
]

Reasons for blocking holdings

Return IDs and descriptions of reasons for blocking security holdings

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
block_securities_reason_id
required
integer

ID for internal use

description
required
string <= 80 characters

Textual description

Response samples

Content type
application/json
[
  • {
    }
]

Broker details ("Sub-Makler")

Details on a specific broker ("Sub-Makler")

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of a "Sub-Makler" as used in MTB

Responses

Response Schema: application/json
submakler
required
integer <int32>

Identifier as used in MTB

description
string <= 80 characters

Further description, e.g. name

last_updated
required
string <date-time>

Date and time the broker was last updated (or created)

last_updated_by
required
string <= 161 characters

Given name and name of the person that last updated (or created) the broker

Response samples

Content type
application/json
{
  • "submakler": 0,
  • "description": "string",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "last_updated_by": "string"
}

Save or update a broker

Save or update a broker ("Sub-Makler") details

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of a "Sub-Makler" as used in MTB

query Parameters
description
string <= 80 characters

Further description in addition to identifier, e.g. name of the broker

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Delete a broker

Delete a broker ("Sub-Makler")

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of a "Sub-Makler" as used in MTB

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

List brokers

List all currently valid brokers ("Sub-Makler")

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
submakler
required
integer <int32>

Identifier as used in MTB

description
string <= 80 characters

Further description, e.g. name

last_updated
required
string <date-time>

Date and time the broker was last updated (or created)

last_updated_by
required
string <= 161 characters

Given name and name of the person that last updated (or created) the broker

Response samples

Content type
application/json
[
  • {
    }
]

Get accounting profit center assignment

Get a specific accounting profit center assignment

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of the broker

kv_nr
required
string <= 4 characters

Identifier of the external depository (Kassenvereinsnummer)

Responses

Response Schema: application/json
submakler
required
integer <int32>

Identifier of the broker

kv_nr
string <= 5 characters

Identifier of the external depository (Kassenvereinsnummer)

acc_profit_center
string <= 5 characters

Identifier of the accounting profit center (ReWe-Profitcenter)

last_updated
string <date-time>

Date and time the assignment was last updated (or created)

last_updated_by
string <= 161 characters

Given name and name of the person that last updated (or created) the assignment

Response samples

Content type
application/json
{
  • "submakler": 0,
  • "kv_nr": "strin",
  • "acc_profit_center": "strin",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "last_updated_by": "string"
}

Save or update an assignment of a broker and KV-Nr. to an accounting profit center

Save or update an assignment of a broker ("Sub-Makler") and KV-Nr. to an accounting profit center ("ReWe-Kostenstelle")

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of the broker

kv_nr
required
string <= 4 characters

Identifier of the external depository (Kassenvereinsnummer)

query Parameters
acc_profit_center
required
string <= 5 characters

Identifier of the accounting profit center

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Delete an assignment of a broker and KV-Nr. to an accounting profit center

Delete an assignment of a broker ("Sub-Makler") and KV-Nr. to an accounting profit center ("ReWe-Kostenstelle")

Authorizations:
oidc_headerbasicAuth
path Parameters
submakler
required
integer <int32>

Identifier of the broker

kv_nr
required
string <= 4 characters

Identifier of the external depository (Kassenvereinsnummer)

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

List of accounting profit center assignments

List all currently valid assignments of accounting profit centers

Authorizations:
oidc_headerbasicAuth
query Parameters
submakler
integer <int32>

Filter by identifier of the broker

kv_nr
string <= 4 characters

Filter by identifier of the external depository (Kassenvereinsnummer)

acc_profit_center
string <= 5 characters

Filter by identifier of the accounting profit center

show_only_unassigned
required
boolean
Default: false

If TRUE, then show only brokers, which are not assigned to an accounting profit center

Responses

Response Headers
x-result-total
integer

the (actual) total to be considered for pagination

Response Schema: application/json
Array
submakler
required
integer <int32>

Identifier of the broker

kv_nr
string <= 5 characters

Identifier of the external depository (Kassenvereinsnummer)

acc_profit_center
string <= 5 characters

Identifier of the accounting profit center (ReWe-Profitcenter)

last_updated
string <date-time>

Date and time the assignment was last updated (or created)

last_updated_by
string <= 161 characters

Given name and name of the person that last updated (or created) the assignment

Response samples

Content type
application/json
[
  • {
    }
]

List of accounting profit centers

List all currently valid accounting profit centers ("ReWe-Kostenstellen")

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
acc_profit_center
required
string <= 5 characters

Identifier of accounting profit center

last_updated
required
string <date-time>

Date and time the object was last updated (or created)

last_updated_by
required
string <= 161 characters

Given name and name of the person that last updated (or created) the object

Response samples

Content type
application/json
[
  • {
    }
]

List of Gabi overview items

List of all configured Gabi overview items for process monitoring

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
string <= 30 characters

Description of the item being monitored

Response samples

Content type
application/json
[
  • "string"
]

List of transaction sources

List of all transaction sources

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
Any of
string
Enum: "accrual" "biw_depotumsatz" "block_securities" "cash_migration" "ca_order_execution" "ca_job_processing_adds" "ca_job_processing_capg" "ca_job_processing_dvap" "ca_job_processing_dvca" "ca_job_processing_intr" … 43 more

Name of the booking source

Response samples

Content type
application/json
[
  • "accrual"
]

Sub-balances

Return IDs and descriptions of sub-balances

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
subbalance_id
required
integer

ID

description
required
string <= 80 characters

Textual description

Response samples

Content type
application/json
[
  • {
    }
]

External systems

External system integrations and inbound API endpoints

create or update contractual partner

Authorizations:
mtls_dn
path Parameters
code
required
string <= 6 characters

contractual partner code

query Parameters
name
required
string <= 256 characters

contractual partner name

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create or update a client

Authorizations:
mtls_dn
path Parameters
client_id
required
string <uuid> (UUID)

unique external client id

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_type
required
string (client_type)
Enum: "B" "R"

Property of the client

  • B - Business
  • R - Retail
name
required
string <= 80 characters
  • for natural persons it indicates one's family, tribe or community (surname, family, last name)
  • for corporate entities the name of the company etc.
given_name
string <= 80 characters
  • part of the name that identifies a natural person and distinguishes it from other person with the same name
  • also known as forename or first name
birth_date
string <date>

the persons birth date

birth_city
string <= 80 characters

city or municipality the person was born

birth_country
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

federal_state
string (federal_state)
Enum: "other" "DE-00" "DE-SH" "DE-HH" "DE-NI" "DE-HB" "DE-NW" "DE-HE" "DE-RP" "DE-BW" … 8 more

the federal state; for Kapitalertragssteuer (KESt) and Solidaritätszuschlag (Soli)

  • 'other' - 'sonstiges / nicht zuzuodnen'
  • 'DE-00' - 'sonstiges / nicht zuzuodnen'
  • 'DE-SH' - 'Schleswig-Holstein'
  • 'DE-HH' - 'Hamburg'
  • 'DE-NI' - 'Niedersachsen'
  • 'DE-HB' - 'Bremen'
  • 'DE-NW' - 'NRW (Nordrhein-Westfalen)'
  • 'DE-HE' - 'Hessen'
  • 'DE-RP' - 'Rheinland-Pfalz'
  • 'DE-BW' - 'Baden-Württemberg'
  • 'DE-BY' - 'Bayern'
  • 'DE-SL' - 'Saarland'
  • 'DE-BE' - 'Berlin'
  • 'DE-BB' - 'Brandenburg'
  • 'DE-MV' - 'Mecklenburg-Vorpommern'
  • 'DE-SN' - 'Sachsen'
  • 'DE-ST' - 'Sachsen-Anhalt'
  • 'DE-TH' - 'Thüringen'
nationality
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

client_lei
string <= 20 characters

legal entity identifier

default_decision_maker_lei
string <= 20 characters

legal entity identifier of decision maker (see MiFID II requirements)

Array of objects (tin)

taxpayer identification numbers of the client

german_tax_resident
boolean

TRUE, if the client is German tax resident

language
string
Enum: "de" "en"

ISO-639-1 language code

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "client_type": "B",
  • "name": "Wayne",
  • "given_name": "Bruce",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "birth_country": "ABW",
  • "federal_state": "other",
  • "nationality": "ABW",
  • "client_lei": "string",
  • "default_decision_maker_lei": "string",
  • "tin_list": [
    ],
  • "german_tax_resident": true,
  • "language": "de"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

create or update a clients address

Authorizations:
mtls_dn
path Parameters
client_id
required
string <uuid> (UUID)

unique external client id

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
address_type
string
Default: "L"
Enum: "L" "D"

Type of the address

street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "address_type": "L",
  • "street": "Hauptstr.",
  • "building_identifier": "1",
  • "suite_identifier": "A",
  • "floor_identifier": "1",
  • "district_name": "1",
  • "post_box": "POB123",
  • "post_code": "12345",
  • "city": "Bernau",
  • "country_subentity": "Brandenburg",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

create a new clients non assessment certificate

Authorizations:
mtls_dn
header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_ids
required
Array of strings <uuid> (UUID) [ 1 .. 2 ] items [ items <uuid > ]

all clients

type
required
string
Enum: "01" "02" "02_35" "02_36" "02_37" "03"

the type of non-assessment certificate

  • '01' - natural persons (natürliche Personen)
  • '02' - Körperschaften, Personenvereinigungen, Vermögensmassen
  • '03' - unbeschränkt steuerpflichtige und nicht steuerbefreite Körperschaften, Personenvereinigungen, Vermögensmassen
date_from
required
string <date>

date from which the non-assessment certificate is valid; can only be 1st of January

date_to
required
string <date>

date until which the non-assessment certificate is valid; can only be 31st of December

external_identifier
required
string <string> <= 25 characters

external identifier of the non-assessment certificate (NV-Nummer)

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "type": "01",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "external_identifier": "string"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

revoke a clients non assessment certificate

Authorizations:
mtls_dn
header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_ids
required
Array of strings <uuid> (UUID) [ 1 .. 2 ] items [ items <uuid > ]

all clients

date_from
required
string <date>

to identify the non-assessment certificate

date_revoke_from
required
string <date>

date starting from which the non-assessment certificate is not valid anymore; can only be 1st of January

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "date_from": "2019-08-24",
  • "date_revoke_from": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

state that 2 clients are married to each other

Authorizations:
mtls_dn
path Parameters
client_id
required
string <uuid> (UUID)

unique ID of a client

partner_client_id
required
string <uuid> (UUID)

unique ID of a client

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

end clients partnership (divorce, split up, or death)

Authorizations:
mtls_dn
path Parameters
client_id
required
string <uuid> (UUID)

unique ID of a client

partner_client_id
required
string <uuid> (UUID)

unique ID of a client

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

create or update an exemption order

Authorizations:
mtls_dn
path Parameters
exemption_order_id
required
string <uuid> (UUID)

unique ID of the exemption order submission

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_ids
required
Array of strings <uuid> (UUID) [ 1 .. 2 ] items [ items <uuid > ]

all clients related to the account

amount
required
string[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)
minimum: 0.00

applicable amount

currency
required
string
Value: "EUR"

currency of the applicable amount

valid_from
required
string <date>

date from which the exemption order is valid; can only be 1st of January

valid_until
string <date>

date until which the exemption order is valid; can only be 31st of December

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "amount": "string",
  • "currency": "EUR",
  • "valid_from": "2019-08-24",
  • "valid_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

revoke an exemption for given end date

Authorizations:
mtls_dn
path Parameters
exemption_order_id
required
string <uuid> (UUID)

unique ID of the exemption order submission

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_ids
required
Array of strings <uuid> (UUID) [ 1 .. 2 ] items [ items <uuid > ]

all clients related to the account

valid_until
required
string <date>

date until which the exemption order is valid

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

Array of objects
Array of objects
Array of objects
Array of objects
Array of objects

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "valid_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tax_residencies": [
    ],
  • "tax_ids": [
    ],
  • "church_tax_rates": [
    ],
  • "exemption_orders": [
    ],
  • "non_assessment_certificates": [
    ]
}

create an account

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
One of
iban
string (iban) <= 34 characters [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
account_type
required
string
Enum: "cash_account" "fractions_in_cash" "conto_pro_diverse_(cpd)" "rba_cash_account"

type of the account, i.e. cash account

currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

custom_name
string <= 80 characters

a custom name for the account as set by an account owner

account_owner
required
Array of strings <uuid> (UUID) non-empty [ items <uuid > ]

all clients related to the account

account_number_prefixes
Array of strings non-empty [ items = 2 characters ]

all prefixes that should be mapped to this account

contractual_partner_code
required
string <= 6 characters

Responses

Request samples

Content type
application/json
Example
{
  • "iban": "string",
  • "account_type": "cash_account",
  • "currency": "CAD",
  • "custom_name": "string",
  • "account_owner": [
    ],
  • "account_number_prefixes": [
    ],
  • "contractual_partner_code": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

update an account

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
custom_name
string <= 80 characters

a custom name for the account as set by an account owner

account_number_prefixes
Array of strings non-empty [ items = 2 characters ]

all prefixes that should be mapped to this account

Responses

Request samples

Content type
application/json
{
  • "custom_name": "string",
  • "account_number_prefixes": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

close an account

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

notify backend, that account closing was initiated

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

initiate an extraordinary interest settlement - during closing of account

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

submit the T&C packages of an account

Authorizations:
mtls_dn
path Parameters
account_number
required
string <= 18 characters ^[0-9]{1,18}$

unique account number

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
Array
tnc_package_name
required
string <= 20 characters

unique package name (case insensitive)

applicable_from
required
string <date-time>

timestamp when the T&C package start to be applicable for the given account number

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

required
Array of objects (account_tnc_packages)

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "account_tnc_packages": [
    ]
}

submit an order execution

Authorizations:
mtls_dn
path Parameters
order_execution_id
required
string <uuid> (UUID)

unique identifier of the order execution

Request Body schema: application/json
internal_order_id
required
string <uuid> (UUID)
block_order_execution_id
string <uuid> (UUID)
client_id
required
string <uuid> (UUID)
on_behalf_client_id
string <uuid> (UUID)
cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$

identifier of the client's cash account

security_depot_number
required
string <= 18 characters ^[0-9]{1,18}$

identifier of the client's security depot

execution_id
string <= 50 characters

ID assigned for the execution at the trading venue. Not filled for fractional/money orders where all of the quantity is filled from fractions account.

execution_type
required
string
Value: "TRADE"

type of the execution

client_order_id
required
string <= 50 characters

client generated order ID

order_id
required
string <= 50 characters

exchange generated order ID

comment
string <= 64 characters

additional comment

isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}

ISIN

short_code
required
string <= 128 characters

e.g. DAI for Daimler or DAI.DU for DAIMLER at Börse Düsseldorf

instrument_name
required
string <= 128 characters

name of the instrument

instrument_type
required
string
Enum: "stocks" "warrants" "bonds" "fonds" "etf_or_etc" "index" "unknown"

the type of the instrument

  • stocks - Stocks
  • warrants - Warrants
  • bonds - Bonds
  • fonds - Fonds
  • etf_or_etc - EtfOrEtc
  • index - Index
  • unknown - Unknown (we do not expect to receive that value from external)
order_type
required
string
Enum: "MARKET" "LIMIT" "STOP" "STOP_LIMIT"

type of the order

order_sub_type
required
string
Enum: "REGULAR" "FRACTIONAL" "MONEY_ORDER"

sub-type of the order

side
required
string
Enum: "BUY" "SELL"

buy-sell-indicator

transaction_datetime
required
string <date-time>

transaction date and time

regulatory_trade_id
string <= 52 characters

the TVTIC

order_quantity
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Quantity of the original order. Has 6 decimal points. Only applicable in case of order_sub_type in (REGULAR, FRACTIONAL)

order_amount
string(-)?[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)

Amount of the original order. Has 2 decimal points. Only applicable in case of order_sub_type = MONEY

executed_quantity
required
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Executed quantity that shall be booked in to security deposit. Has 6 decimal points.

price_amount
required
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Price. Has 6 decimal points.

price_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

total_fee_amount
required
string[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)

Total fee amount. Has 2 decimal points.

total_fee_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

Array of objects (order_fee_amount)

details on all fees

exchange_mic
required
string = 4 characters

the MIC number of the exchange

exchange_routing_type
required
string
Enum: "ALF" "ICF"
settlement_location
string
Enum: "ALF" "CBF" "CBL"

the depository where the securities are held

actual_client_id
string <uuid> (UUID)
actual_security_depot_number
string <= 18 characters ^[0-9]{1,18}$

e.g. the tenant's client security depot number for whom the external client executed an order

actual_cash_account_number
string <= 18 characters ^[0-9]{1,18}$

e.g. the tenant's client cash account number for whom the external client executed an order

settlement_date
string <date>

if known, the expected settlement date

Responses

Request samples

Content type
application/json
{
  • "internal_order_id": "336150de-9500-4083-b061-890fa30a4eee",
  • "block_order_execution_id": "31855862-6cd5-4096-a6c8-72d90ac2391f",
  • "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  • "on_behalf_client_id": "52901018-c38e-4cea-8f41-b225b5fdaa98",
  • "cash_account_number": "string",
  • "security_depot_number": "string",
  • "execution_id": "string",
  • "execution_type": "TRADE",
  • "client_order_id": "string",
  • "order_id": "string",
  • "comment": "string",
  • "isin": "string",
  • "short_code": "string",
  • "instrument_name": "string",
  • "instrument_type": "stocks",
  • "order_type": "MARKET",
  • "order_sub_type": "REGULAR",
  • "side": "BUY",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "regulatory_trade_id": "string",
  • "order_quantity": "string",
  • "order_amount": "string",
  • "executed_quantity": "string",
  • "price_amount": "string",
  • "price_currency": "CAD",
  • "total_fee_amount": "string",
  • "total_fee_currency": "CAD",
  • "fee_details": [
    ],
  • "exchange_mic": "stri",
  • "exchange_routing_type": "ALF",
  • "settlement_location": "ALF",
  • "actual_client_id": "f547ee19-6543-47e4-8352-63d8a6a0fa24",
  • "actual_security_depot_number": "string",
  • "actual_cash_account_number": "string",
  • "settlement_date": "2019-08-24"
}

For a fractional, money, or block order submit PEA nominal and amount and if applicable order executed at market

Authorizations:
mtls_dn
path Parameters
block_order_execution_id
required
string <uuid> (UUID)

unique identifier of the order execution

Request Body schema: application/json
internal_order_id
required
string <uuid> (UUID)
pea_cash_number
required
string <= 18 characters ^[0-9]{1,18}$

PEA for cash (Spitzenausgleichskonto)

pea_securities_number
required
string <= 18 characters ^[0-9]{1,18}$

PEA for securities (Spitzenausgleichsdepot)

isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}

ISIN

pea_cash_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

pea_cash_amount
required
string(-)?[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)

Amount at PEA cash. Has 2 decimal points, can also be a negative value.

pea_securities_amount
required
string(-)?[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Quantitiy at PEA security. Has 6 decimal points, can also be a negative value.

transaction_datetime
required
string <date-time>

transaction date and time

object (execution_at_market)
exchange_routing_type
required
string
Enum: "ALF" "ICF"
settlement_location
required
string
Enum: "ALF" "CBF" "CBL"

the depository where the securities are held

Responses

Request samples

Content type
application/json
{
  • "internal_order_id": "336150de-9500-4083-b061-890fa30a4eee",
  • "pea_cash_number": "string",
  • "pea_securities_number": "string",
  • "isin": "string",
  • "pea_cash_currency": "CAD",
  • "pea_cash_amount": "string",
  • "pea_securities_amount": "string",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "execution_at_market": {
    },
  • "exchange_routing_type": "ALF",
  • "settlement_location": "ALF"
}

submit a credit transfer or direct debit

Authorizations:
mtls_dn
path Parameters
cash_transfer_id
required
string <uuid> (UUID)

unique identifier of the cash transfer

Request Body schema: application/json
ultimate_account_number
string <= 18 characters

account number of the ultimate creditor/debitor account, e.g. a customer account

ultimate_iban
string (iban) <= 34 characters [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
iban
required
string (iban) <= 34 characters [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
sort_code
string <= 12 characters

sort code of the account's bank

counter_iban
required
string (iban) <= 34 characters [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
counter_bank_bic
required
string <= 11 characters
in_out
required
string
Enum: "I" "O"
payment_method
required
string
Enum: "CT" "DD"

(SEPA) Credit Transfer or (SEPA) Direct Debit

reversal_indicator
string
Enum: "REFUND" "REJECT" "REVERSAL"
transaction_datetime
required
string <date-time>
currency
required
string
Value: "EUR"
amount
required
string[0-9]{1,12}(\.[0-9]{1,2})?
format: numeric(14,2)
remittance_text
string <= 140 characters
end_to_end_id
string <= 35 characters
customer_reference
string <= 35 characters
bank_reference
string <= 35 characters

Responses

Request samples

Content type
application/json
{
  • "ultimate_account_number": "string",
  • "ultimate_iban": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "counter_iban": "string",
  • "counter_bank_bic": "string",
  • "in_out": "I",
  • "payment_method": "CT",
  • "reversal_indicator": "REFUND",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "currency": "EUR",
  • "amount": "string",
  • "remittance_text": "string",
  • "end_to_end_id": "string",
  • "customer_reference": "string",
  • "bank_reference": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

submit a reversal of a transaction

Authorizations:
mtls_dn
Request Body schema: application/json
original_ta_id
required
integer <int64>
original_transaction_id
required
integer <int64>
reason
string <= 140 characters

Responses

Request samples

Content type
application/json
{
  • "original_ta_id": 0,
  • "original_transaction_id": 0,
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

submit a fee to be charged

Authorizations:
mtls_dn
path Parameters
fee_id
required
string <uuid> (UUID)

unique identifier of the fee

Request Body schema: application/json
cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$

Account number of the customer's cash account

security_account_number
string <= 18 characters ^[0-9]{1,18}$

Account number of the customers's securities account

total_fee_amount
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

total_fee_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

remittance_text
required
string <= 140 characters

Remittance information

value_date
string <date>

Value date

required
Array of objects (fee_amount) non-empty

The fee amount or a breakdown into multiple fee amounts

Responses

Request samples

Content type
application/json
{
  • "cash_account_number": "string",
  • "security_account_number": "string",
  • "total_fee_amount": "string",
  • "total_fee_currency": "CAD",
  • "remittance_text": "string",
  • "value_date": "2019-08-24",
  • "fee_amounts": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

add or update security master data

Authorizations:
mtls_dn
Request Body schema: application/json
required
Array
isin_code
required
string
ag
required
string
Value: "G"
bid
required
string
last_modification
required
string <date-time>
object

ordinary datValues

  • key: field ident
  • value: value
object

ordinary txtValues

  • key: field ident
  • value: lang/dest/value
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

submit end of day prices

Authorizations:
mtls_dn
Request Body schema: application/json
date
required
string <date>

date for the price is defined

provider
required
string
Enum: "ALF" "ICF"

The source of the price

required
object

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "provider": "ALF",
  • "prices_by_currency": {
    }
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

trigger KISTAM Anlassanfrage on client request

Authorizations:
mtls_dn
path Parameters
client_id
required
string <uuid> (UUID)

unique ID of a client

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

upload files

Authorizations:
mtls_dn
path Parameters
filename
required
string^[A-Za-z0-9-._]+[.][A-Za-z-_]*?$

unique filename

directory
required
string^[A-Za-z0-9-_]*?$

directory where file is stored

subdirectory
required
string^[A-Za-z0-9-_]*?$

subdirectory where file is stored

query Parameters
redirect
boolean

interim solution to prepare upstream for s3 redirect, till we have that... we redirect to same endpoint

Request Body schema: */*
string <binary>

Responses

Response Schema: application/json
file_transfer_id
required
integer <int64>

Response samples

Content type
application/json
{
  • "file_transfer_id": 0
}

submit a trade capture report sno message

Authorizations:
mtls_dn
Request Body schema: application/json
text
string or null <= 2048 characters
tradeReportId
required
string [ 1 .. 16 ] characters

571 TradeReportID (Unique identifier delivered by XONTRO)

previouslyReported
boolean
tradeDate
string or null <date>
isinCode
required
string [ 1 .. 12 ] characters
transactTime
string or null <date-time>
lastMarket
string or null <= 64 characters
lastQty
string or null(-)?[0-9]{1,10}(\.[0-9]{1,3})?
format: numeric(13,3)

32 LastQty Float(13,3)

lastPrice
string or null(-)?[0-9]{1,6}(\.[0-9]{1,4})?
format: numeric(10,4)

31 LastPx Float(10,4)

settlementDate
string or null <date>
locationId
string or null <= 4 characters
tradeReportTransType
integer or null <int32>
tradeInputSource
string or null <= 4 characters
tradeLinkId
string or null <= 16 characters
trdType
integer or null <int32>
trdSubType
integer or null <int32>
tradeReportType
integer or null <int32>
trdMatchId
string or null <= 16 characters
origTradeDate
string <date>
origTradeId
string or null <= 16 characters
tradeType2
integer or null <int32>
lastTrader
integer or null <int32>
mktXPriceDiff
string or null(-)?[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)

5665 MKTXPriceDiff Float(15,2)

concessionAmt
string or null(-)?[0-9]{1,7}(\.[0-9]{1,2})?
format: numeric(9,2)

6034 ConcessionAmount Float(9,2)

clientIndicator
string or null <= 1 characters
dealerNote
string or null <= 350 characters
volumeIndicator
integer or null <int32>
otcInd
integer or null <int32>
nextMsgFlag
required
boolean
regFeeFlag
string or null <= 1 characters
discountRate
string or null(-)?[0-9]{1,2}(\.[0-9]{1,7})?
format: numeric(9,7)

9893 DiscountRate Float(9,7)

noTrdRegTimestamps
integer or null <int32>
Array of objects or null (FIXComponentTrdRegTimestamps)
noRegulatoryTradeID
integer or null <int32>
Array of objects or null (FIXComponentRegulatoryTradeIDGrp)
snoRealtimeSideGrpNoSides
integer or null <int32>
Array of objects or null (FIXComponentSnoRealtimeSideGrpSide)

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "tradeReportId": "string",
  • "previouslyReported": true,
  • "tradeDate": "2019-08-24",
  • "isinCode": "string",
  • "transactTime": "2019-08-24T14:15:22Z",
  • "lastMarket": "string",
  • "lastQty": "string",
  • "lastPrice": "string",
  • "settlementDate": "2019-08-24",
  • "locationId": "stri",
  • "tradeReportTransType": 0,
  • "tradeInputSource": "stri",
  • "tradeLinkId": "string",
  • "trdType": 0,
  • "trdSubType": 0,
  • "tradeReportType": 0,
  • "trdMatchId": "string",
  • "origTradeDate": "2019-08-24",
  • "origTradeId": "string",
  • "tradeType2": 0,
  • "lastTrader": 0,
  • "mktXPriceDiff": "string",
  • "concessionAmt": "string",
  • "clientIndicator": "s",
  • "dealerNote": "string",
  • "volumeIndicator": 0,
  • "otcInd": 0,
  • "nextMsgFlag": true,
  • "regFeeFlag": "s",
  • "discountRate": "string",
  • "noTrdRegTimestamps": 0,
  • "trdRegTimestamps": [
    ],
  • "noRegulatoryTradeID": 0,
  • "regulatoryTradeIDGrp": [
    ],
  • "snoRealtimeSideGrpNoSides": 0,
  • "snoRealtimeSideGrp": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

submit a ca order execution

Authorizations:
mtls_dn
path Parameters
ca_order_execution_uuid
required
string <uuid> (UUID)

unique identifier of the ca order execution

Request Body schema: application/json
cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$

identifier of the client's cash account

security_depot_number
required
string <= 18 characters ^[0-9]{1,18}$

identifier of the client's security depot

ca_job_id
required
integer <int64>

ca job identifier

transaction_datetime
required
string <date-time>

transaction date and time

isin_weisung
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}

ISIN of the ordered security

quantity_weisung
required
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Quantity of the ordered isin. Has 6 decimal digits.

value_date
string <date>

value date

block_ca_order_execution_id
string <uuid> (UUID)
isin_bezogener_titel
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}

ISIN of the received security

quantity_bezogener_titel
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)

Quantity of the received isin. Has 6 decimal digits.

settlement_location
string
Enum: "ALF" "CBF" "CBL"

the depository where the securities are held

price_amount
string[0-9]{1,10}(\.[0-9]{1,15})?
format: numeric(25,15)

Price. Has up to 15 decimal points.

price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

fx_rate
string[0-9]{1,10}(\.[0-9]{1,15})?
format: numeric(25,15)

FXRate. Has up to 15 decimal points.

Array of objects (order_fee_amount)

details on all fees

Responses

Request samples

Content type
application/json
{
  • "cash_account_number": "string",
  • "security_depot_number": "string",
  • "ca_job_id": 0,
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "isin_weisung": "string",
  • "quantity_weisung": "string",
  • "value_date": "2019-08-24",
  • "block_ca_order_execution_id": "b7068619-3fda-459a-9a76-1d6ef0bacfa7",
  • "isin_bezogener_titel": "string",
  • "quantity_bezogener_titel": "string",
  • "settlement_location": "ALF",
  • "price_amount": "string",
  • "price_currency": "CAD",
  • "fx_rate": "string",
  • "fee_details": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create or update a T&C package

Authorizations:
mtls_dn
header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
name
required
string <= 20 characters

unique package name (case insensitive)

description
required
string <= 80 characters

short description of the T&C package

applicable_from
required
string <date-time>

timestamp when the T&Cs start to be applicable

non_applicable_from
string <date-time>

timestamp when the T&Cs are not applicable anymore

priority
required
integer <int32>
term
required
string
Enum: "D" "W" "M" "Q" "S" "Y" "I"
  • Day
  • Week
  • Month
  • Quarter
  • Semester
  • Year
  • Indefinite
Array of objects (tnc_package_price)
Array of objects (tnc_package_fee_item)
Array of objects (tnc_package_interest_rate_item)

Responses

Response Schema: application/json
as_of_datetime
required
string <date-time>

timestamp of data acquisition

required
Array of objects (tnc_package_list)

Request samples

Content type
application/json
{
  • "name": "Default Package",
  • "description": "string",
  • "applicable_from": "2019-08-24T14:15:22Z",
  • "non_applicable_from": "2019-08-24T14:15:22Z",
  • "priority": 1,
  • "term": "I",
  • "prices": [
    ],
  • "fee_items": [
    ],
  • "interest_rate_items": [
    ]
}

Response samples

Content type
application/json
{
  • "as_of_datetime": "2019-08-24T14:15:22Z",
  • "tnc_package": [
    ]
}

submit the T&C packages of an account

Authorizations:
mtls_dn
header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
client_id_1
required
integer
client_id_2
integer
loss_pot
required
string
Enum: "S" "B" "A"
year
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "client_id_1": 0,
  • "client_id_2": 0,
  • "loss_pot": "S",
  • "year": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create an outgoing deposit transfer notification.

Should be invoked once custodian is informed about the transfer

Authorizations:
mtls_dn
path Parameters
swift_reference_number
required
string = 16 characters

unique swift reference number identifying the deposit transfer position

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
deposit_account_number
required
string <= 18 characters ^[0-9]{1,18}$

deposit account number at origin bank

transfer_type
required
string
Enum: "E" "U"

type of transfer. E for paid transfers (entgeltlich), U for free transfers (unentgeltlich)

subrogation_indicator
required
boolean

change of ownership indicator. Set to true if beneficiary is not the same person or legal entity.

transfer_specific_type
string
Enum: "S" "E"

Specific type of the transfer (Besonderheiten Übertrag). S for donations (Schenkung), E for inheritance (Erbschaft). Only applicable when change of ownership is true

required
object (ext_outgoing_deposit_transfer_instrument)

information of the individual financial instrument to be transferred

required
object (ext_outgoing_deposit_transfer_target_bank)

target deposit taking bank information for outgoing deposit transfer

required
object (ext_outgoing_deposit_transfer_beneficiary)

target beneficiary information for the outgoing deposit transfer

Responses

Request samples

Content type
application/json
{
  • "deposit_account_number": "string",
  • "transfer_type": "E",
  • "subrogation_indicator": true,
  • "transfer_specific_type": "S",
  • "instrument": {
    },
  • "target_bank": {
    },
  • "target_beneficiary": {
    }
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

mark an existing outgoing deposit transfer notification as settled or declined.

Should be invoked once an existing transfer instruction is settled or declined at the custodian. If settled upstream will expect the necessary bookings and balances from Angela as the final step to complete the process

Authorizations:
mtls_dn
path Parameters
swift_reference_number
required
string = 16 characters

unique swift reference number identifying the deposit transfer position to change status

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
status
required
string
Enum: "settled" "rejected"

the requested action for the transfer settled to complete processing or rejection to invalidate the transfer

settlement_date
string <date>

expected settlement date

note
string <= 128 characters

free format text data to hold details of this status update

Responses

Request samples

Content type
application/json
{
  • "status": "settled",
  • "settlement_date": "2019-08-24",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

submit residual balance cash amount for a existing corporate action

Should be invoked the residual balance of a corporate action has been sold, to trigger distribution towards customer cash accounts

Authorizations:
mtls_dn
header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
ca_job_id
required
integer <int64>

unique job_id

value_date
required
string <date>

value_date of underlying order execution

amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

Responses

Request samples

Content type
application/json
{
  • "ca_job_id": 123,
  • "value_date": "2019-08-24",
  • "amount": "5877.78",
  • "currency": "CAD"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create jahressteuerbescheinigung

create new gl jahressteuerbescheinigung

Authorizations:
mtls_dn
query Parameters
client_id
required
string <uuid> (UUID)

client identifer key

header Parameters
x-ext-request_id
required
string <uuid> (UUID)

idempotency key

Request Body schema: application/json
muster
required
integer [ 1 .. 1 ]
einzelsteuerbescheinigung
boolean
Default: false
jahr
integer

Responses

Request samples

Content type
application/json
{
  • "muster": 1,
  • "einzelsteuerbescheinigung": false,
  • "jahr": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Localisation

Frontend localization strings and translations

get or list active translations

Authorizations:
oidc_headerbasicAuth
path Parameters
application
required
string (localisation_application)
Enum: "camilla" "angela"
query Parameters
file_or_path
string^(([a-zA-Z0-9\-\_]+(\.?[a-zA-Z0-9\-\_])*\/?)*...

swaggerui cannot handle empty strings... so just pass in if trying out

Responses

Response Schema: application/json
One of
One of
commit_hash
required
string <= 40 characters
payload
required
object

the keys and their translated values

mimetype
required
string
Value: "application/json"

Response samples

Content type
application/json
Example
{
  • "commit_hash": "string",
  • "payload": { },
  • "mimetype": "application/json"
}

edit values of existing keys or add new keys

Authorizations:
oidc_headerbasicAuth
path Parameters
application
required
string (localisation_application)
Enum: "camilla" "angela"
query Parameters
file_or_path
required
string^(([a-zA-Z0-9\-\_]+(\.?[a-zA-Z0-9\-\_])*\/?)*...

swaggerui cannot handle empty strings... so just pass in if trying out

Request Body schema: application/json
One of
commit_hash
required
string <= 40 characters
payload
required
object

the keys and their translated values

mimetype
required
string
Value: "application/json"
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "commit_hash": "string",
  • "payload": "string",
  • "mimetype": "image/svg",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

translation versions with their activations

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
commit_hash
required
string

the commit hash of the version

commit_email_address
required
string

the email address of the committer

commit_summary
required
string

the committers summary

commit_datetime
required
string <date-time>

date and time of the commit

activation_email_address
string

activating persons email address

activation_datetime
string <date-time>

date and time of activation

active
boolean

Response samples

Content type
application/json
[
  • {
    }
]

activate a version

Authorizations:
oidc_headerbasicAuth
query Parameters
commit_hash
required
string

the commit_hash to activate

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Monitoring

Operational monitoring and system health endpoints

monitoring of file transfers

list information on file transfer and generating

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>

filter by upload date

date_to
required
string <date>

filter by upload date

in_out
string
Default: "I"
Enum: "I" "O"
directory
string
hide_skipped
boolean
file_transfer_pattern
string

Responses

Response Schema: application/json
Array
filename
required
string
file_uri
string
uploaded_by
required
string <= 161 characters

first and last name of the person that uploaded the file

uploaded_at
required
string <date-time>

date and time of file upload

handled_at
string <date-time>

date and time of file import

error_at
string <date-time>

timestamp of last import error

error
string <= 255 characters

last import error

state
string

indicates that a transfer was excluded from processing

file_size
string

prettyprinted size of the uploaded file

Response samples

Content type
application/json
[
  • {
    }
]

upload files

Authorizations:
oidc_headerbasicAuth
path Parameters
filename
required
string^[A-Za-z0-9-._]+[.][A-Za-z-_]*?$

unique filename

type
required
string

directory where file is stored

date
required
string <date>

subdirectory where file is stored

Request Body schema: multipart/form-data
file
required
string <binary>

a document for verifying persondata

Responses

Response Schema: application/json
file_transfer_id
required
integer <int64>

Response samples

Content type
application/json
{
  • "file_transfer_id": 0
}

get specific file from file transfer

a file

Authorizations:
oidc_headerbasicAuth
path Parameters
file_transfer_id
required
integer

id of requested file

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Overview of async processes

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>

filter by start_date

date_to
required
string <date>

filter by end_date

only_failed
boolean

Responses

Response Schema: application/json
Array
job_queue_process_id
required
integer
job_queue_process_memo
string
description
required
string
datetime_finished
string <date-time>
success
boolean
to_handle
integer
error_count
integer
Array of objects (async_task)

Response samples

Content type
application/json
[
  • {
    }
]

retrigger of async task

Authorizations:
oidc_headerbasicAuth
path Parameters
job_queue_task_id
required
integer
query Parameters
reason
required
string

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Overview of sent mails

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>

filter by start_date

date_to
required
string <date>

filter by end_date

email_address
string

Responses

Response Schema: application/json
Array
email_id
required
integer
datetime_create
required
string
receiver
required
string
cc
string

email address of the CC recipient

state
string
Enum: "I" "R" "S" "F" "D" "B" "C" "L" "J"

current state of the email

subject
string
datetime_read
string <date-time>

timestamp when the email was read by the recipient

Response samples

Content type
application/json
[
  • {
    }
]

Overview of sent mails

Authorizations:
oidc_headerbasicAuth
query Parameters
email_id
required
integer

filter by start_date

Responses

Response Schema: application/json
Array
datetime_create
required
string <date-time>

timestamp when the email state was created

action
required
string
Enum: "I" "R" "S" "F" "D" "B" "C" "L" "J"
error_message
string
attempt
integer
smtp_status
string
remote_mta_ip
string

Response samples

Content type
application/json
[
  • {
    }
]

Overview of sent mails

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>

filter by start_date

date_to
required
string <date>

filter by end_date

transfer_state
string
Enum: "A" "P" "D" "F"

Responses

Response Headers
x-result-total
integer

the (actual) total of postings to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
t_id
required
string
datetime_create
required
string <date-time>
datetime_next_try
string <date-time>
datetime_transfer
string <date-time>
transfer_state
string <= 1 characters
Enum: "P" "D" "F"
string or string (transaction_source)

Name of the booking source

Response samples

Content type
application/json
[
  • {
    }
]

Overview of sent mails

Authorizations:
oidc_headerbasicAuth
path Parameters
t_id
required
string

transaction identfier

Responses

Response Schema: application/json
Array
datetime_create
required
string <date-time>
http_status
integer
transfer_state
required
string <= 1 characters
Enum: "P" "D" "F"
response
string

Response samples

Content type
application/json
[
  • {
    }
]

GABI overview

overview of the latest system processes and their status

Authorizations:
oidc_headerbasicAuth
query Parameters
monitoring_group
required
string
Default: "F"
Enum: "F" "T" "A"

Responses

Response Schema:
One of
datetime_request
string <date-time>

timestamp the (already created) data is fetched

person_request
string <= 161 characters

person that fetches the (already created) data

language
string

language of the requesting person

timezone
string

timezone of the requesting person

monitoring_group
string
Enum: "F" "T" "A"
datetime_create
string <date-time>

timestamp the data was created

person_create
string <= 161 characters

person that created the data

Array of objects

Response samples

Content type
Example
{
  • "datetime_request": "2019-08-24T14:15:22Z",
  • "person_request": "string",
  • "language": "string",
  • "timezone": "string",
  • "monitoring_group": "F",
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "person_create": "string",
  • "overview": [
    ]
}

GABI overview

generate new overview of the latest system processes and their status

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
datetime_request
string <date-time>

timestamp the (already created) data is fetched

person_request
string <= 161 characters

person that fetches the (already created) data

language
string

language of the requesting person

timezone
string

timezone of the requesting person

monitoring_group
string
Enum: "F" "T" "A"
datetime_create
string <date-time>

timestamp the data was created

person_create
string <= 161 characters

person that created the data

Array of objects

Response samples

Content type
application/json
{
  • "datetime_request": "2019-08-24T14:15:22Z",
  • "person_request": "string",
  • "language": "string",
  • "timezone": "string",
  • "monitoring_group": "F",
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "person_create": "string",
  • "overview": [
    ]
}

Notification

Notification settings and message delivery configuration

add a subscription

Authorizations:
oidc_headerbasicAuth
path Parameters
ws_notification_event_id
required
integer

events id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete a subscription

Authorizations:
oidc_headerbasicAuth
path Parameters
ws_notification_event_id
required
integer

events id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

add a subscription

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
action
string
Default: "R"

Responses

Request samples

Content type
application/json
{
  • "action": "R"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

get all messages for a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
message
required
object
websocket_message_id
required
integer
datetime_read
string <date-time>
datetime_sent
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

get all messages for a person

Authorizations:
oidc_headerbasicAuth
path Parameters
websocket_message_id
required
integer

messages id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

WebSocket connect

Connect interface for AWS APIGate WebSocket

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

WebSocket ping

Message interface, just for pinging

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

WebSocket disconnect

Disconnect interface for AWS APIGate WebSocket

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

OIDC

OIDC authentication and sign-up flows

Authorize a user

This endpoint is the start and the end of the users login process. Initially it will be redirected by the load balancer to the actual login interface and finally it presents a token to the application that can be used for a "Remember me" function

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
required
object

Person data

operation_ids
required
Array of strings (operation_id)
Items Enum: "account_account_number_activity_get" "account_account_number_balance_get" "account_account_number_detail_get" "account_account_number_fees_get" "account_account_number_limit_delete" "account_account_number_limit_put" "account_account_number_state_put" "account_interest_rate_get" "account_persons_get" "account_search" … 368 more

A list of interfaces the user may use

customer_care
required
string

Unique ID of the first token used to start the login process. This token stays stable as long as the session does not time out by time or inactivity.

inactivity_timeout
integer

Maximum time in seconds between two api interactions, a client request is garanteed to not trigger an inactivity timeout. The inactivity_timeout is a bit higher as it is acutally starts at the last API interaction that caused a request of a refresh token (which the client does not notice) and there is a grace time to cope with client clock skew. So it is up to the client to count down a local timer.

amzn_oidc_data
object

Some debugging information

Response samples

Content type
application/json
{
  • "person": {
    },
  • "operation_ids": [
    ],
  • "customer_care": "string",
  • "inactivity_timeout": 0,
  • "amzn_oidc_data": { }
}

Deliver login data to the client application

Inform the client application about possible ways to login

query Parameters
response_type
required
string
Enum: "code" "id_token" "token"

The OAuth 2.0 response type. For clients using the OAuth code flow it should be set to code. For clients using the implicit flow it should be set to id_token or token id_token

scope
required
Array of strings
Items Enum: "openid" "profile"

Array of the requested scope values. Must include at least the openid value, delimited by space. Please note that the typescript generator does not honor style: spaceDelimited, therefore we omit it from this spec but still have the values separated by space!

client_id
required
string

The OAuth 2.0 client identifier, obtained at registration.

redirect_uri
required
string <uri>

The redirection URI to which the response will be sent. It must exactly match one of the registered redirection URIs for the client.

state
required
string

Opaque value, e.g. a random string, used to maintain state between the request and the callback. Use of this parameter is not required but highly recommended.

Responses

Response Schema: application/json
connection
required
Array of strings (auth_connection)
Items Enum: "login_user_password" "login_phone" "login_token" "signup" "signup_address" "signup_email" "signup_phone" "signup_userdata" "reset_password" "verify" … 5 more

The means of authentication the client may use. The order of the items returned indicates the priority these authentications means should be used:

  • 'Username-Password-Authentication' - the usual username/password dialog
idp_state
required
string <byte>

IdP state

exp
required
integer

The timestamp in UTC time until when this login session will be valid. Trying to login after that timestamp will fail. So a countdown might be helpful to the user.

Response samples

Content type
application/json
{
  • "connection": [
    ],
  • "idp_state": "string",
  • "exp": 0
}

Upload users login ID

Shall be used to submit the users login ID to the IdP.

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

userId
required
string <email>

the username

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "userId": "anna@domain.tld"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Upload users login password

Shall be used to submit the users login password.

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

password
required
string

the password

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "password": "abcd"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Upload users login data

Shall be used to submit the users login data to the IdP.

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

token
required
string

the session transfer token

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "token": "xxaaxaxax"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Log out

Log out the user currently logged in

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Log out

Log out the user currently logged in

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Endpoint to terminate OIDC redirect on expired or no tokens

The AWS ALB has the option to deny requests if they have no authorization cookie. But unfortunately if there is a cookie and just the refresh does not work (e.g. expired session) then the ALB will forward the request via 302 to the configured login endpoint. To get around this, instead of denying these requests at the ALB (--> 401) we forward them to our IdP and deny them there.

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Request a password reset token

Send a password reset token to the given email address, this email address will receive a link. Using this link one can set a new password.

Request Body schema: application/json
required

Email address to receive the link

idp_state
required
string <byte>

IdP state

email_address
required
string <email> <= 255 characters

The email address for receiving the verification code

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "email_address": "anna@domain.tld"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Upload verification code

After a user requested a password reset, this endpoint is used to upload the verification code and set the new password

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

username
required
string <email>

The user name

verification_code
required
string <= 36 characters

Verification code

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "username": "anna@domain.tld",
  • "verification_code": "ABCD123"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Set a new password after beeing requested by the IdP

The application is expected to ask the user for their password, double check it and submit it via this interface.

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

password
required
string <password>

the password

current_password
string <password>

the password

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "password": "my secret password",
  • "current_password": "my secret password"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Get submitted sign-up data

Possibility for the customer to check the submitted data

query Parameters
idp_state
required
string <byte> (idp_state)

IdP state to identify the user

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Person sign-up

Create a person_creation request, at least

  • email_address
  • phone_number
  • or userdata: given_name name must be present
  • or the address
Request Body schema: application/json
required

Sing-up data to add

idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

gender
string
Enum: "M" "F" "X"

Gender of the person

given_name
string <= 80 characters

The person's given name

name
string <= 80 characters

The person's name

email_address
string <email> <= 255 characters

The person's email address

object

The person's phone number

object

The person's address

language
string
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

The person's language setting

birth_date
string <date>

The person's birth date

birth_city
string <= 80 characters

City or municipality where the person was born

client_type
string
Enum: "B" "R"

Client type

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "gender": "M",
  • "given_name": "user",
  • "name": "example",
  • "email_address": "anna@domain.tld",
  • "phone": {
    },
  • "address": {
    },
  • "language": "en",
  • "birth_date": "1970-12-24",
  • "birth_city": "string",
  • "client_type": "B"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Add user data during sign-up

After submitting initial sign-up the user may be asked

  • to submit his personal data (connection:= signup_address)
Request Body schema: application/json
required

Address to add

idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

address_type
string (address_type)
Default: "L"
Enum: "L" "D"

Address_Type:

  • 'L' - Living Address
  • 'D' - Delivery Address
street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "address_type": "L",
  • "street": "string",
  • "building_identifier": "string",
  • "suite_identifier": "string",
  • "floor_identifier": "string",
  • "district_name": "string",
  • "post_box": "string",
  • "post_code": "string",
  • "city": "string",
  • "country_subentity": "string",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Cancel verification of phone number

If the users adds a phone number, they either need to verify it, add another one, or remove it.

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Add email address during sign-up

After submitting initial sign-up the user may be asked

  • to submit an email address (connection:= signup_email)
Request Body schema: application/json
required

Email address to add

idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

email_address
string <email> <= 255 characters

The email address

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "email_address": "anna@domain.tld"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Add phone number during signup

After submitting initial signup the user may be asked

  • to either verify their email address (connection:= verify) or
  • to submit a phone number (connection:= signup_phone) This number will receive a verification code via SMS. The application is supposed to submit this verification code to /oauth/verify_phone
Request Body schema: application/json
required

The phone number to add

idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

phone_number
required
string <= 30 characters

Phone number

default_region
string
Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" … 235 more

Region code

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "phone_number": "+(49) 178-123456789",
  • "default_region": "DE"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Add user data during sign-up

After submitting initial sign-up the user may be asked

  • to submit his personal data (connection:= signup_userdata)
Request Body schema: application/json
required

User data to add

idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

gender
string
Enum: "M" "F" "X"

The person's gender

given_name
required
string <= 80 characters

The person's given name

name
required
string <= 80 characters

The person's name

birth_date
string <date>

The person's birth date

birth_city
string <= 80 characters

City or municipality where the person was born

client_type
required
string
Enum: "B" "R"

Client type

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "gender": "M",
  • "given_name": "user",
  • "name": "example",
  • "birth_date": "2000-01-01",
  • "birth_city": "string",
  • "client_type": "B"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Upload users verification code

After a user signed up via /oauth/signup, this interface is used to upload the verification code and set the initial password

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

username
required
string <email>

The user name

verification_code
required
string <= 36 characters

Verification code

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "username": "anna@domain.tld",
  • "verification_code": "ABCD123"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

Upload users verification code

After a user added a phone_number up via /oauth/signup_phone, this interface is used to upload the verification code and continue the verification. This interface is just needed to have partially created users validate their phone number. After regular user validation the usual self-service endpoints can be used

Request Body schema: application/json
idp_state
required
string <byte> (idp_state)

the authentifications state that needs to be uploaded on every login. please note, that it is one time use to prevent replay atacks!

phone_number
required
string <= 30 characters

Phone number

default_region
string
Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" … 235 more

Default region

verification_code
required
string = 6 characters \d{6}

Verification code

Responses

Request samples

Content type
application/json
{
  • "idp_state": "string",
  • "phone_number": "+(49) 174-123456789",
  • "default_region": "DE",
  • "verification_code": "123456"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string",
  • "authParams": {
    }
}

OIDC server-side

Server-side OIDC flows and integrations

Get OpenID provider configuration information

Discovery endpoint used by OpenID Connect relying party to discover the end-user's OpenID provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.

Responses

Response Schema: application/json
issuer
required
string

REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier

authorization_endpoint
required
string

REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint

token_endpoint
string

URL of the OP's OAuth 2.0 Token Endpoint

userinfo_endpoint
string

RECOMMENDED. URL of the OP's UserInfo Endpoint

jwks_uri
required
string

REQUIRED. URL of the OP's JSON Web Key Set [JWK] document.

registration_endpoint
string

RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint

scopes_supported
Array of strings
Items Enum: "openid" "profile" "email" "address" "phone" "offline_access"

RECOMMENDED. JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports

response_types_supported
required
Array of strings
Items Enum: "code" "token" "id_token" "id_token_token" "code_id_token" "code_id_token_token"

REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports

response_modes_supported
Array of strings
Items Enum: "query" "fragment" "form_post"

OPTIONAL. JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports

grant_types_supported
Array of strings
Items Enum: "implicit" "authorization_code" "refresh_token" "password" "client_credentials" "urn:ietf:params:oauth:grant-type:jwt-bearer"

OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports

acr_values_supported
Array of strings
Items Value: "0"

OPTIONAL. JSON array containing a list of the Authentication Context Class References that this OP supports

subject_types_supported
required
Array of strings
Items Enum: "public" "pairwise"

REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports

id_token_signing_alg_values_supported
required
Array of strings
Items Enum: "RS256" "RS384" "RS512" "PS256" "PS384" "PS512" "ES256" "ES384" "ES512" "HS256" … 3 more

REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT

id_token_encryption_alg_values_supported
Array of strings
Items Enum: "RSA1_5" "RSA-OAEP" "RSA-OAEP-256" "ECDH-ES" "ECDH-ES+A128KW" "ECDH-ES+A192KW" "ECDH-ES+A256KW" "dir" "A128KW" "A192KW" … 4 more

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT

id_token_encryption_enc_values_supported
Array of strings
Items Enum: "A128CBC-HS256" "A192CBC-HS384" "A256CBC-HS512" "A128GCM" "A192GCM" "A256GCM"

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT

userinfo_signing_alg_values_supported
Array of strings
Items Enum: "RS256" "RS384" "RS512" "PS256" "PS384" "PS512" "ES256" "ES384" "ES512" "HS256" … 2 more

OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT

userinfo_encryption_alg_values_supported
Array of strings
Items Enum: "RSA1_5" "RSA-OAEP" "RSA-OAEP-256" "ECDH-ES" "ECDH-ES+A128KW" "ECDH-ES+A192KW" "ECDH-ES+A256KW" "dir" "A128KW" "A192KW" … 4 more

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT

userinfo_encryption_enc_values_supported
Array of strings
Items Enum: "A128CBC-HS256" "A192CBC-HS384" "A256CBC-HS512" "A128GCM" "A192GCM" "A256GC"

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT

request_object_signing_alg_values_supported
Array of strings
Items Enum: "HS256" "HS384" "HS512" "RS256" "RS384" "RS512" "PS256" "PS384" "PS512" "ES256" … 3 more

OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects

request_object_encryption_alg_values_supported
string

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects

request_object_encryption_enc_values_supported
string

OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects

token_endpoint_auth_methods_supported
Array of strings
Items Enum: "client_secret_post" "client_secret_basic" "client_secret_jwt" "private_key_jwt"

OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint

token_endpoint_auth_signing_alg_values_supported
Array of strings
Items Enum: "RS256" "ES256"

OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT

display_values_supported
Array of strings
Items Enum: "page" "popup" "touch" "wap"

OPTIONAL. JSON array containing a list of the display parameter values that the OpenID Provider supports

claim_types_supported
Array of strings
Items Enum: "normal" "aggregated" "distributed"

OPTIONAL. JSON array containing a list of the Claim Types that the OpenID Provider supports

claims_supported
string

RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for

service_documentation
string

OPTIONAL. URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider

claims_locales_supported
string

OPTIONAL. Languages and scripts supported for values in Claims being returned, represented as a JSON array of BCP47 [RFC5646] language tag values

ui_locales_supported
string

OPTIONAL. Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values

claims_parameter_supported
boolean

OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false

request_parameter_supported
boolean

OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false

request_uri_parameter_supported
boolean

OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true

require_request_uri_registration
boolean

OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter

op_policy_uri
string

OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP

op_tos_uri
boolean

OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service

Response samples

Content type
application/json
{
  • "issuer": "string",
  • "authorization_endpoint": "string",
  • "token_endpoint": "string",
  • "userinfo_endpoint": "string",
  • "jwks_uri": "string",
  • "registration_endpoint": "string",
  • "scopes_supported": [
    ],
  • "response_types_supported": [
    ],
  • "response_modes_supported": [
    ],
  • "grant_types_supported": [
    ],
  • "acr_values_supported": [
    ],
  • "subject_types_supported": [
    ],
  • "id_token_signing_alg_values_supported": [
    ],
  • "id_token_encryption_alg_values_supported": [
    ],
  • "id_token_encryption_enc_values_supported": [
    ],
  • "userinfo_signing_alg_values_supported": [
    ],
  • "userinfo_encryption_alg_values_supported": [
    ],
  • "userinfo_encryption_enc_values_supported": [
    ],
  • "request_object_signing_alg_values_supported": [
    ],
  • "request_object_encryption_alg_values_supported": "string",
  • "request_object_encryption_enc_values_supported": "string",
  • "token_endpoint_auth_methods_supported": [
    ],
  • "token_endpoint_auth_signing_alg_values_supported": [
    ],
  • "display_values_supported": [
    ],
  • "claim_types_supported": [
    ],
  • "claims_supported": "string",
  • "service_documentation": "string",
  • "claims_locales_supported": "string",
  • "ui_locales_supported": "string",
  • "claims_parameter_supported": true,
  • "request_parameter_supported": true,
  • "request_uri_parameter_supported": true,
  • "require_request_uri_registration": true,
  • "op_policy_uri": "string",
  • "op_tos_uri": true
}

Receive new code or refresh token for user

Used by the ALB to exchange the users submitted code or refresh token against a new set of tokens. This endpint allows the ALB to exchange either

  • user access code for an id token, an access token, and a refresh token to call the backend interface for the user or
  • refresh token for an id token, an access token, and a refresh token to call the backend interface for the user
Request Body schema: application/x-www-form-urlencoded
required

The parameters needed for the exchange

grant_type
required
string
Enum: "authorization_code" "refresh_token"

The grant type

client_id
required
string

The OAuth 2.0 client identifier, obtained at registration.

client_secret
required
string <password>

The OAuth 2.0 client password, obtained at registration.

redirect_uri
string <uri>

The redirection URI to which the response will be sent. It must exactly match one of the registered redirection URIs for the client. Required for grant type authorization_code.

code
string

The authorization code issued by the IdP; required for grant type authorization_code.

refresh_token
string

The refresh token; required for grant type refresh_token

Responses

Response Schema: application/json
access_token
required
string

The access token

refresh_token
required
string

The refresh token

id_token
string

The ID token

token_type
required
string
Value: "Bearer"

The token type

expires_in
required
integer

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

Get the users data

Used by the ALB to get the users data

Authorizations:
access_token

Responses

Response Schema: application/json
sub
required
string

Subject - Identifier for the End-User at the Issuer.

email
string

Email address

fjti
string

The JWT ID of the initial OIDC request

Response samples

Content type
application/json
{
  • "sub": "string",
  • "email": "string",
  • "fjti": "string"
}

Get the users data

Used by the alb to get the users data

Authorizations:
access_token

Responses

Response Schema: application/json
sub
required
string

Subject - Identifier for the End-User at the Issuer.

email
string

Email address

fjti
string

The JWT ID of the initial OIDC request

Response samples

Content type
application/json
{
  • "sub": "string",
  • "email": "string",
  • "fjti": "string"
}

Permissions

Roles, permissions, and access control management

Get roles of a back-office user

Returns all roles for a given back-office user

Authorizations:
oidc_headerbasicAuth
query Parameters
person_id
required
integer

ID of the person (a back-office user)

Responses

Response Schema: application/json
Array
role_id
required
integer

ID of the role

name
required
string

Name (EN) for the role

assignable
boolean

TRUE if the role can be assigned or removed from FE

Response samples

Content type
application/json
[
  • {
    }
]

Add a role to a back-office user

Assigns a role to a back-office user (in addition)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

the Parameters needed for the exchange

role_id
required
integer
Enum: 2 3 4 6 8 9 10 11

ID of the role to be added

person_id
required
integer

ID of a person (a back-office user)

Responses

Request samples

Content type
application/json
{
  • "role_id": 2,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Remove a role from a back-office user

Remove a (single) role from a back-office user

Authorizations:
oidc_headerbasicAuth
query Parameters
person_id
required
integer

ID of the person (a back-office user)

role_id
required
integer (editable_role_id)
Enum: 2 3 4 6 8 9 10 11

ID of the role to be removed

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Get all back-office users

List all back-office users

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
person_id
required
integer

ID of the person

name
required
string

The persons name

given_name
required
string

The persons given name

primary_email_address
required
string <email>

The persons primary email address

email_address_state
string
Enum: "V" "E" "P"
  • 'V'erified
  • 'E'xpired
  • 'P'ending

Response samples

Content type
application/json
[
  • {
    }
]

List roles

List all back-office user roles

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
role_id
required
integer

ID of the role

name
required
string

Name (EN) for the role

assignable
boolean

TRUE if the role can be assigned or removed from FE

Response samples

Content type
application/json
[
  • {
    }
]

Get back-office users with a specific role

List all back-office users that have the given role assigned

Authorizations:
oidc_headerbasicAuth
query Parameters
role_id
required
integer

ID of the role to filter by

Responses

Response Schema: application/json
Array
person_id
required
integer

ID of the person

name
required
string

The persons name

given_name
required
string

The persons given name

primary_email_address
required
string <email>

The persons primary email address

email_address_state
string
Enum: "V" "E" "P"
  • 'V'erified
  • 'E'xpired
  • 'P'ending

Response samples

Content type
application/json
[
  • {
    }
]

Public endpoints

Public endpoints that do not require authentication

public client config

public client config, e.g. mailto receivers for tech support

Responses

Response Schema: application/json
help_mailto_receiver
string
help_mailto_subject
string
help_mailto_body
string
property name*
additional property
any

Response samples

Content type
application/json
{
  • "help_mailto_receiver": "string",
  • "help_mailto_subject": "string",
  • "help_mailto_body": "string"
}

Reconciliation

Reconciliation processes, status, and results

List open postings

All open postings matching the filter criteria

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
required
string <= 18 characters

Filter by (cash or securities) account number

date_from
required
string <date>

Start date

date_to
required
string <date>

End date

balance_type
required
string
Enum: "B" "V" "T"

Balance type:

  • B - booking date
  • V - value date
  • T - transaction date
add_closed_postings
required
boolean
Default: false

If TRUE then also display closed postings

cash_security
string
Enum: "C" "S"

Filter postings by C/S indicator:

  • C - cash
  • S - securities
ta_id
integer <int64>

Filter postings by TA ID

transaction_id
integer <int64>

Filter postings by transaction ID

posting_id
integer <int64>

Filter postings by posting ID

subbalance
string

Filter postings by sub-balance (choose from GET /configuration/subbalances)

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
Example: isin=DE0007100000

Filter security postings by ISIN

txkey_id
integer

Filter postings by TX key

price_amount
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
Example: price_amount=5877.78
format: numeric(25,15)
minimum: 0.00

Filter security postings by price

abs_orig_cash_amount_value
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: abs_orig_cash_amount_value=5877.78
format: numeric(15,2)
minimum: 0.00

Filter cash postings by absolute original posting amount or security postings by absolute original value

abs_orig_securities_amount
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
Example: abs_orig_securities_amount=5877.78
format: numeric(19,6)
minimum: 0.00

Filter security postings by absolute original posting nominal

abs_cash_op_amount
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: abs_cash_op_amount=5877.78
format: numeric(15,2)
minimum: 0.00

Filter cash postings by still open absolute amount

abs_securities_op_amount
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
Example: abs_securities_op_amount=5877.78
format: numeric(19,6)
minimum: 0.00

Filter security postings by still open absolute nominal

Responses

Response Headers
x-result-total
integer

The (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema:
date_from
required
string <date>

Repetition of the start date filter

date_to
required
string <date>

Repetition of the end date filter

balance_type
required
string
Enum: "B" "V" "T"

Repetition of the balance type filter

cash_security
string
Enum: "C" "S"

Repetition of the C/S filter

ta_id
integer <int64>

Repetition of the TA ID filter

transaction_id
integer <int6>

Repetition of the transaction ID filter

posting_id
integer <int6>

Repetition of the posting ID filter

subbalance
string <= 80 characters

Repetition of the sub-balance filter

isin
string^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$

Repetition of the ISIN filter

txkey_id
integer <int32>

Repetition of the TX key filter

price_currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Repetition of the price currency filter

price_amount
string^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

Repetition of the price filter

cash_currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Repetition of the cash posting currency filter

abs_orig_cash_amount_value
string^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

Repetition of the filter regarding the absolute original posting cash amount

abs_orig_securities_amount
string^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

Repetition of the filter regarding the absolute original posting securities amount

abs_cash_op_amount
string^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

Repetition of the filter regarding the still open cash amount

abs_securities_op_amount
string^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

Repetition of the filter regarding the still open securities amount

add_closed_postings
boolean
Array of objects

All accounts connected via OP portfolio account mapping

Array of objects

Response samples

Content type
{
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "balance_type": "B",
  • "cash_security": "C",
  • "ta_id": 0,
  • "transaction_id": 0,
  • "posting_id": 0,
  • "subbalance": "string",
  • "isin": "DE0007100000",
  • "txkey_id": 0,
  • "price_currency": "CAD",
  • "price_amount": "5877.78",
  • "cash_currency": "CAD",
  • "abs_orig_cash_amount_value": "5877.78",
  • "abs_orig_securities_amount": "5877.78",
  • "abs_cash_op_amount": "5877.78",
  • "abs_securities_op_amount": "5877.78",
  • "add_closed_postings": true,
  • "accounts": [
    ],
  • "postings": [
    ]
}

Close open postings

Close open postings together and optionally book out cash differences

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required
Array of objects
book_out_cash_diff
required
boolean
Default: false

If TRUE, then any amounts that do not close will be booked out and then closed

book_out_cash_diff_comment
string <= 140 characters

An explanation why the cash difference is booked out

book_out_cash_diff_account
string [ 1 .. 18 ] characters

The cash account to book any still open amount onto

Responses

Request samples

Content type
application/json
{
  • "close_postings": [
    ],
  • "book_out_cash_diff": false,
  • "book_out_cash_diff_comment": "string",
  • "book_out_cash_diff_account": "1000000123"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

overview of all reconciliation processes

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
reconciliation_process_id
required
integer <int64>
description
required
string <= 20 characters
auto_manual
required
string
Enum: "A" "M"
  • A - automatically
  • M - manually
cycle
required
string
Enum: "D" "W" "M" "Q" "S" "Y"
  • D - daily
  • W - weekly
  • M - monthly
  • Q - quarterly
  • S - semestrial
  • Y - yearly
intern_extern
required
string
Enum: "I" "E"
  • I - internal reconciliation
  • E - external reconciliation
last_execution
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

start reconciliation process

Authorizations:
oidc_headerbasicAuth
path Parameters
reconciliation_process_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

overview of all executed reconciliation with optional filters

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
string <date>
date_to
string <date>
reconciliation_process_id
integer <int64>
result
string
Enum: "S" "F"

Responses

Response Schema: application/json
Array
reconciliation_process_id
required
integer <int64>
description
required
string <= 20 characters
person_id_create
required
integer <int64>
person_create
required
string <= 161 characters
datetime_execution
required
string <date-time>
result
required
string
Enum: "S" "F"
  • S - success
  • F - failure
link
required
string <= 255 characters

Response samples

Content type
application/json
[
  • {
    }
]

get most recent comment on posting

Authorizations:
oidc_headerbasicAuth
path Parameters
ta_id
required
integer <int64>

first part of posting identifier

posting_id
required
integer <int64>

second part of posting identifier

Responses

Response Schema: application/json
person_id_create
required
integer <int64>

ID of the person that created the comment

person_create
required
string <= 161 characters

given name and name of the person that created the comment

valid_from
required
string <date-time>

timestamp the comment was saved

invalid_from
string <date-time>

timestamp the comment was updated

comment
required
string <= 255 characters

the comment

Response samples

Content type
application/json
{
  • "person_id_create": 0,
  • "person_create": "string",
  • "valid_from": "2019-08-24T14:15:22Z",
  • "invalid_from": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

save or update comment on posting

Authorizations:
oidc_headerbasicAuth
path Parameters
ta_id
required
integer <int64>

first part of posting identifier

posting_id
required
integer <int64>

second part of posting identifier

query Parameters
comment
required
string <= 255 characters

the comment

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get posting commenthistory

Authorizations:
oidc_headerbasicAuth
path Parameters
ta_id
required
integer <int64>

first part of posting identifier

posting_id
required
integer <int64>

second part of posting identifier

Responses

Response Schema: application/json
Array
person_id_create
required
integer <int64>

ID of the person that created the comment

person_create
required
string <= 161 characters

given name and name of the person that created the comment

valid_from
required
string <date-time>

timestamp the comment was saved

invalid_from
string <date-time>

timestamp the comment was updated

comment
required
string <= 255 characters

the comment

Response samples

Content type
application/json
[
  • {
    }
]

get the closed postings

Authorizations:
oidc_headerbasicAuth
path Parameters
ta_id
required
integer <int64>

first part of posting identifier

posting_id
required
integer <int64>

second part of posting identifier

Responses

Response Schema: application/json
person_close
required
string <= 161 characters
datetime_close
required
string <date-time>
book_out_cash_diff
required
boolean
required
Array of objects

Response samples

Content type
application/json
{
  • "person_close": "string",
  • "datetime_close": "2019-08-24T14:15:22Z",
  • "book_out_cash_diff": true,
  • "postings": [
    ]
}

Reports for administration

Administrative reporting and oversight endpoints

RPT023 - Portfolio account mappings

List all portfolio accounts mappings and their cash/securities accounts

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema:
One of
language
string
timezone
string
report_name
string
datetime_create
string <date-time>
boega_vermittlung
Array of objects
wertpapiergeschaeft
Array of objects
op
Array of objects

Response samples

Content type
Example
{
  • "language": "string",
  • "timezone": "string",
  • "report_name": "string",
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "boega_vermittlung": [
    ],
  • "wertpapiergeschaeft": [
    ],
  • "op": [
    ]
}

RPT026 - Roles and permissions

List all roles and all operationIDs with the required roles

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_name
string <= 80 characters
r_given_name
string <= 80 characters
r_role
string <= 100 characters
r_operation_id
string <= 100 characters
r_last_updated
string <date_time>

Response samples

Content type
Example
[ ]

RPT039 - KPI

KPI overview for given time interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_description
string
r_number
integer <int64>

Response samples

Content type
Example
[ ]

Reports for back-office

Back-office reporting endpoints

RPT001 - List all system accounts

List all system cash accounts (account_kind = A, account_class = S) or the system cash accounts matching the applied filters

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
string <= 18 characters
position: 1

Filter by internal account number

account_type_id
integer <int32>
position: 2

Filter by account type ID

account_opening_date_from
string <date>
position: 3

Filter by account opening date; start date

account_opening_date_to
string <date>
position: 4

ilter by account opening date; end date

gl_account_number
string <= 10 characters
position: 5

Filter by account number as assigned for general ledger

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_number
string <= 18 characters

internal account number

r_memo
string <= 18 characters

memorizable identifier of the account

r_name
string <= 80 characters

account name

r_account_type
string <= 80 characters

type of the account, e.g. Interim Account

r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_account_opening_date
string <date>

date on which the account was opened

r_gl_account_number
string <= 10 characters

account number as used in general ledger

r_last_transaction
string <date>

date on which the last transaction happened on the account

r_available_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT003 - Account opening statistics - Last 30 days

Statistics of the account openings within the last 30 days

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_day_1
integer <int64>
r_day_2
integer <int64>
r_day_3
integer <int64>
r_day_4
integer <int64>
r_day_5
integer <int64>
r_day_6
integer <int64>
r_day_7
integer <int64>
r_day_8
integer <int64>
r_day_9
integer <int64>
r_day_10
integer <int64>
r_day_11
integer <int64>
r_day_12
integer <int64>
r_day_13
integer <int64>
r_day_14
integer <int64>
r_day_15
integer <int64>
r_day_16
integer <int64>
r_day_17
integer <int64>
r_day_18
integer <int64>
r_day_19
integer <int64>
r_day_20
integer <int64>
r_day_21
integer <int64>
r_day_22
integer <int64>
r_day_23
integer <int64>
r_day_24
integer <int64>
r_day_25
integer <int64>
r_day_26
integer <int64>
r_day_27
integer <int64>
r_day_28
integer <int64>
r_day_29
integer <int64>
r_day_30
integer <int64>
r_min
integer <int64>
r_max
integer <int64>
r_delta
integer <int64>
r_mv
number
r_sum
integer <int64>

Response samples

Content type
Example
[ ]

RPT004 - Account opening statistics - Current year

Statistics of the account openings within the current year

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_january
integer <int64>
r_february
integer <int64>
r_march
integer <int64>
r_april
integer <int64>
r_may
integer <int64>
r_june
integer <int64>
r_july
integer <int64>
r_august
integer <int64>
r_september
integer <int64>
r_october
integer <int64>
r_november
integer <int64>
r_december
integer <int64>
r_min
integer <int64>
r_max
integer <int64>
r_delta
integer <int64>
r_mv
number
r_sum
integer <int64>

Response samples

Content type
Example
[ ]

RPT005 - Security activity on all securities accounts

Show activity of given security (WKN or ISIN) on all securities accounts

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Show activty starting from this booking date

date_to
required
string <date>
position: 2

Show activity until this booking date

wkn
string = 6 characters
position: 3

WKN of the security

isin
string = 12 characters
position: 4

ISIN of the security

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_depot_number
string <= 18 characters

securities account number

r_amount
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_debit_credit
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_price
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

r_share_value
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_booking_date
string <date>
r_value_date
string <date>
r_posting_text
string <= 140 characters

Response samples

Content type
Example
[ ]

RPT006 - Show all holdings of given securities

Show holdings of given securities on all securities accounts

Authorizations:
oidc_headerbasicAuth
query Parameters
balance_type
required
string
Enum: "B" "V" "T"
position: 1

Balance type

balance_date
required
string <date>
position: 2

Show holdings as of date

wkn
string = 6 characters
position: 3

WKN of the security

isin
string = 12 characters
position: 4

ISIN of the security

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_depot_number
string <= 18 characters

securities account number

r_account_number
string <= 18 characters

related cash account number

r_person_id
integer <int64>

ID of the account holder

r_name
string <= 161 characters

Given name and name of the account holder or account name

r_amount
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_subbalance
string <= 80 characters

sub-balance description

r_fsa_id
integer <int64>

internal ID of the FSA

r_nv_id
integer <int64>

internal ID of the NV

Response samples

Content type
Example
[ ]

RPT007 - Customer master data changes

Show all changes in customer master data (person data and address)

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_person_id
integer <int64>

person ID of the customer

r_name
string <= 80 characters

name of the customer

r_given_name
string <= 80 characters

given name of the customer

r_changed_master_data_type
string

the category of the updated data, e.g. person data or address

r_changed_master_data_field
string

the field that was changed, e.g. birth date

r_old_value
string

the old value

r_new_value
string

the new value

r_updated_datetime
string <date-time>

date and time the value was changed

r_updated_by_person_id
integer <int64>

ID of the person that changed the value

r_updated_by_name
string <= 80 characters

name of the person that changed the value

r_updated_by_given_name
string <= 80 characters

given name of the person that changed the value

Response samples

Content type
Example
[ ]

RPT008 - Customer cash transactions with an amount greater than given value

Show all customer cash transactions with an amount greater than the given value

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: amount=5877.78
position: 3
format: numeric(15,2)
minimum: 0.00

Filter by amount greater (>) given amount

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_person_id
integer <int64>

person ID of the customer

r_account_number
string <= 18 characters

customer account number

r_name
string <= 80 characters

name of the customer

r_given_name
string <= 80 characters

given name of the customer

r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_debit_credit
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_posting_text
string
r_external_bank_bic
string <= 11 characters
r_external_iban
string <= 34 characters

Response samples

Content type
Example
[ ]

RPT009 - Customer cash transactions of non-german tax residents

Show all customer cash transactions of non-german tax residents

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_number
string <= 18 characters

customer account number

r_name
string <= 80 characters

name of the customer

r_given_name
string <= 80 characters

given name of the customer

r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_debit_credit
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_txkey_description
string <= 140 characters
r_booking_date
string <date>
r_value_date
string <date>
r_address_country
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

Response samples

Content type
Example
[ ]

RPT010 - External accounts

List information on all external accounts

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_number
string <= 18 characters

customer account number

r_person_id
integer <int64>

person ID of the customer

r_name
string <= 80 characters

name of the customer

r_given_name
string <= 80 characters

given name of the customer

r_nationality
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

r_address_street
string <= 80 characters

customer address street

r_address_building_identifier
string <= 30 characters

customer address building identifier

r_address_post_box
string <= 10 characters

customer address post box

r_address_post_code
string <= 12 characters

customer address post code

r_address_city
string <= 80 characters

customer address city

r_address_country
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

r_external_bank_bic
string <= 11 characters

external bank BIC

r_external_iban
string <= 34 characters

external customer IBAN

r_first_used
string <date-time>

transaction date and time when external account was used for the first time

r_last_used
string <date-time>

transaction date and time when external account was used for the last time

Response samples

Content type
Example
[ ]

RPT011 - List block orders

List block orders within specified transaction date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

isin
string <= 18 characters
position: 3

Filter by ISIN

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_block_order_execution_id
string <uuid> (UUID)
r_isin
string <= 12 characters
r_wkn
string <= 6 characters
r_transaction_datetime
string <date-time>
r_execution_at_market_side
string
Enum: "BUY" "SELL"
r_execution_at_market_executed_quantity
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_execution_at_market_executed_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_execution_at_market_price_amount
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_execution_at_market_price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

Response samples

Content type
Example
[ ]

RPT012 - List of KISTAM Anfragen

List of KISTAM Anlassanfrage or Regelanfrage created within specified date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

anlass_regel
string
Enum: "ANLASSANFRAGE" "REGELANFRAGE"
position: 3

Anfrageart

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_person_id
integer <int64>
r_name
string <= 80 characters
r_given_name
string <= 80 characters
r_birth_date
string <date>
r_id_nr
string <= 30 characters
r_anlass_regel_anfrage
string
Enum: "Anlassanfrage" "Regelanfrage"
r_created
string <date>
r_reason
string
Enum: "Kapitalerträge" "Bei Begründung einer Geschäftsbeziehung" "Auf Veranlassung des Kunden"
r_created_by
string <= 161 characters
r_response_saved
string <date>
r_return_code
string <= 2 characters
r_church_tax_rate_in_pct
string[0-9]{1,2}(\.[0-9]{1})?
r_tax_raising_organisational_unit_identifier
string <= 6 characters
r_tax_raising_organisational_unit_description
string <= 140 characters
r_different_id_nr
string[0-9]{11}

Response samples

Content type
Example
[ ]

RPT013 - KESt-Anmeldung data

KESt-Anmeldung data as required for ELSTER portal

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$
position: 1

TID of KESt-Anmeldung booking

Responses

Response Schema:
One of
Array
object (rpt013)

Response samples

Content type
Example
[ ]

RPT014 - CA batch processing

Information on processing of a specific CA batch

Authorizations:
oidc_headerbasicAuth
query Parameters
ca_batch_processing_id
required
integer <int64>
position: 1

CA batch processing ID

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_ca_job_id
integer <int64>
r_ca_type
string <= 6 characters
r_temlate_version
integer <int32>
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_ag
string <= 1 characters
r_bid
string <= 12 characters
r_created_by
string <= 161 characters
r_created_date
string <date>
r_state
string <= 1 characters
r_record_date
string <date>
r_depository
string <= 30 characters
r_total_transactions
integer <int64>
r_successful_transactions
integer <int64>
r_failed_transactions
integer <int64>
r_pending_transactions
integer <int64>
r_ca_job_id_2
integer <int64>
r_customer_portfolio
string <= 18 characters
r_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_result
string

Response samples

Content type
Example
[ ]

RPT015 - CA job processing

Information on CA job processing

Authorizations:
oidc_headerbasicAuth
query Parameters
ca_job_id
required
integer <int64>
position: 1

CA job ID

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_ca_job_id
integer <int64>
r_ca_batch_processing_id
integer <int64>
r_processing_started
string <date-time>
r_processing_finished
string <date-time>
r_customer_portfolio
string <= 18 characters
r_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_result
string
r_booked
string <date-time>
r_error_code
integer <int32>

Response samples

Content type
Example
[ ]

RPT016 - Simulate Abgeltungssteuer calculation

Calculate Abgeltungssteuer based on the given parameters, e.g. for testing the calculation logic

Authorizations:
oidc_headerbasicAuth
query Parameters
kest_satz
required
string
Value: "25.00"
position: 1

Applicable KESt rate

soli_satz
required
string
Value: "5.50"
position: 2

Applicable Soli rate

kist_satz_1
required
string
Enum: "0.00" "8.00" "9.00"
position: 3

Applicable KiSt rate for person 1

kist_satz_2
string
Enum: "0.00" "8.00" "9.00"
position: 4

Applicable KiSt rate for person 2

steuerinlaender
required
boolean
Default: true
position: 5

Indicates if taxation shall be applied for German tax resident

nv_typ
string
Enum: "01" "02" "03" "02_35" "02_36" "02_37"
position: 6

Type of the Nichtveranlangungsbescheinigung

vermoegensart
required
string
Enum: "P" "K"
position: 7

The Vermoegensart to use

akti_gewinn
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: akti_gewinn=5877.78
position: 8
format: numeric(15,2)
minimum: 0.00

Sum of Aktiengewinne in current year

akti_verlust
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: akti_verlust=5877.78
position: 9
format: numeric(15,2)
minimum: 0.00

Sum of Aktienverluste in current year

sons_gewinn
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: sons_gewinn=5877.78
position: 10
format: numeric(15,2)
minimum: 0.00

Sum of Sonstige Gewinne in current year

sons_verlust
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: sons_verlust=5877.78
position: 11
format: numeric(15,2)
minimum: 0.00

Sum of Sonstige Verluste in current year

inl_div
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
position: 12
format: numeric(15,2)

Sum of Inländische Dividenden in current year

anr_qst
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: anr_qst=5877.78
position: 13
format: numeric(15,2)
minimum: 0.00

Sum of Anrechenbaren Quellensteuer in current year

fsa_saldo
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
Example: fsa_saldo=5877.78
position: 14
format: numeric(15,2)
minimum: 0.00

Usable FSA amount

Responses

Response Schema:
One of
document_data
object
Array of objects (transaction_booked_tax_data)

Response samples

Content type
Example
{
  • "document_data": { },
  • "tax_data": [
    ]
}

RPT017 - MT535 reconciliation of holdings

Reconcile nostro security accounts against holdings given in MT535

Authorizations:
oidc_headerbasicAuth
query Parameters
booking_date
required
string <date>
position: 1

Booking date

depository
required
string
position: 2

The depository

diff_only
required
boolean
Default: true
position: 3

If TRUE, then show only differences

account_number
string <= 18 characters
position: 4

Filter by (internal) account number

Responses

Response Headers
x-result-total
integer

The (actual) total to be considered for pagination; for json response only

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_amounts_match
boolean
r_account_number_intern
string <= 18 characters
r_account_memo_intern
string <= 18 characters
r_account_extern
string <= 35 characters
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_wkn
string <= 6 characters
r_security_description
string <= 61 characters
r_last_balance_date_extern
string <date>
r_last_booking_date_intern
string <date>
r_amount_extern
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_amount_intern
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_delta
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT018 - Simulate interest calculation

Calculate interests based on the given parameters, e.g. for testing the calculation logic

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
start_date
required
string <date>
position: 1
end_date
required
string <date>
position: 2
interest_method
required
string
Enum: "30/360" "act/360" "act/365" "act/act"
position: 3
required
Array of objects
position: 4
required
Array of objects
position: 5

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "interest_method": "30/360",
  • "interest_rate_model": [
    ],
  • "balance_list": [
    ]
}

Response samples

Content type
Example
[ ]

RPT019 - Interest account overview

List accounts and accrued interest

Authorizations:
oidc_headerbasicAuth
query Parameters
currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"
position: 1

Currency

end_date
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_number
string <= 18 characters
r_interest_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_interest_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT020 - Interest calculation details of an account

Interest calculation details of an account

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
required
string <= 18 characters
position: 1

Account number

end_date
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_date_from
string <date>
r_date_to
string <date>
r_interest_days
integer <int32>
r_year_days
integer <int32>
r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_interest_rate
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_interest_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT021 - Balance list (SUSA)

Balances of all cash accounts

Authorizations:
oidc_headerbasicAuth
query Parameters
bis_datum
required
string <date>
position: 1

As of date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_kontonummer
string <= 80 characters

our MEMO

r_kontobezeichnung
string <= 80 characters

account name

r_von_soll
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_von_haben
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_von_saldo
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_bis_soll
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_bis_haben
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_bis_saldo
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_bis_summe_soll
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_bis_summe_haben
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_differenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_kontrahentenkonto
string <= 100 characters
r_kontrahententyp
string
r_soll_saldo_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_haben_saldo_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_soll_saldo_kursdifferenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_haben_saldo_kursdifferenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_forderung_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_verbindlichkeit_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_forderung_kursdifferenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_verbindlichkeit_kursdifferenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT022 - Kostenstellen

Kostenstellen-Auswertung

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

send_per_mail
required
boolean
Default: false
position: 3

If TRUE, then report is send out to the configured receivers

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_kostenstelle
string
r_saldo_gesamt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_saldo_mt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_kg
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_kv
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_summe_mtb_kursdiff
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_court_ertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_court_aufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_summe_mtb_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_courtageertraege_orderausf
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_saldo_depot
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_profit
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_loss
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_zinsertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_zinsaufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_kest
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_soli
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_stueckzinsen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_dividendenertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_dividendenaufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_ausl_quellensteuer
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_nachrichtl_transaktionskosten
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT022 - Kostenstellen (read-only)

Create Kostenstellen-Auswertung without the option of sending it

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_kostenstelle
string
r_saldo_gesamt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_saldo_mt
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_kg
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_kv
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_summe_mtb_kursdiff
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_court_ertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_mtb_court_aufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_summe_mtb_courtagen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_courtageertraege_orderausf
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_saldo_depot
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_profit
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_loss
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_zinsertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_zinsaufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_kest
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_soli
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_stueckzinsen
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_dividendenertrag
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_dividendenaufwand
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_ausl_quellensteuer
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_nachrichtl_transaktionskosten
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT024 - CAMT053/MT940 reconciliation of balances

Reconcile nostro cash accounts against balances given in CAMT053 or MT940

Authorizations:
oidc_headerbasicAuth
query Parameters
booking_date
required
string <date>
position: 1

Booking date

depository
required
string
position: 2

The depository

diff_only
required
boolean
Default: true
position: 3

If TRUE, then show only differences

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_amounts_match
boolean
r_account_number_intern
string <= 18 characters
r_account_memo_intern
string <= 18 characters
r_account_extern
string <= 35 characters
r_last_balance_date_extern
string <date>
r_last_booking_date_extern
string <date>
r_last_booking_date_intern
string <date>
r_currency_extern
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_amount_extern
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_currency_intern
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_amount_intern
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_delta
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT025- P/L

Profit and loss overview

Authorizations:
oidc_headerbasicAuth
query Parameters
date_to
required
string <date>
position: 1

End date

securities_account_number
string <= 18 characters
position: 2

Filter by securities account number

send_per_mail
required
boolean
Default: false
position: 3

If TRUE, then report is send out to the configured receivers

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_securities_account_number
string <= 18 characters
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_wkn
string <= 6 characters
r_security_description
string <= 61 characters
r_pnl_prev_day
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl_diff
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT025- P/L (read-only)

Profit and loss overview without the option of sending it

Authorizations:
oidc_headerbasicAuth
query Parameters
booking_date
required
string <date>
position: 1

End date

securities_account_number
string <= 18 characters
position: 2

Filter by securities account number

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_securities_account_number
string <= 18 characters
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_wkn
string <= 6 characters
r_security_description
string <= 61 characters
r_pnl_prev_day
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl_diff
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT025A - P/L

Profit and loss overview for individual date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

securities_account_number
string <= 18 characters
position: 3

Filter by securities account number

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_securities_account_number
string <= 18 characters
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_wkn
string <= 6 characters
r_security_description
string <= 61 characters
r_pnl_prev_day
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl_diff
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT029 - Holdings

List all holdings as of date

Authorizations:
oidc_headerbasicAuth
query Parameters
to_date
required
string <date>
position: 1

As of date

balance_type
required
string
Default: "B"
Enum: "B" "V" "T"
position: 2

Balance type

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_depot_memo
string <= 80 characters
r_depot_name
string <= 80 characters
r_isin
string <= 12 characters
r_wkn
string <= 6 characters
r_account_number
string <= 18 characters
r_bestand
string
r_last_date
string <date_time>

Response samples

Content type
Example
[ ]

RPT030 - FLATEX short selling fees

List all charged short selling fees booken in the specified date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Start date

date_to
required
string <date>
position: 2

End date

date_type
required
string
Enum: "B" "V" "T"
position: 3

Balance type

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_memo
string
r_account_number
string
r_currency
string <= 3 characters
r_valuta
string <date>
r_amount
string
r_booking_date
string <date_time>

Response samples

Content type
Example
[ ]

RPT031 - Discarded transactions

List discarded transactions created within given date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
creation_date_from
required
string <date>
position: 1

Date from

creation_date_to
required
string <date>
position: 2

Date to

source
string <= 63 characters
position: 3

Filter by transaction source

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_ta_id
integer <int64>
r_transaction_id
integer <int64>
r_source
string <= 63 characters
r_datetime_create
string <date-time>
r_discarded_at
string <date-time>
r_discarded_by
string <= 161 characters
r_comment
string <= 255 characters

Response samples

Content type
Example
[ ]

RPT032 - Profit center P/L

List P/L per profit center

Authorizations:
oidc_headerbasicAuth
query Parameters
date_from
required
string <date>
position: 1

Min. booking date (incl.)

date_to
required
string <date>
position: 2

Max. booking date (incl.)

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_haendler
string <= 80 characters
r_kv_nr
string <= 4 characters
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_wkn
string <= 6 characters
r_kuerzel
string <= 4 characters
r_kurs_differenz
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_gesamt_courtage
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_pnl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
Example
[ ]

RPT033 - GL-export transactions

GL-export transactions in alternative format

Authorizations:
oidc_headerbasicAuth
query Parameters
gl_export_header_id
required
integer
position: 1

ID of previously created GL-export

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_rec_id
integer <int64>
r_waehrung
string
r_buchungsdatum
string <date>
r_belegdatum
string <date>
r_valuta
string <date>
r_betrag_soll
string
r_betrag_haben
string
r_betrag_diff
string
r_hauptbuch_konto
string
r_kostenstelle
string
r_kostentraeger
string
r_auftragsnummer
string
r_buchungstext
string

Response samples

Content type
Example
[ ]

RPT034 - Holdings

List holdings as of given date interval

Authorizations:
oidc_headerbasicAuth
query Parameters
datum_von
required
string <date>
position: 1

Date from

datum_bis
required
string <date>
position: 2

Date to

balance_type
required
string
Enum: "B" "T"
position: 3

Balance type

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_handelsbuchnr
integer
r_depotnummer
string
r_isin
string
r_wkn
string
r_bezeichnung
string
r_bestand
string
r_schnittkurs
string
r_bestandswert
string
r_bewertungskurs
string
r_tpf_kurs
string
r_depotwert
string
r_real_pl
string
r_unreal_pl
string
r_anzahl
integer

Response samples

Content type
Example
[ ]

RPT035 - Failed transactions

List failed transactions created until given date

Authorizations:
oidc_headerbasicAuth
query Parameters
date_to
required
string <date>
position: 1

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_tid
string
r_error_code
integer <int32>
r_error_text
string
r_source_name
string
r_account_number
string <= 18 characters
r_source_data_booking_date
string <date>
r_source_data_text
string
r_source_data_cash_dc
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_source_data_cash_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_source_data_cash_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_source_data_isin
string <= 6 characters
r_source_data_wkn
string <= 6 characters
r_source_data_securities_direction
string
Enum: "BUYI" "SELL" "RECE" "DELI"
r_source_data_securities_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_comment
string

Response samples

Content type
Example
[ ]

RPT036 - OP on CP accounts

Open postings on counterparty accounts

Authorizations:
oidc_headerbasicAuth
query Parameters
value_date
required
string <date>
position: 1

Max. value date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_value_date
string <date>
r_account_number
string
r_subbalance
string
r_open_amount
string
r_source
string <= 18 characters
r_ta_id
integer <int64>
r_transaction_id
integer <int64>
r_posting_text
string

Response samples

Content type
Example
[ ]

RPT037 - K factors

List K factors

Authorizations:
oidc_headerbasicAuth
query Parameters
start_date
required
string <date>
position: 1

Start date

end_date
required
string <date>
position: 2

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_1_key
string
r_1_value_num
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_1_value_str
string
r_2_fs
string
r_3_buchungszeitpunkt
string <date>
r_3_geschaeftszeitpunkt
string <date-time>
r_3_ta_id_transaction_id
string
r_3_kauf_verkauf
string
r_3_storno
string
r_3_kassa_derivat
string
r_3_depotnummer
string
r_3_kfaktor
string
r_3_wkn
string
r_3_isin
string
r_3_prd_grp
string
r_3_stuecknominale
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_3_kurs
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_3_waehrung
string
r_3_devisenkurs
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_3_duration
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_3_dtf_kassa
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_3_dtf_derivat
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_3_coh_kassa
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_3_coh_derivat
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_3_underlying_wkn
string
r_3_underlying_isin
string
r_3_underlying_kurs
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

r_3_umtauschverh
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

Response samples

Content type
Example
[ ]

RPT038 - P/L statement

Activity of profit and loss accounts related to given securities account

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
required
string <= 18 characters
position: 1

Account number of a securities account

isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
Example: isin=DE0007100000
position: 2

ISIN

balance_type
required
string
Enum: "B" "V" "T"
position: 3

Balance type

date_from
required
string <date>
position: 4

Date from

date_to
required
string <date>
position: 5

Date to

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_tid
string
r_posting_id
integer <int64>
r_booking_date
string <date>
r_business_datetime
string <date->
r_value_date
string <date>
r_wp_bestand
number
r_profit
number <double>
r_loss
number <double>
r_pnl
number <double>
r_stck_zns_bstd
number <double>
r_stck_zns_aufwd
number <double>
r_stck_zns_ertrg
number <double>
r_stck_zns_pnl
number <double>
r_tx_kosten
number <double>
r_courtage
number <double>
r_korrektur_tid
string

Response samples

Content type
Example
[ ]

RPT040 - Activity for given ISINs

Activity for given ISINs on all securities accounts that traded the given ISINs

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
date_from
required
string <date>
position: 1

Start date (booking date)

date_to
required
string <date>
position: 2

End date (booking date)

isins
required
Array of strings (isin) [ 1 .. 5 ] items [ items^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$ ]
position: 3

List of ISINs (max. 5)

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_account_number
string <= 18 characters
r_account_memo
string <= 18 characters
r_isin
string <= 12 characters
r_wkn
string <= 6 characters
r_booking_date
string <date>
r_posting_text
string <= 140 characters
r_debit_credit
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_amount
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

r_price_amount
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

r_price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_transaction_datetime
string <date-time>
r_pnl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_avg_price_amount
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

r_fifo_position_acc_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

Request samples

Content type
application/json
{
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "isins": [
    ]
}

Response samples

Content type
Example
[ ]

RPT041 - Accrual booking template

Suggestion for accrual bookings

Authorizations:
oidc_headerbasicAuth
query Parameters
end_date
required
string <date>
position: 1

Date for the year-end cut-off

value_date
string <date>
position: 2

The value date to use for preallocating

geschaeftszeitpunkt
string <date-time>
position: 3

The transaction date and time to use for preallocating

gegen_konto
string
position: 4

The counter account to use for preallocating

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_person_id_create
integer <int64>
r_account_number
string <= 18 characters
r_booking_date_out
string <date>
r_booking_date_in
string <date>
r_amount
string
r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

r_debit_credit_in
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

r_subbalance
string
r_accrual_account_number
string <= 18 characters
r_value_date
string <date>
r_transaction_datetime
string
r_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
r_posting_text
string

Response samples

Content type
Example
[ ]

RPT042 - Holdings under consideration of accrual date

Security account holdings regarding transaction date as of accrual (booking) date

Authorizations:
oidc_headerbasicAuth
query Parameters
transaction_date_from
required
string <date>
position: 1

Start date (incl.)

transaction_date_to
required
string <date>
position: 2

End date (incl.)

accrual_date
required
string <date>
position: 3

Accrual date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_handelsbuchnr
integer
r_depotnummer
string
r_isin
string
r_wkn
string
r_bezeichnung
string
r_bestand
string
r_schnittkurs
string
r_bestandswert
string
r_bewertungskurs
string
r_tpf_kurs
string
r_depotwert
string
r_real_pl
string
r_unreal_pl
string
r_anzahl
integer

Response samples

Content type
Example
[ ]

Reports on customers

Reporting on a specific customer

RPT002 - Balance history

Show balance history of a cash account

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
required
string <= 18 characters
position: 1

Account number of a cash account

balance_type
required
string
Enum: "B" "V" "T"
position: 2

Balance type

start_date
required
string <date>
position: 3

Start date

end_date
required
string <date>
position: 4

End date

Responses

Response Schema:
One of
Array
type
required
string
Enum: "M" "H" "R"

M = metadata, H = headers of the report columns and column excel types, R = row of the report

index
integer <int32>

in case of multiple report data sheets in the excel file, specify the sheet

worksheet_title
string <= 31 characters

title of the worksheet

m_parameters
Array of strings

a list of all parameters

m_parameter_names
object

the parameter names as keys and the pretty names for display as values

m_parameter_types
object

the parameter names as keys and the excel types as values

m_parameter_values
object

the parameter names as keys and they values as values

h_columns
Array of strings

a list of all columns

h_column_names
object

the column names as keys and the pretty names for display as values

h_column_types
object

the column names as keys and the excel types as values

r_date
string <date>

as of date

r_available_balance
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

r_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

Response samples

Content type
Example
[ ]

Self-service

Access to the authenticated user's own profile, preferences, and identity data

List accounts of a person (self)

Get all accounts that a person is the account holder of or is authorized

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
account_number
required
string <= 18 characters

Account number (internal)

name
required
string <= 80 characters

Account name

currency
string = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

Account currency in case of a cash account

account_kind
required
string
Enum: "A" "D"

Cash "A"ccount or securities account ("D"epot)

memo
string <= 18 characters

Memorizable identifier

iban
string <= 34 characters

IBAN

account_type
string <= 80 characters

Type (description) of the account

Response samples

Content type
application/json
[
  • {
    }
]

Get addresses of a person (self)

Get address or adresses (living and deliery) of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
address_id
required
integer <int64>

ID of the address

address_type
required
string (address_type)
Default: "L"
Enum: "L" "D"

Address_Type:

  • 'L' - Living Address
  • 'D' - Delivery Address
datetime_update
required
string <date-time>

Date and time this data was last updated

street
string <= 80 characters

Name of street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Response samples

Content type
application/json
[
  • {
    }
]

Add a new address of a person (self)

Add a new address to an already created person Per person max. 1 living address is allowed. Trying to add more than one living address throws an error, address update might be the better choice in those cases.

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

The new address to add

address_type
string
Default: "L"
Enum: "L" "D"

Type of the address

street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Response Schema: application/json
address_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "address_type": "L",
  • "street": "Hauptstr.",
  • "building_identifier": "1",
  • "suite_identifier": "A",
  • "floor_identifier": "1",
  • "district_name": "1",
  • "post_box": "POB123",
  • "post_code": "12345",
  • "city": "Bernau",
  • "country_subentity": "Brandenburg",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "address_id": 0
}

Change address (self)

Change an already existing address of a person

Authorizations:
oidc_headerbasicAuth
path Parameters
address_id
required
integer <int64> (id_number)

ID of an address

Request Body schema: application/json
required

Address to set

address_type
string
Default: "L"
Enum: "L" "D"

Type of the address

street
string <= 80 characters

Name of the street

building_identifier
string <= 30 characters

Building number

suite_identifier
string <= 10 characters

Identifier (e.g. number) of the suite/flat

floor_identifier
string <= 10 characters

Floor number

district_name
string <= 80 characters

District

post_box
string <= 10 characters

Post office box

post_code
string <= 12 characters

Post/ZIP code

city
required
string <= 80 characters

City or municipality

country_subentity
string <= 80 characters

Province, region, or state

country
required
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

Address country

Responses

Request samples

Content type
application/json
{
  • "address_type": "L",
  • "street": "Hauptstr.",
  • "building_identifier": "1",
  • "suite_identifier": "A",
  • "floor_identifier": "1",
  • "district_name": "1",
  • "post_box": "POB123",
  • "post_code": "12345",
  • "city": "Bernau",
  • "country_subentity": "Brandenburg",
  • "country": "ABW"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

set new password for current user

the application is expected to ask the user for his password and double check it

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

the settings

password
required
string <password>

the password

current_password
string <password>

the password

Responses

Request samples

Content type
application/json
{
  • "password": "my secret password",
  • "current_password": "my secret password"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get person data

get the persons data using current credentials

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
person_id
required
integer <int64>

ID of the person

datetime_create
required
string <date-time>

Date and time this person was created

datetime_update
required
string <date-time>

Date and time this entry was last updated

state
required
string
Enum: "S" "V" "I" "C"

State of the person

name
string <= 80 characters

The person's name

given_name
string <= 80 characters

The person's given name

birth_date
string <date>

The person's birth date

gender
string
Enum: "M" "F" "X"

The person's gender

nationality
string [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

The person's nationality

primary_email_address
string <email> <= 255 characters

The (verified) primary email address of the person

primary_phone_number
string <= 30 characters

The primary phone number of the person in format E.164

is_merchant
required
boolean

Indicates if the person is a merchant/company

company_name
string <= 80 characters

Name of the company in case of a merchant/company

birth_city
string <= 80 characters

City or municipality the person was born

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

person_alias
string

The person's alias

client_type
string
Enum: "B" "R"

Type of the person

Array of objects

Response samples

Content type
application/json
{
  • "person_id": 0,
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "datetime_update": "2019-08-24T14:15:22Z",
  • "state": "S",
  • "name": "example",
  • "given_name": "user",
  • "birth_date": "1970-12-24",
  • "gender": "M",
  • "nationality": "ABW",
  • "primary_email_address": "anna@domain.tld",
  • "primary_phone_number": 49123456789,
  • "is_merchant": false,
  • "company_name": "ibm",
  • "birth_city": "Berlin",
  • "pep": true,
  • "fatca": true,
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "person_alias": "string",
  • "client_type": "B",
  • "external_identifiers": [
    ]
}

change current persons data

change current persons data

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

the persons data

gender
string
Enum: "M" "F" "X"

Gender of the person

birth_date
string <date>

Birth date of the person

birth_city
string <= 80 characters

Birth city or municipality of the person

us_person
boolean

Indicator if person is US citizen

age_check
boolean

Indicator if person's age is checked (18 years or older)

own_behalf
boolean

Indicator if person is acting on own befalf

pep
boolean

Politically Exposed Person

fatca
boolean

Foreign Account Tax Compliance Act

name
string <= 100 characters

Name of the person

given_name
string <= 100 characters

Given name of the person

person_alias
string

Alias of the person

Responses

Request samples

Content type
application/json
{
  • "gender": "M",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "us_person": true,
  • "age_check": true,
  • "own_behalf": true,
  • "pep": true,
  • "fatca": true,
  • "name": "Mustermann",
  • "given_name": "Max",
  • "person_alias": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

remove the person and close account

initiate removal of person and close account

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get settings

get current settings own person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
language
required
string (language)
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

ISO-639-1 language code

timezone
string (timezone) <= 50 characters

time zone name see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fortaleza - America/Fort_Nelson - America/Fort_Wayne - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indianapolis - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Porto_Acre - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/Stanley - Atlantic/St_Helena - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/North - Australia/NSW - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/East-Saskatchewan - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - CET - Chile/Continental - Chile/EasterIsland - CST6CDT - Cuba - EET - Egypt - Eire - EST - EST5EDT - Etc/GMT - Etc/GMT0 - Etc/GMT-0 - Etc/GMT+0 - Etc/GMT-1 - Etc/GMT+1 - Etc/GMT-10 - Etc/GMT+10 - Etc/GMT-11 - Etc/GMT+11 - Etc/GMT-12 - Etc/GMT+12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT+2 - Etc/GMT-3 - Etc/GMT+3 - Etc/GMT-4 - Etc/GMT+4 - Etc/GMT-5 - Etc/GMT+5 - Etc/GMT-6 - Etc/GMT+6 - Etc/GMT-7 - Etc/GMT+7 - Etc/GMT-8 - Etc/GMT+8 - Etc/GMT-9 - Etc/GMT+9 - Etc/Greenwich - Etc/UCT - Etc/Universal - Etc/UTC - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT0 - GMT-0 - GMT+0 - Greenwich - Hongkong - HST - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - MST - MST7MDT - Navajo - NZ - NZ-CHAT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - posixrules - PRC - PST8PDT - ROC - ROK - Singapore - Turkey - UCT - Universal - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/Eastern - US/East-Indiana - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - WET - W-SU - Zulu

person_data
object

opaque object where the frontend can store data

Response samples

Content type
application/json
{
  • "language": "de",
  • "timezone": "UTC",
  • "person_data": {
    }
}

set language

get current settings own selected person

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

the settings

language
required
string (language)
Enum: "en" "aa" "ab" "af" "am" "ar" "as" "ay" "az" "ba" … 125 more

ISO-639-1 language code

timezone
string (timezone) <= 50 characters

time zone name see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fortaleza - America/Fort_Nelson - America/Fort_Wayne - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indianapolis - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Porto_Acre - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/Stanley - Atlantic/St_Helena - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/North - Australia/NSW - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/East-Saskatchewan - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - CET - Chile/Continental - Chile/EasterIsland - CST6CDT - Cuba - EET - Egypt - Eire - EST - EST5EDT - Etc/GMT - Etc/GMT0 - Etc/GMT-0 - Etc/GMT+0 - Etc/GMT-1 - Etc/GMT+1 - Etc/GMT-10 - Etc/GMT+10 - Etc/GMT-11 - Etc/GMT+11 - Etc/GMT-12 - Etc/GMT+12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT+2 - Etc/GMT-3 - Etc/GMT+3 - Etc/GMT-4 - Etc/GMT+4 - Etc/GMT-5 - Etc/GMT+5 - Etc/GMT-6 - Etc/GMT+6 - Etc/GMT-7 - Etc/GMT+7 - Etc/GMT-8 - Etc/GMT+8 - Etc/GMT-9 - Etc/GMT+9 - Etc/Greenwich - Etc/UCT - Etc/Universal - Etc/UTC - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT0 - GMT-0 - GMT+0 - Greenwich - Hongkong - HST - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - MST - MST7MDT - Navajo - NZ - NZ-CHAT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - posixrules - PRC - PST8PDT - ROC - ROK - Singapore - Turkey - UCT - Universal - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/Eastern - US/East-Indiana - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - WET - W-SU - Zulu

person_data
object

opaque object where the frontend can store data

Responses

Request samples

Content type
application/json
{
  • "language": "de",
  • "timezone": "UTC",
  • "person_data": {
    }
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get passport

get recent passport of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
passport_id
integer <int64> (id_number)

An internal ID

document_type
string (id_document_type)
Enum: "I" "P"
  • I - ID card * P - passport
name
string <= 80 characters

the persons name

given_name
string <= 80 characters

the persons given name

birth_date
string <date>

the persons birth date

birth_city
string <= 80 characters

City or municipality

nationality
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

issuing_country
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

birth_name
string <= 80 characters
academic_title_id
integer
passport_number
string <= 16 characters

Response samples

Content type
application/json
{
  • "passport_id": 0,
  • "document_type": "I",
  • "name": "example",
  • "given_name": "user",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "nationality": "ABW",
  • "issuing_country": "ABW",
  • "birth_name": "string",
  • "academic_title_id": 0,
  • "passport_number": "string"
}

save passport

save passport of a person

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required
document_type
required
string (id_document_type)
Enum: "I" "P"
  • I - ID card * P - passport
name
required
string <= 80 characters

the persons name

given_name
required
string <= 80 characters

the persons given name

birth_date
required
string <date>

the persons birth date

birth_city
required
string <= 80 characters

City or municipality

nationality
required
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

issuing_country
required
string (country_code_alpha3) [ 1 .. 3 ] characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ANT" "ARE" "ARG" … 264 more

iso 3166 alpha3 like country codes

birth_name
string <= 80 characters
academic_title_id
required
integer <int32>
object (new_address_from_passport)

an address

passport_number
required
string <= 16 characters

Responses

Response Schema: application/json
passport_id
required
integer <int64> (id_number)

An internal ID

Request samples

Content type
application/json
{
  • "document_type": "I",
  • "name": "Nachname",
  • "given_name": "Vorname",
  • "birth_date": "1970-12-24",
  • "birth_city": "Berlin",
  • "nationality": "ABW",
  • "issuing_country": "ABW",
  • "birth_name": "string",
  • "academic_title_id": 0,
  • "address": {
    },
  • "passport_number": "string"
}

Response samples

Content type
application/json
{
  • "passport_id": 0
}

get all face images

get all face images of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
face_id
required
integer <int64> (id_number)

An internal ID

datetime_update
required
string <date-time>

date and time this entry was last updated

type
required
string
Enum: "image/bmp" "image/jpeg" "image/png"

Response samples

Content type
application/json
[
  • {
    }
]

get a face image

get a specific face image

Authorizations:
oidc_headerbasicAuth
query Parameters
face_id
required
integer <int64> (id_number)

id of the face

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

add face to person

add a new face to an already created person

Authorizations:
oidc_headerbasicAuth
Request Body schema: multipart/form-data
required

Face to add

face_image
required
string <binary>

if available, the image that is stored on the passport

Responses

Response Schema: application/json
face_id
required
integer <int64> (id_number)

An internal ID

Response samples

Content type
application/json
{
  • "face_id": 0
}

delete a face

limit the validity of the connection person - face

Authorizations:
oidc_headerbasicAuth
query Parameters
face_id
required
integer <int64> (id_number)

id of the face

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get the current face image

get the current faceimage of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: */*
string <binary>

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get phone numbers

get all phone numbers of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
phone_number_id
required
integer <int64> (id_number)

An internal ID

is_primary
required
boolean

indicate a primary phone number

datetime_update
required
string <date-time>

date and time this entry was last updated

phone_number
required
string <= 30 characters
phone_number_type
required
string (phone_number_type)
Enum: "M" "F"

Phone Number Type:

  • 'M' - Mobile
  • 'F' - Fixed Network
is_validated
required
boolean

indicates if a phone number has been validated via sms code

Response samples

Content type
application/json
[
  • {
    }
]

add phone to person

add a new phone to an already created person. please note: only mobile phone number will be accepted and the phone number needs to be verified through the sms code sent to it

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

Phone to add

phone_number
required
string <= 30 characters

Phone number

default_region
string
Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" … 235 more

Default region

phone_number_type
string
Enum: "M" "F"

Type of the phone number

Responses

Response Schema: application/json
phone_number_id
integer <int64> (id_number)

An internal ID

need_verification
required
boolean

if the client allows fixed line phone numbers, they cannot be validated using sms. there we have no chance besides trust. in such cases no phone number validation is need and the number is active right away

Request samples

Content type
application/json
{
  • "phone_number": "+(681) 821235",
  • "default_region": "DE",
  • "phone_number_type": "M"
}

Response samples

Content type
application/json
{
  • "phone_number_id": 0,
  • "need_verification": true
}

validate a phone number using verification code received via sms

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

Phone to validate

phone_number
required
string <= 30 characters
default_region
string (iso_3166_1_region)
Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" … 235 more

optional ISO 3166-1 alpha-2 region code, used if region cannot be determined from the phone_number.

for detail see https://github.com/google/libphonenumber/blob/master/cpp/src/phonenumbers/phonenumberutil.cc ->Parse

verification_code
required
string (verification_number) = 6 characters \d{6}

a verification number

Responses

Request samples

Content type
application/json
{
  • "phone_number": "+(49) 171-123456789",
  • "default_region": "DE",
  • "verification_code": "123456"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete phone

limit the validity of the connection person - phone

Authorizations:
oidc_headerbasicAuth
query Parameters
phone_number_id
required
integer <int64> (id_number)

id of the phone

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

make a phone number the primary phone number

make the current number the primary phone number

Authorizations:
oidc_headerbasicAuth
path Parameters
phone_number_id
required
integer <int64> (id_number)

id of the phone

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

add a subscription

Authorizations:
oidc_headerbasicAuth
path Parameters
ws_notification_event_id
required
integer

events id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete a subscription

Authorizations:
oidc_headerbasicAuth
path Parameters
ws_notification_event_id
required
integer

events id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

add a subscription

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
action
string
Default: "R"

Responses

Request samples

Content type
application/json
{
  • "action": "R"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

get all messages for a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
message
required
object
websocket_message_id
required
integer
datetime_read
string <date-time>
datetime_sent
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

get all messages for a person

Authorizations:
oidc_headerbasicAuth
path Parameters
websocket_message_id
required
integer

messages id

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

connect interface for aws-apigate websocket

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
ws_notification_event_id
required
integer
ws_notification_type
required
string
ws_notification_description
string

Response samples

Content type
application/json
[
  • {
    }
]

get email addresses

get all email addresses of a person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
email_address_id
integer <int64> (id_number)

An internal ID

email_address
required
string <email> <= 255 characters

the email address

state
required
string
Enum: "V" "C"
  • V = verified
  • C = not verified; have valid code for verification
datetime_confirmed
string <date-time>

date and time this email address was confirmed

is_primary
boolean

indicate a primary email_address

Response samples

Content type
application/json
[
  • {
    }
]

change email address of person

change email address of an existing person

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

Email address to add

email_address
required
string <email> <= 255 characters

the email address

Responses

Request samples

Content type
application/json
{
  • "email_address": "anna@domain.tld"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

validate an email address using verification code received via email

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
required

Email address to validate

email_address
required
string <= 255 characters
verification_code
required
string (verification_code) <= 36 characters

A verification code

Responses

Request samples

Content type
application/json
{
  • "email_address": "anna@domain.tld",
  • "verification_code": "ABCD123"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

delete email address

limit the validity of the connection person - email address

Authorizations:
oidc_headerbasicAuth
query Parameters
email_address_id
required
integer <int64> (id_number)

id of the email address

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

make an email address the primary email address

make the current email address the primary email address

Authorizations:
oidc_headerbasicAuth
path Parameters
email_address_id
required
integer <int64> (id_number)

id of the email address

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

get a transfer token

Get current settings for selected person

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
token
required
string
exp
required
integer

Response samples

Content type
application/json
{
  • "token": "string",
  • "exp": 0
}

Templates

Template management for reports or postings

Values for preallocating filters in FE

Get enums and default values for parameters based on data in the databse and already submitted parameters

Authorizations:
oidc_headerbasicAuth
query Parameters
operation_id
required
string

Operation ID of the interface (e.g. report or posting template)

request
object

The parameters/ request body of the report/posting template or other interface

client_context_person_id
integer <int64>

The person ID calling the interface

Responses

Response Schema: application/json
Array
name
string

name of the parameter

Array of objects
editable
boolean

TRUE, if can value be overwritten, FALSE otherwise

string or boolean or integer or Array of strings

value to be pre-selected

Response samples

Content type
application/json
[
  • {
    }
]

Get all admin report templates

Get the specifications of all admin report templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all report templates

Get the specifications of all reports templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all back-office report templates

Get the specifications of all back-office report templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all customer report templates

Get the specifications of all customer report templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all admin posting templates

Get the specifications of all admin posting templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all back-office posting templates

Get the specifications of all back-office posting templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Get all customer posting templates

Get the specifications of all customer posting templates for automatic FE generation

Authorizations:
oidc_headerbasicAuth

Responses

Response Schema: application/json
Array
operation_id
required
string

The unique operation ID of the endpoint to be called

path
required
object

An OpenAPI specification of the endpoint including all referenced schemas

Response samples

Content type
application/json
[
  • {
    }
]

Transactions

Transaction retrieval, details, and related metadata

Blocked securities amounts

List all currently blocked holdings

Authorizations:
oidc_headerbasicAuth
query Parameters
account_number
required
string (account_number) <= 18 characters
Example: account_number=0000000012

Account number of a securities account

isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
Example: isin=DE0007100000

ISIN

block_securities_reason_id
required
integer

Reason for blocking

subbalance_id
required
integer

ID of the sub-balance

Responses

Response Schema: application/json
Array
ta_id
required
integer <int64>

First part of transaction identifier

transaction_id
required
integer <int64>

Second part of transaction identifier

block_securities_id
required
integer <int64>

ID od source record

isin
required
string^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$

ISIN of blocked securities

wkn
required
string <= 6 characters

WKN of blocked securities

nominal
required
string^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

Blocked nominals

block_securities_reason
required
string <= 80 characters

Blocking reason

subbalance
required
string <= 80 characters

Description of the sub-balance

date_from
required
string <date>

Start date of blocking period

date_to
required
string <date>

End date of blocking period

Response samples

Content type
application/json
[
  • {
    }
]

Booked transactions

List all booked transactions

Authorizations:
oidc_headerbasicAuth
query Parameters
required
string or string (transaction_source)

Filter by transaction source

date_from
required
string <date>

Start date regarding transaction creation

date_to
required
string <date>

End date regarding transaction creation

Responses

Response Headers
x-result-total
integer

The (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
ta_id
required
integer <int64>

First part of transaction identifier

transaction_id
required
integer <int64>

Second part of transaction identifier

id
required
integer <int64>

ID of the source record

source
required
string

Name of the transaction source

datetime_create
required
string <date-time>

Date and time the transaction was created

booked
required
string <date-time>

Date and time the transaction was booked

timeused
required
string^[0-9]{1,8}(\.[0-9]{1,3})?$
format: numeric(11,3)
minimum: 0.000

Time used to book the transaction (in ms)

Response samples

Content type
application/json
[
  • {
    }
]

List pending transactions

List all pending (send to unknown) transactions

Authorizations:
oidc_headerbasicAuth
query Parameters
string or string (transaction_source)

Transaction source for filtering

date_from
string <date>

Transaction creation start date for filtering

date_to
string <date>

Transaction creation end date for filtering

Responses

Response Headers
x-result-total
integer

The (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
ta_id
required
integer <int64>

First part of transaction identifier

transaction_id
required
integer <int64>

Second part of transaction identifier

id
required
integer <int64>

ID of the source record

source
required
string

Name of the source

datetime_create
required
string <date-time>

Date and time the transaction was saved

Response samples

Content type
application/json
[
  • {
    }
]

list all failed transaction that need to be re-triggered or discarded

Authorizations:
oidc_headerbasicAuth
query Parameters
string or string (transaction_source)

transaction source for filtering

date_from
string <date>

transaction creation start date for filtering

date_to
string <date>

transaction creation end date for filtering

Responses

Response Headers
x-result-total
integer

the (actual) total to be considered for pagination

x-result-complete
boolean

TRUE if data set is complete, FALSE if database contains more data than is being returned

Response Schema: application/json
Array
ta_id
required
integer <int64>

first part of transaction identifier

transaction_id
required
integer <int64>

second part of transaction identifier

id
required
integer <int64>

ID of the source record

source
required
string

name of the source table

datetime_create
required
string <date-time>

date and time the transaction was saved

last_booking_attempt
string <date-time>

date and time the transaction failed (most recent)

last_error_code
integer <int32>

error that occurred (most recent)

last_error_text
string <= 255 characters

error that occurred (most recent)

last_message_text
string

last technical error message

last_comment
string <= 255 characters

free text field

Response samples

Content type
application/json
[
  • {
    }
]

Posting journal

The posting journal of a transaction

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
integer

First part of transaction identifier

transaction_id
integer

Second part of transaction identifier

show_pnl_correction
boolean
Default: false

If TRUE, then also show P/L correction postings

Responses

Response Schema:
required
object

Header information of a transaction

object

The TID of the transaction reversed by the current one

object

The TID of the transaction that reversed by the current one

Array of objects
Array of objects
Array of objects
Array of objects

Response samples

Content type
{
  • "t_transaction": {
    },
  • "t_reverses_tx": {
    },
  • "t_reversed_by_tx": {
    },
  • "t_money_postings": [
    ],
  • "t_security_postings": [
    ],
  • "t_money_dispo_postings": [
    ],
  • "t_security_dispo_postings": [
    ]
}

Additional information on a transaction

Further information on a transaction relevant for the customer

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
required
integer <int64>

First part of transaction identifer

transaction_id
required
integer <int64>

Second part of transaction identifer

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of transaction identifier (transaction account)

transaction_id
required
integer <int64>

Second part of transaction identifier

money_link_name
object

Additional information on the money link

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "money_link_name": { }
}

Booked message

The transaction data forwarded to the upstream system

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
integer

First part of transaction identifier

transaction_id
integer

Second part of transaction identifier

Responses

Response Schema: application/json
source
required
string non-empty

source identifier

id
required
integer <int64>

unique ID per transacting account and source

datetime_create
required
string <date-time>

timestamp when the transaction was created

booked
required
string <date-time>

timestamp when the transaction was completed/booked

external_reference
string <uuid> (UUID)
required
Array of transaction_booked_cash_balance (object) or transaction_booked_security_balance (object)
Array of transaction_booked_cash_posting (object) or transaction_booked_security_posting (object)
Array of transaction_booked_dispo_cash_posting (object) or transaction_booked_dispo_security_posting (object)
metadata
object

addinional information, e.g. for corporate actions

Array of objects (transaction_booked_tax_data)
object

reference to original transaction in case of reversal

Response samples

Content type
application/json
{
  • "source": "string",
  • "id": 0,
  • "datetime_create": "2019-08-24T14:15:22Z",
  • "booked": "2019-08-24T14:15:22Z",
  • "external_reference": "ff6b6877-0d9b-4d38-88cb-b406b386003e",
  • "balances": [
    ],
  • "postings": [
    ],
  • "dispo_postings": [
    ],
  • "metadata": { },
  • "tax_data": [
    ],
  • "original_transaction_reference": {
    }
}

Transaction source details

Source data of a transaction

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
required
integer <int64>

First part of transaction identifier

transaction_id
required
integer <int64>

Second part of transaction identifier

Responses

Response Schema: application/json
required
string or string

Name of the transaction source

data
required
object

The source data (the fields and structure varies between different sources)

documents
Array of strings <uri> [ items <uri > ]

Response samples

Content type
application/json
{}

FiFo journal

The taxation FiFo journal of a transaction

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
integer

First part of transaction identifier

transaction_id
integer

Second part of transaction identifier

Responses

Response Schema: application/json
Array
opening_ta_id
integer <int64>
opening_transaction_id
integer <int64>
opening_isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
opening_dc
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

opening_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

opening_txkey_id
integer <int32>
opening_booking_date
string <date>
opening_price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

opening_price
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

closing_ta_id
integer <int64>
closing_transaction_id
integer <int64>
closing_dc
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

closing_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

closing_txkey_id
integer <int32>
closing_booking_date
string <date>
closing_price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

closing_price
string (signed_price_amount_value) ^(-)?[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

consuming_used_nominal
string (signed_security_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)

A securities amount with 6 decimal places and sign (omit if positive)

consuming_opening_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

consuming_opening_fee
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

consuming_closing_amount
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

consuming_closing_fee
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

consuming_pl
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

consuming_pl_type
string
Enum: "P" "Z" "S"
  • P: price difference * Z: opening or closing w/o price * S: short
consuming_usage_type
string
Enum: "F" "R" "C"
  • F: forward * R: reverting * C: closing
fund_tfq
string

Teilfreistellungsquote in decimal percent e.g. 0.30 and NOT 30

fund_opening_vap
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_00_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_00_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_15_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_15_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_30_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_30_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_60_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_60_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_80_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_opening_acc_pl_80_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_vap
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_00_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_00_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_15_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_15_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_30_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_30_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_60_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_60_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_80_p
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

fund_closing_acc_pl_80_z
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

Response samples

Content type
application/json
[
  • {
    }
]

Get the customer tax document

Get the customer tax document of a transaciton as PDF or its raw Json data

Authorizations:
oidc_headerbasicAuth
query Parameters
ta_id
required
integer <int64>

First part of transaciton identifier

transaction_id
required
integer <int64>

Second part of transaciton identifier

Responses

Response Schema:
One of
document_data
object
Array of objects (transaction_booked_tax_data)

Response samples

Content type
Example
{
  • "document_data": { },
  • "tax_data": [
    ]
}

Context menu for given data row

List of operation IDs to perform on given TID, posting, holding, or account

Authorizations:
oidc_headerbasicAuth
query Parameters
operation_id
required
string

The operation ID of the endpoint that produced the data row

entry_row
string

A specific data row (TID, posting, holding, or account)

account_number
string

Account number if applicable for more context

Responses

Response Schema: application/json
Array
string

An operation ID - transaction_get - transaction_reversal_post - correction_transaction_cash_post - failed_transaction_discard - open_positions_get - posting_comment_get - posting_comment_put - posting_comment_history_get - correction_transaction_cpd_post - correction_transaction_dates_post - biw_depotumsatz_securities_transfer_post - failed_transaction_retry - depot_account_number_activity_get - block_securities_post - unblock_securities_post - biw_depotumsatz_underlying_post - mt940_cpd_override_post - failed_transaction_revert_and_discard - transaction_comment_put - correction_transaction_01460_post - posting_close_session_get

Response samples

Content type
application/json
[
  • "string"
]

Posting templates for back-office

Back-office transaction posting templates and corrections

Post-qualify and book a failed securities transfer

Book a failed securities transfer with manually added account and amount

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

abrechnungsbetrag_eur_counter_account_number
required
string (account_number) <= 18 characters
in_out
required
string
Enum: "I" "O"
position: 3
abrechnungsbetrag_eur_amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
loan
required
boolean
position: 5

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "abrechnungsbetrag_eur_counter_account_number": "0000000012",
  • "in_out": "I",
  • "abrechnungsbetrag_eur_amount": "5877.78",
  • "loan": true
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Post-qualify and book a failed CA

Book a failed CA with manually added underlying ISIN and nominal

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

underlying_isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
underlying_nominal_nostro_dc
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

underlying_nominal_nostro
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "underlying_isin": "DE0007100000",
  • "underlying_nominal_nostro_dc": "D",
  • "underlying_nominal_nostro": "5877.78"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Block securities

Block securities of given ISIN, amount and depository

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_number
required
string (account_number) <= 18 characters
required
object (security_amount)
block_securities_reason_id
required
integer
position: 3

ID of the block reason as provided in GET /parameter_enums

subbalance_id
required
integer
position: 4

ID of the sub-balance as provided in GET /parameter_enums

date_to
required
string <date>
position: 5

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "account_number": "0000000012",
  • "security_amount": {
    },
  • "block_securities_reason_id": 0,
  • "subbalance_id": 0,
  • "date_to": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Un-block securities

Un-block a blocked position

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id
required
integer <int64>
position: 1
transaction_id
required
integer <int64>
position: 2

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Reverse and book new with exchanged 01460 account

Reverse given transaction, then book again with adjusted postings

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

account_number
required
string <= 18 characters
position: 2

The account number to use instead

subbalance_id
required
integer <int32>
position: 3

Sub-balance ID

debit_credit
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

amount
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
reason
string <= 140 characters
position: 7

Reason for reversal and new booking

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "account_number": "string",
  • "subbalance_id": 0,
  • "debit_credit": "D",
  • "amount": "string",
  • "isin": "DE0007100000",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Book accrual

Book out cash amount on given date and book it in again

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_number
required
string <= 18 characters
position: 1

Account number of the posting account

booking_date_out
required
string <date>
position: 2

Booking date for booking out

booking_date_in
required
string <date>
position: 3

Booking date for booking in

value_date
string <date>
position: 4

optional value date

transaction_datetime
string <date-time>
position: 5

Optionally a transaction datetime

subbalance
required
string <= 80 characters
position: 6

If needed, subbalance for the account

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
currency
required
string
position: 9

The currency

debit_credit_in
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

posting_text
string <= 140 characters
position: 11

Optionally a posting text

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "account_number": "string",
  • "booking_date_out": "2019-08-24",
  • "booking_date_in": "2019-08-24",
  • "value_date": "2019-08-24",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "subbalance": "string",
  • "isin": "DE0007100000",
  • "amount": "5877.78",
  • "currency": "string",
  • "debit_credit_in": "D",
  • "posting_text": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Reverse and book new with edited cash postings

Reverse given transaction, then book again with adjusted postings as given

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

required
Array of objects (correction_transaction_cash_posting)

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "cash_postings": [
    ]
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Reverse and book new with exchanged CPD account

Reverse given transaction, then book again with adjusted postings

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

account_number
required
string <= 18 characters
position: 2

The account number to use instead

subbalance_id
required
integer <int32>
position: 3

Sub-balance ID

debit_credit
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

amount
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
reason
string <= 140 characters
position: 7

Reason for reversal and new booking

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "account_number": "string",
  • "subbalance_id": 0,
  • "debit_credit": "D",
  • "amount": "string",
  • "isin": "DE0007100000",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Reverse and book new with changed date and time

Reverse given transaction, then book again with adjusted postings

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

value_date
required
string <date>
position: 2

New value date

transaction_datetime
required
string <date-time>
position: 3

New transaction timestamp

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "value_date": "2019-08-24",
  • "transaction_datetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Manual P/L booking

Book money between manual P/L accounts

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
booking_date
required
string <date>
position: 1

Booking date

value_date
required
string <date>
position: 2

Value date

transaction_datetime
required
string <date-time>
position: 3

Transaction datetime

currency
required
string
position: 4

The currency

account_number_from
required
string <= 18 characters
position: 5

Account number from

account_number_to
required
string <= 18 characters
position: 6

Account number to

debit_credit_from
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

debit_credit_to
required
string (debit_credit)
Enum: "D" "C"

Debit/credit indicator

amount_to
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

subbalance
string <= 80 characters
position: 10

If needed, subbalance for the accounts

isin
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
posting_text
string <= 140 characters
position: 12

Optionally a posting text

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "booking_date": "2019-08-24",
  • "value_date": "2019-08-24",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "account_number_from": "string",
  • "account_number_to": "string",
  • "debit_credit_from": "D",
  • "debit_credit_to": "D",
  • "amount_to": "string",
  • "subbalance": "string",
  • "isin": "DE0007100000",
  • "posting_text": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Daily closeout

Trigger the daily closeout process

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
date_of_day
required
string <date>
position: 1

As of date

override
boolean
position: 2

Overwriting of a previous closeout has to be requested speficifcally

Responses

Request samples

Content type
application/json
{
  • "date_of_day": "2019-08-24",
  • "override": true
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Create daily reports

Create and send RPT022 and RPT025 to configured receivers

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
date_from_rpt22
required
string <date>
position: 1

Start date for RPT022

date_to_rpt22
required
string <date>
position: 2

End date for RPT022

date_rpt25
required
string <date>
position: 3

End date for RPT025

Responses

Request samples

Content type
application/json
{
  • "date_from_rpt22": "2019-08-24",
  • "date_to_rpt22": "2019-08-24",
  • "date_rpt25": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Send cash from customer account

Send cash from one customer account to any another account

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
debtor_account
required
string (account_number) <= 18 characters
required
object (amount)
creditor_account
required
string (account_number) <= 18 characters
creditor_name
required
string (creditor_name) <= 70 characters

Creditor Name

remittance_information_unstructured
string (remittance_information_unstructured) <= 140 characters

Unstructured remittance information

end_to_end_identification
string <= 35 characters
position: 6

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "debtor_account": "0000000012",
  • "instructed_amount": {
    },
  • "creditor_account": "0000000012",
  • "creditor_name": "Creditor Name",
  • "remittance_information_unstructured": "Ref Number Merchant",
  • "end_to_end_identification": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Charge a standalone fee

Charge a customer account with a standalone fee

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$

Account number of the customer's cash account

security_account_number
string <= 18 characters ^[0-9]{1,18}$

Account number of the customers's securities account

total_fee_amount
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

total_fee_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

remittance_text
required
string <= 140 characters

Remittance information

value_date
string <date>

Value date

required
Array of objects (fee_amount) non-empty

The fee amount or a breakdown into multiple fee amounts

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "cash_account_number": "string",
  • "security_account_number": "string",
  • "total_fee_amount": "string",
  • "total_fee_currency": "CAD",
  • "remittance_text": "string",
  • "value_date": "2019-08-24",
  • "fee_amounts": [
    ]
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Send cash internally

Send cash between a system account and a customer or system account

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
current_account
required
string (account_number_or_memo) <= 18 characters
creditor_account
required
string (account_number_or_memo) <= 18 characters
required
object (amount)
remittance_information
required
string (remittance_information_unstructured) <= 140 characters

Unstructured remittance information

value_date
string <date>
position: 5

Optionally a value date different from the default date

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "current_account": "0000000012",
  • "creditor_account": "0000000012",
  • "instructed_amount": {
    },
  • "remittance_information": "Ref Number Merchant",
  • "value_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

book out KESt and KiSt

book out KESt and KiSt for month

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
identifier
required
string [ 6 .. 7 ] characters
position: 1

year and month for which the KESt-Anmeldung should be created

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "identifier": "2024/1"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

reverse and then book new

reverse all interest settlement at and after given date, then book new

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_number
required
string <= 18 characters
position: 1

account number of a customer cash account

end_date
required
string <date>
position: 2

date of earliest interest settlement to repeat

Responses

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "account_number": "string",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "approval_request_id": 0,
  • "error_code": 0,
  • "error_text": "string"
}

create gl export

create new gl export or gl export simulation

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
as_of_date
required
string <date>
position: 1

posting date to be considered for gl export

simulation
required
boolean
Default: false
position: 2

if TRUE, then only data creation and download option for internal use, no export

overwrite
required
boolean
Default: false
position: 3

if TRUE, then new creation of gl export, even if it already has been created and exported previously

overwrite_reason
string <= 255 characters
position: 4

optionally a free text explaining why new gl export is created

Responses

Request samples

Content type
application/json
{
  • "as_of_date": "2019-08-24",
  • "simulation": false,
  • "overwrite": false,
  • "overwrite_reason": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create gl export delta correction

create gl export delta correction as new minus old state (optionally as simulation)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ref_gl_export_header_id
required
integer <int64>
position: 1

ID of the reference GL export (the old GL export)

simulation
required
boolean
Default: false
position: 2

if TRUE, then only data creation and download option for internal use, no export

Responses

Request samples

Content type
application/json
{
  • "ref_gl_export_header_id": 0,
  • "simulation": false
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

create meldewesen file

send report22 and 25 to configured receivers

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
meldedatum
required
string <date>
position: 1
override
boolean
position: 2

override of async task, in case it was already triggered today

Responses

Request samples

Content type
application/json
{
  • "meldedatum": "2019-08-24",
  • "override": true
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Verlustbescheinigung erstellen

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

discard a previously failed transaction

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

comment
required
string <= 255 characters
position: 2

free text explaining the action

Responses

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

discard a previously failed transaction and revert manually

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id_revert
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

booking_date
required
string <date>

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id_revert": "string",
  • "ta_id_transaction_id": "string",
  • "booking_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

re-trigger a previously failed transaction

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

Responses

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

book a previously failed MT940 transaction to CPD

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

comment
string <= 255 characters
position: 2

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

close open postings on commission cash and security accounts

Authorizations:
oidc_headerbasicAuth

Responses

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

record a loan trade

record a loan trade

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
nostro_security_account
required
string (account_number) <= 18 characters
cash_account
required
string (account_number) <= 18 characters
value_date
required
string <date>
position: 3
transaction_datetime
required
string <date-time>
position: 4
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
quantity
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78
currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

settled_amount
required
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
buy_sell
required
string = 1 characters
Enum: "B" "S"
position: 9
accrued_interest_amount
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
posting_text
string <= 140 characters
position: 11

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "nostro_security_account": "0000000012",
  • "cash_account": "0000000012",
  • "value_date": "2019-08-24",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "isin": "DE0007100000",
  • "quantity": "5877.78",
  • "currency": "CAD",
  • "settled_amount": "5877.78",
  • "buy_sell": "B",
  • "accrued_interest_amount": "5877.78",
  • "posting_text": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

manual security transfer in

manual booking of security transfer in

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
security_account_number
required
string (account_number) <= 18 characters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
nominal
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78
transaction_datetime
required
string <date-time>
position: 4
depository
required
string <= 80 characters
Enum: "ALF" "CBF" "CBL"
position: 5
required
Array of objects (price_detail)
position: 6
transfer_type
required
string
Enum: "E" "U"
position: 7

entgeltlich, unentgeltlich

subrogation
required
boolean
position: 8

subrogation indicator

asset_type
string
Enum: "P" "B"
position: 9

Privatvermögen, Betriebsvermögen

transfer_specific_type
string
Enum: "E" "S"
position: 10

Erbschaft, Schenkung

transfer_unit
string = 3 characters
position: 11

XXX or ISO code

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "security_account_number": "0000000012",
  • "isin": "DE0007100000",
  • "nominal": "5877.78",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "depository": "ALF",
  • "price_details": [
    ],
  • "transfer_type": "E",
  • "subrogation": true,
  • "asset_type": "P",
  • "transfer_specific_type": "E",
  • "transfer_unit": "str"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

manual security transfer out

manual booking of security transfer out

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
security_account_number
required
string (account_number) <= 18 characters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
nominal
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78
transaction_datetime
required
string <date-time>
position: 4
depository
required
string <= 80 characters
Enum: "ALF" "CBF" "CBL"
position: 5
price
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

price_fx_rate
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

transfer_type
required
string
Enum: "E" "U"
position: 9

entgeltlich, unentgeltlich

subrogation
required
boolean
position: 10

subrogation indicator

transfer_specific_type
string
Enum: "E" "S"
position: 11

Erbschaft, Schenkung

receiver_security_account_number
required
string <= 35 characters
position: 12
receiver_bic
required
string <= 11 characters
position: 13
receiver_kv_nr
required
string <= 5 characters
position: 14
receiver_classification
required
string
Enum: "C" "S" "R" "O"
position: 15
  • C - client (Auftraggeber)
  • S - spouse (Ehe/Lebenspartner)
  • R - related (verwandt)
  • O - other (Sonstiges)
required
object (security_transfer_out_receiver)
object (security_transfer_out_receiver)

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "security_account_number": "0000000012",
  • "isin": "DE0007100000",
  • "nominal": "5877.78",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "depository": "ALF",
  • "price": "5877.78",
  • "price_currency": "CAD",
  • "price_fx_rate": "5877.78",
  • "transfer_type": "E",
  • "subrogation": true,
  • "transfer_specific_type": "E",
  • "receiver_security_account_number": "string",
  • "receiver_bic": "string",
  • "receiver_kv_nr": "strin",
  • "receiver_classification": "C",
  • "receiver1": {
    },
  • "receiver2": {
    }
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Order execution

Buy or sell ICF stocks against payment

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
client_id
required
string <uuid>
position: 1

External ID of the client/customer

cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$
position: 2

Account number of the client's cash account

security_depot_number
required
string <= 18 characters ^[0-9]{1,18}$
position: 3

Account number of the client's securities account

isin
required
string[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}
position: 4

ISIN

short_code
required
string <= 128 characters
position: 5

Ticker symbol (purely informational)

instrument_name
required
string <= 128 characters
position: 6

Name of the instrument (purely informational)

instrument_type
required
string
Enum: "stocks" "warrants" "bonds" "fonds" "etf_or_etc" "index" "unknown"
position: 7

The type of the instrument

  • stocks - stocks
  • warrants - warrants
  • bonds - bonds
  • fonds - fonds
  • etf_or_etc - ETF or ETC
  • index - index
  • unknown - unknown (we do not expect to receive that value)
side
required
string
Enum: "BUY" "SELL"
position: 8

Buy/sell indicator

executed_quantity
required
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)
position: 9

Executed quantity to be booked to the seucrities account. Has 6 decimal points.

price_amount
required
string[0-9]{1,10}(\.[0-9]{1,6})?
format: numeric(16,6)
position: 10

Price. Has 6 decimal points.

price_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

total_fee_amount
required
string[0-9]{1,13}(\.[0-9]{1,2})?
format: numeric(15,2)
position: 12

Total fee amount. Has 2 decimal points.

total_fee_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

transaction_datetime
required
string <date-time>
position: 14

Date and time the order was executed

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
Example
{
  • "client_id": "bee36373-4ce7-4876-8cfa-c49613950531",
  • "cash_account_number": "2100500488",
  • "security_depot_number": "2100500496",
  • "isin": "US0231351067",
  • "short_code": "AMZ",
  • "instrument_name": "AMAZON.COM INC.",
  • "instrument_type": "stocks",
  • "side": "BUY",
  • "executed_quantity": "8",
  • "price_amount": "180.12",
  • "price_currency": "EUR",
  • "total_fee_amount": "1.",
  • "total_fee_currency": "EUR",
  • "transaction_datetime": "2024-07-08T11:22:33+00:00"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Comment a transaction

Add a free text comment to a transaction (append)

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

comment
required
string <= 255 characters
position: 2

Free text

Responses

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "error_text": "string"
}

Reverse a transaction

Book a transaction reversal

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id_transaction_id
required
string (combined_ta_id_transaction_id) ^[0-9]+\/[0-9]+$

First and second part of transaction identifier

booking_date
required
string <date>
position: 2

Booking date of the reversal may differ from the original booking date

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id_transaction_id": "string",
  • "booking_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Posting templates for customers

Customer account transaction posting templates

Block securities

Block securities of given ISIN, amount and depository

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_number
required
string (account_number) <= 18 characters
required
object (security_amount)
block_securities_reason_id
required
integer
position: 3

ID of the block reason as provided in GET /parameter_enums

subbalance_id
required
integer
position: 4

ID of the sub-balance as provided in GET /parameter_enums

date_to
required
string <date>
position: 5

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "account_number": "0000000012",
  • "security_amount": {
    },
  • "block_securities_reason_id": 0,
  • "subbalance_id": 0,
  • "date_to": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Un-block securities

Un-block a blocked position

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
ta_id
required
integer <int64>
position: 1
transaction_id
required
integer <int64>
position: 2

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Send cash from customer account

Send cash from one customer account to any another account

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
debtor_account
required
string (account_number) <= 18 characters
required
object (amount)
creditor_account
required
string (account_number) <= 18 characters
creditor_name
required
string (creditor_name) <= 70 characters

Creditor Name

remittance_information_unstructured
string (remittance_information_unstructured) <= 140 characters

Unstructured remittance information

end_to_end_identification
string <= 35 characters
position: 6

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "debtor_account": "0000000012",
  • "instructed_amount": {
    },
  • "creditor_account": "0000000012",
  • "creditor_name": "Creditor Name",
  • "remittance_information_unstructured": "Ref Number Merchant",
  • "end_to_end_identification": "string"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Charge a standalone fee

Charge a customer account with a standalone fee

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
cash_account_number
required
string <= 18 characters ^[0-9]{1,18}$

Account number of the customer's cash account

security_account_number
string <= 18 characters ^[0-9]{1,18}$

Account number of the customers's securities account

total_fee_amount
required
string (signed_money_amount_value) ^(-)?[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)

A money amount with 2 decimal places and sign (omit if positive)

total_fee_currency
required
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

remittance_text
required
string <= 140 characters

Remittance information

value_date
string <date>

Value date

required
Array of objects (fee_amount) non-empty

The fee amount or a breakdown into multiple fee amounts

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "cash_account_number": "string",
  • "security_account_number": "string",
  • "total_fee_amount": "string",
  • "total_fee_currency": "CAD",
  • "remittance_text": "string",
  • "value_date": "2019-08-24",
  • "fee_amounts": [
    ]
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

Send cash from ones own account

Send cash from ones own account to any other account, email address or IBAN. If the email address is not linked to a user account, in invitation is send out.

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
debtorAccount
required
string (account_number) <= 18 characters
required
object (amount)
required
object (account_identification)
creditorName
required
string (creditor_name) <= 70 characters

Creditor Name

remittanceInformationUnstructured
string (remittance_information_unstructured) <= 140 characters

Unstructured remittance information

favorite_id
integer <int64> (id_number)

An internal ID

save_new_favorite
boolean
Default: false
position: 7

If TRUE then the current request data is stored if

  • the current request is accepted
  • the favorite_id is not set If the parameter favorite_name is set, its value will be used
favorite_name
string (favorite_name) <= 80 characters

user given name for the favorite, of nothing was set, it will be created by the system

request_money
object (request_money_identifier)

tuple which identifies a request-money request

tip
string (money_amount_value) ^[0-9]{1,13}(\.[0-9]{1,2})?$
format: numeric(15,2)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 13 significant figures. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • 5877.78
callback_url
string <uri>
position: 11

URL to notify after the transaction was successfully executed

external_reference
string <uuid> (external_reference)

External reference as provided by the initiaing application

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "debtorAccount": "0000000012",
  • "instructedAmount": {
    },
  • "creditorAccount": {
    },
  • "creditorName": "Creditor Name",
  • "remittanceInformationUnstructured": "Ref Number Merchant",
  • "favorite_id": 0,
  • "save_new_favorite": false,
  • "favorite_name": "monthly payment #3",
  • "request_money": { },
  • "tip": "5877.78",
  • "callback_url": "http://example.com",
  • "external_reference": "ff6b6877-0d9b-4d38-88cb-b406b386003e"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

reverse and then book new

reverse all interest settlement at and after given date, then book new

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
account_number
required
string <= 18 characters
position: 1

account number of a customer cash account

end_date
required
string <date>
position: 2

date of earliest interest settlement to repeat

Responses

Response Schema: application/json
approval_request_id
required
integer <int64>
error_code
required
integer <int64>
error_text
required
string <= 255 characters

Request samples

Content type
application/json
{
  • "account_number": "string",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "approval_request_id": 0,
  • "error_code": 0,
  • "error_text": "string"
}

manual security transfer in

manual booking of security transfer in

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
security_account_number
required
string (account_number) <= 18 characters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
nominal
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78
transaction_datetime
required
string <date-time>
position: 4
depository
required
string <= 80 characters
Enum: "ALF" "CBF" "CBL"
position: 5
required
Array of objects (price_detail)
position: 6
transfer_type
required
string
Enum: "E" "U"
position: 7

entgeltlich, unentgeltlich

subrogation
required
boolean
position: 8

subrogation indicator

asset_type
string
Enum: "P" "B"
position: 9

Privatvermögen, Betriebsvermögen

transfer_specific_type
string
Enum: "E" "S"
position: 10

Erbschaft, Schenkung

transfer_unit
string = 3 characters
position: 11

XXX or ISO code

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "security_account_number": "0000000012",
  • "isin": "DE0007100000",
  • "nominal": "5877.78",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "depository": "ALF",
  • "price_details": [
    ],
  • "transfer_type": "E",
  • "subrogation": true,
  • "asset_type": "P",
  • "transfer_specific_type": "E",
  • "transfer_unit": "str"
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}

manual security transfer out

manual booking of security transfer out

Authorizations:
oidc_headerbasicAuth
Request Body schema: application/json
security_account_number
required
string (account_number) <= 18 characters
isin
required
string (isin) ^[A-za-z]{2}[0-9A-Za-z]{9}[0-9]{1}$
nominal
required
string (security_amount_value) ^[0-9]{1,13}(\.[0-9]{1,6})?$
format: numeric(19,6)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are:

  • 1056
  • 5768.2
  • -1.50
  • 5877.78
transaction_datetime
required
string <date-time>
position: 4
depository
required
string <= 80 characters
Enum: "ALF" "CBF" "CBL"
position: 5
price
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

price_currency
string (iso4217_currency) = 3 characters
Enum: "CAD" "CHF" "EUR" "GBP" "JPY" "USD"

ISO 4217 currency code

price_fx_rate
string (price_amount_value) ^[0-9]{1,10}(\.[0-9]{1,15})?$
format: numeric(25,15)
minimum: 0.00

The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot.

transfer_type
required
string
Enum: "E" "U"
position: 9

entgeltlich, unentgeltlich

subrogation
required
boolean
position: 10

subrogation indicator

transfer_specific_type
string
Enum: "E" "S"
position: 11

Erbschaft, Schenkung

receiver_security_account_number
required
string <= 35 characters
position: 12
receiver_bic
required
string <= 11 characters
position: 13
receiver_kv_nr
required
string <= 5 characters
position: 14
receiver_classification
required
string
Enum: "C" "S" "R" "O"
position: 15
  • C - client (Auftraggeber)
  • S - spouse (Ehe/Lebenspartner)
  • R - related (verwandt)
  • O - other (Sonstiges)
required
object (security_transfer_out_receiver)
object (security_transfer_out_receiver)

Responses

Response Schema: application/json
ta_id
required
integer <int64>

First part of the TID ("T"ransaction "A"ccount)

transaction_id
required
integer <int64>

Second part of the TID

creditor_person_id
integer <int64>

If applicable the ID of the creditor person

Request samples

Content type
application/json
{
  • "security_account_number": "0000000012",
  • "isin": "DE0007100000",
  • "nominal": "5877.78",
  • "transaction_datetime": "2019-08-24T14:15:22Z",
  • "depository": "ALF",
  • "price": "5877.78",
  • "price_currency": "CAD",
  • "price_fx_rate": "5877.78",
  • "transfer_type": "E",
  • "subrogation": true,
  • "transfer_specific_type": "E",
  • "receiver_security_account_number": "string",
  • "receiver_bic": "string",
  • "receiver_kv_nr": "strin",
  • "receiver_classification": "C",
  • "receiver1": {
    },
  • "receiver2": {
    }
}

Response samples

Content type
application/json
{
  • "ta_id": 0,
  • "transaction_id": 0,
  • "creditor_person_id": 0
}