User Person
Get a specific person.
The standard HTTP Cache-Control header is required for all signed requests.
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.
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.
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.
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.
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.
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
Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page.
GET /v1/user-person/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
{
"id": 1,
"created": "text",
"updated": "text",
"public_uuid": "text",
"first_name": "text",
"middle_name": "text",
"last_name": "text",
"legal_name": "text",
"display_name": "text",
"public_nick_name": "text",
"alias": [
{
"type": "text",
"value": "text",
"name": "text"
}
],
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text",
"id": 1
}
],
"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
},
"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
},
"date_of_birth": "text",
"place_of_birth": "text",
"country_of_birth": "text",
"nationality": "text",
"all_nationality": [
"text"
],
"language": "text",
"region": "text",
"gender": "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",
"status": "text",
"sub_status": "text",
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "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
}
]
}
]
}Modify a specific person object's data.
The standard HTTP Cache-Control header is required for all signed requests.
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.
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.
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.
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.
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.
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
The subscription type the user should start on.
The person's first name.
The person's middle name.
The person's last name.
The public nick name for the person.
The public UUID of the user's avatar.
The type of identification document the person registered with.
The identification document number the person registered with.
The country which issued the identification document the person registered with.
The reference to the uploaded picture/scan of the front side of the identification document.
The reference to the uploaded picture/scan of the back side of the identification document.
The person's date of birth. Accepts ISO8601 date formats.
The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.
All of the person's nationalities.
The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.
The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.
The person's gender. Can be MALE, FEMALE or UNKNOWN.
The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.
The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.
The setting for the session timeout of the user in seconds.
The display name for the person.
The type of signup track the user is following.
The id of the modified person object.
The timestamp of the person object's creation.
The timestamp of the person object's last update.
The person's public UUID.
The person's legal name.
The person's place of birth.
The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.
The version of the terms of service accepted by the user.
Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page.
PUT /v1/user-person/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 1067
{
"subscription_type": "text",
"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"
},
"address_postal": {
"street": "text",
"house_number": "text",
"po_box": "text",
"postal_code": "text",
"city": "text",
"country": "text",
"extra": "text",
"mailbox_name": "text"
},
"avatar_uuid": "text",
"tax_resident": [
{
"country": "text",
"tax_number": "text",
"status": "text"
}
],
"document_type": "text",
"document_number": "text",
"document_country_of_issuance": "text",
"document_front_attachment_id": 1,
"document_back_attachment_id": 1,
"date_of_birth": "text",
"nationality": "text",
"all_nationality": [
"text"
],
"language": "text",
"region": "text",
"gender": "text",
"status": "text",
"sub_status": "text",
"legal_guardian_alias": {
"type": "text",
"value": "text",
"name": "text",
"service": "text"
},
"session_timeout": 1,
"daily_limit_without_confirmation_login": {
"value": "text",
"currency": "text"
},
"display_name": "text",
"signup_track_type": "text"
}{
"id": 1
}Last updated
Was this helpful?