Sign in

v1

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

Get a specific company.

get/user-company/{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

Response

With UserCompany you can retrieve information regarding the authenticated UserCompany and update specific fields.<br/><br/>Notification filters can be set on a UserCompany 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 company.

createdstring

The timestamp of the company object's creation.

updatedstring

The timestamp of the company object's last update.

public_uuidstring

The company's public UUID.

namestring

The company name.

display_namestring

The company's display name.

public_nick_namestring

The company's public nick name.

chamber_of_commerce_numberstring

The company's chamber of commerce number.

legal_formstring

The company's legal form.

type_of_business_entitystring

The type of business entity.

sector_of_industrystring

The sector of industry.

counter_bank_ibanstring

The company's other bank account IBAN, through which we verify it.

version_terms_of_servicestring

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

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.

countrystring

The country as an ISO 3166-1 alpha-2 country code.

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.

statusstring

The user status. Can be: ACTIVE, SIGNUP, RECOVERY.

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 company in seconds.

deny_reasonstring

The user deny reason.