Retrieving my user details
In the previous chapter you already requested a session and as a response received the user object. If you saved that in your app you already have a reference to who your user is. The most important item to keep track of is the userid. As that's what we'll need in the next few steps.
What we have done so far
We have created a sandbox user, and generated an API key
We have created a installation and registered a device
We generated a session and now know the user ID and Session token
In the next chapter we'll use these to make our API calls
Who is my user, and what is his current balance?
To retrieve our user we simply can do a API call to the user endpoint and this will return us our current user. We already had this information from the previous step. The important thing to save here is the user ID. We'll need to pass it as a url parameter in the next calls.
get
Get a collection of all available users.
Header parameters
Cache-ControlstringOptional
The standard HTTP Cache-Control header is required for all signed requests.
User-AgentstringRequired
The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.
X-Bunq-LanguagestringOptional
The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.
X-Bunq-RegionstringOptional
The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.
X-Bunq-Client-Request-IdstringOptional
This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.
X-Bunq-GeolocationstringOptional
This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.
X-Bunq-Client-AuthenticationstringRequired
The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call
Responses
200
Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints.
application/json
400
This is how the error response looks like for 4XX response codes
application/json
get
GET /v1/user HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
[
{
"UserPerson": {
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
],
"date_of_birth": "text",
"nationality": "text",
"all_nationality": [
"text"
],
"language": "text",
"region": "text",
"gender": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"display_name": "text",
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"legal_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"place_of_birth": "text",
"country_of_birth": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"version_terms_of_service": "text",
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
]
},
"UserCompany": {
"name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"language": "text",
"region": "text",
"country": "text",
"ubo": [
{
"name": "text",
"date_of_birth": "text",
"nationality": "text"
}
],
"chamber_of_commerce_number": "text",
"legal_form": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"display_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"type_of_business_entity": "text",
"sector_of_industry": "text",
"counter_bank_iban": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"version_terms_of_service": "text",
"directors": [
{
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
}
],
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"customer": {
"billing_account_id": "text",
"invoice_notification_preference": "text",
"id": 1,
"created": "text",
"updated": "text"
},
"customer_limit": {
"limit_monetary_account": 1,
"limit_monetary_account_remaining": 1,
"limit_card_debit_maestro": 1,
"limit_card_debit_mastercard": 1,
"limit_card_debit_wildcard": 1,
"limit_card_wildcard": 1,
"limit_card_replacement": 1,
"limit_amount_monthly": {
"value": "text",
"currency": "text"
},
"spent_amount_monthly": {
"value": "text",
"currency": "text"
}
},
"billing_contract": [
{
"subscription_type": "text",
"id": 1,
"created": "text",
"updated": "text",
"contract_date_start": "text",
"contract_date_end": "text",
"contract_version": 1,
"subscription_type_downgrade": "text",
"status": "text",
"sub_status": "text"
}
],
"deny_reason": "text",
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
],
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
]
},
"UserApiKey": {
"id": 1,
"created": "text",
"updated": "text",
"requested_by_user": {
"UserPerson": {
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
],
"date_of_birth": "text",
"nationality": "text",
"all_nationality": [
"text"
],
"language": "text",
"region": "text",
"gender": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"display_name": "text",
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"legal_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"place_of_birth": "text",
"country_of_birth": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"version_terms_of_service": "text",
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
]
},
"UserCompany": {
"name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"language": "text",
"region": "text",
"country": "text",
"ubo": [
{
"name": "text",
"date_of_birth": "text",
"nationality": "text"
}
],
"chamber_of_commerce_number": "text",
"legal_form": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"display_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"type_of_business_entity": "text",
"sector_of_industry": "text",
"counter_bank_iban": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"version_terms_of_service": "text",
"directors": [
{
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
}
],
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"customer": {
"billing_account_id": "text",
"invoice_notification_preference": "text",
"id": 1,
"created": "text",
"updated": "text"
},
"customer_limit": {
"limit_monetary_account": 1,
"limit_monetary_account_remaining": 1,
"limit_card_debit_maestro": 1,
"limit_card_debit_mastercard": 1,
"limit_card_debit_wildcard": 1,
"limit_card_wildcard": 1,
"limit_card_replacement": 1,
"limit_amount_monthly": {
"value": "text",
"currency": "text"
},
"spent_amount_monthly": {
"value": "text",
"currency": "text"
}
},
"billing_contract": [
{
"subscription_type": "text",
"id": 1,
"created": "text",
"updated": "text",
"contract_date_start": "text",
"contract_date_end": "text",
"contract_version": 1,
"subscription_type_downgrade": "text",
"status": "text",
"sub_status": "text"
}
],
"deny_reason": "text",
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
],
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
]
},
"UserPaymentServiceProvider": {
"id": 1,
"created": "text",
"updated": "text",
"certificate_distinguished_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"status": "text",
"sub_status": "text",
"public_uuid": "text",
"display_name": "text",
"public_nick_name": "text",
"language": "text",
"region": "text",
"session_timeout": 1
}
},
"granted_by_user": {
"UserPerson": {
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
],
"date_of_birth": "text",
"nationality": "text",
"all_nationality": [
"text"
],
"language": "text",
"region": "text",
"gender": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"display_name": "text",
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"legal_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"place_of_birth": "text",
"country_of_birth": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"version_terms_of_service": "text",
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
]
},
"UserCompany": {
"name": "text",
"public_nick_name": "text",
"address_main": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"language": "text",
"region": "text",
"country": "text",
"ubo": [
{
"name": "text",
"date_of_birth": "text",
"nationality": "text"
}
],
"chamber_of_commerce_number": "text",
"legal_form": "text",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"display_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"type_of_business_entity": "text",
"sector_of_industry": "text",
"counter_bank_iban": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"address_shipping": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text",
"province": "text",
"is_user_address_updated": true
},
"version_terms_of_service": "text",
"directors": [
{
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
}
],
"notification_filters": [
{
"notification_delivery_method": "text",
"notification_target": "text",
"category": "text"
}
],
"customer": {
"billing_account_id": "text",
"invoice_notification_preference": "text",
"id": 1,
"created": "text",
"updated": "text"
},
"customer_limit": {
"limit_monetary_account": 1,
"limit_monetary_account_remaining": 1,
"limit_card_debit_maestro": 1,
"limit_card_debit_mastercard": 1,
"limit_card_debit_wildcard": 1,
"limit_card_wildcard": 1,
"limit_card_replacement": 1,
"limit_amount_monthly": {
"value": "text",
"currency": "text"
},
"spent_amount_monthly": {
"value": "text",
"currency": "text"
}
},
"billing_contract": [
{
"subscription_type": "text",
"id": 1,
"created": "text",
"updated": "text",
"contract_date_start": "text",
"contract_date_end": "text",
"contract_version": 1,
"subscription_type_downgrade": "text",
"status": "text",
"sub_status": "text"
}
],
"deny_reason": "text",
"relations": [
{
"user_id": "text",
"counter_user_id": "text",
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"counter_label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"relationship": "text",
"status": "text",
"user_status": "text",
"counter_user_status": "text",
"company_employee_setting_adyen_card_transaction": {
"status": "text",
"monetary_account_payout_id": 1
},
"all_company_employee_card": [
{
"company_name_on_card": "text",
"amount_limit_monthly": {
"value": "text",
"currency": "text"
},
"status": "text",
"card": {
"status": "text",
"order_status": "text",
"card_limit": {
"value": "text",
"currency": "text"
},
"card_limit_atm": {
"value": "text",
"currency": "text"
},
"country_permission": [
{
"country": "text",
"id": 1
}
],
"pin_code_assignment": [
{
"type": "text",
"routing_type": "text",
"monetary_account_id": 1,
"status": "text"
}
],
"primary_account_numbers": [
{
"id": 1,
"description": "text",
"status": "text",
"monetary_account_id": 1,
"uuid": "text",
"four_digit": "text",
"type": "text"
}
],
"monetary_account_id_fallback": 1,
"preferred_name_on_card": "text",
"second_line": "text"
},
"amount_spent_monthly": {
"value": "text",
"currency": "text"
},
"number_of_company_employee_card_receipt_pending": 1
}
]
}
],
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
]
},
"UserPaymentServiceProvider": {
"id": 1,
"created": "text",
"updated": "text",
"certificate_distinguished_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"status": "text",
"sub_status": "text",
"public_uuid": "text",
"display_name": "text",
"public_nick_name": "text",
"language": "text",
"region": "text",
"session_timeout": 1
}
}
},
"UserPaymentServiceProvider": {
"id": 1,
"created": "text",
"updated": "text",
"certificate_distinguished_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"status": "text",
"sub_status": "text",
"public_uuid": "text",
"display_name": "text",
"public_nick_name": "text",
"language": "text",
"region": "text",
"session_timeout": 1
}
}
]So, what is the balance of our user?
We'll we need just one more step that is to call the monetary-account-bank endpoint. This endpoint lists all monetary accounts we know for this user. The response contains a list of monetary accounts.
Take note of the monetary account ID, most of the API calls reference both the user ID as well as the ID of the thing you are performing your actions on. To answer the question: what is the balance of our user. You can see that the newly created user comes with 1 monetary account, with a balance of €0.00. Let's add some money to the account!
"Response": [
{
"MonetaryAccountBank": {
"id": 2026814,
"created": "2025-03-05 16:12:01.255073",
"updated": "2025-03-05 16:12:01.255073",
... more key value pairs ...
}
"balance": {
"currency": "EUR",
"value": "0.00"
},
}
]get
Gets a listing of all MonetaryAccountBanks of a given user.
Path parameters
userIDintegerRequired
Header parameters
Cache-ControlstringOptional
The standard HTTP Cache-Control header is required for all signed requests.
User-AgentstringRequired
The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.
X-Bunq-LanguagestringOptional
The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.
X-Bunq-RegionstringOptional
The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.
X-Bunq-Client-Request-IdstringOptional
This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.
X-Bunq-GeolocationstringOptional
This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.
X-Bunq-Client-AuthenticationstringRequired
The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call
Responses
200
With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.
Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
application/json
400
This is how the error response looks like for 4XX response codes
application/json
get
GET /v1/user/{userID}/monetary-account-bank HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
[
{
"id": 1,
"created": "text",
"updated": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"currency": "text",
"description": "text",
"daily_limit": {
"value": "text",
"currency": "text"
},
"overdraft_limit": {
"value": "text",
"currency": "text"
},
"balance": {
"value": "text",
"currency": "text"
},
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"public_uuid": "text",
"status": "text",
"sub_status": "text",
"reason": "text",
"reason_description": "text",
"user_id": 1,
"monetary_account_profile": {
"profile_fill": {
"status": "text",
"balance_preferred": {
"value": "text",
"currency": "text"
},
"balance_threshold_low": {
"value": "text",
"currency": "text"
},
"issuer": {
"bic": "text",
"name": "text"
}
},
"profile_drain": {
"status": "text",
"balance_preferred": {
"value": "text",
"currency": "text"
},
"balance_threshold_high": {
"value": "text",
"currency": "text"
},
"savings_account_alias": {
"iban": "text",
"display_name": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"label_user": {
"uuid": "text",
"display_name": "text",
"country": "text",
"avatar": {
"uuid": "text",
"anchor_uuid": "text",
"image": [
{
"attachment_public_uuid": "text",
"content_type": "text",
"height": 1,
"width": 1
}
],
"style": "text"
},
"public_nick_name": "text"
},
"country": "text",
"bunq_me": {
"type": "text",
"value": "text",
"name": "text"
},
"is_light": true,
"swift_bic": "text",
"swift_account_number": "text",
"transferwise_account_number": "text",
"transferwise_bank_code": "text",
"merchant_category_code": "text"
}
}
},
"display_name": "text",
"setting": {
"color": "text",
"icon": "text",
"default_avatar_status": "text",
"restriction_chat": "text",
"sdd_expiration_action": "text"
},
"all_auto_save_id": [
{
"id": 1
}
]
}
]Last updated
Was this helpful?