Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
user-person

Modify a specific person object's data.

put/user-person/{itemId}

Path parameters

itemIdinteger required

Headers

Cache-Controlstring

The standard HTTP Cache-Control header is required for all signed requests.

User-Agentstring required

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-Languagestring

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-Regionstring

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-Idstring

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-Geolocationstring

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-Authenticationstring required

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

Request body

subscription_typestring

The subscription type the user should start on.

first_namestring

The person's first name.

middle_namestring

The person's middle name.

last_namestring

The person's last name.

public_nick_namestring

The public nick name for the person.

avatar_uuidstring

The public UUID of the user's avatar.

document_typestring

The type of identification document the person registered with.

document_numberstring

The identification document number the person registered with.

document_country_of_issuancestring

The country which issued the identification document the person registered with.

document_front_attachment_idinteger

The reference to the uploaded picture/scan of the front side of the identification document.

document_back_attachment_idinteger

The reference to the uploaded picture/scan of the back side of the identification document.

date_of_birthstring

The person's date of birth. Accepts ISO8601 date formats.

nationalitystring

The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.

all_nationalitystring[]

All of the person's nationalities.

languagestring

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.

regionstring

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.

genderstring

The person's gender. Can be MALE, FEMALE or UNKNOWN.

statusstring

The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.

sub_statusstring

The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.

session_timeoutinteger

The setting for the session timeout of the user in seconds.

display_namestring

The display name for the person.

signup_track_typestring

The type of signup track the user is following.

idinteger

The id of the modified person object.

createdstring

The timestamp of the person object's creation.

updatedstring

The timestamp of the person object's last update.

public_uuidstring

The person's public UUID.

legal_namestring

The person's legal name.

place_of_birthstring

The person's place of birth.

country_of_birthstring

The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.

version_terms_of_servicestring

The version of the terms of service accepted by the user.

Response

With UserPerson you can retrieve information regarding the authenticated UserPerson and update specific fields.<br/><br/>Notification filters can be set on a UserPerson level to receive callbacks. For more information check the <a href="/api/1/page/callbacks">dedicated callbacks page</a>.

idinteger

The id of the modified person object.