User Company | bunq API Documentation

bunq API Documentation

Postman Collection

get

Return all the known (trade) names for a specific user company.

Path parameters

user-companyIDintegerRequired

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

get

GET /v1/user-company/{user-companyID}/name HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

[
  {
    "name_array": [
      "text"
    ]
  }
]

get

Get a specific company.

Path parameters

itemIdintegerRequired

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

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Responses

get

GET /v1/user-company/{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",
  "name": "text",
  "display_name": "text",
  "public_nick_name": "text",
  "alias": [
    {
      "type": "text",
      "value": "text",
      "name": "text"
    }
  ],
  "chamber_of_commerce_number": "text",
  "legal_form": "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_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
  },
  "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"
    }
  ],
  "language": "text",
  "country": "text",
  "region": "text",
  "ubo": [
    {
      "name": "text",
      "date_of_birth": "text",
      "nationality": "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"
    }
  ],
  "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
    }
  ]
}

put

Modify a specific company's data.

Path parameters

itemIdintegerRequired

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

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Body

namestringOptional

The company name.

public_nick_namestringOptional

The company's public nick name.

avatar_uuidstringWrite-onlyOptional

The public UUID of the company's avatar.

languagestringOptional

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.

regionstringOptional

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.

countrystringOptional

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

chamber_of_commerce_numberstringOptional

The company's chamber of commerce number.

legal_formstringOptional

The company's legal form.

statusstringOptional

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

sub_statusstringOptional

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

session_timeoutintegerOptional

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

idintegerRead-onlyOptional

The id of the modified company.

createdstringRead-onlyOptional

The timestamp of the company object's creation.

updatedstringRead-onlyOptional

The timestamp of the company object's last update.

public_uuidstringRead-onlyOptional

The company's public UUID.

display_namestringRead-onlyOptional

The company's display name.

type_of_business_entitystringRead-onlyOptional

The type of business entity.

sector_of_industrystringRead-onlyOptional

The sector of industry.

counter_bank_ibanstringRead-onlyOptional

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

version_terms_of_servicestringRead-onlyOptional

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

deny_reasonstringRead-onlyOptional

The user deny reason.

Responses

put

PUT /v1/user-company/{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: 691

{
  "name": "text",
  "public_nick_name": "text",
  "avatar_uuid": "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"
  },
  "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
}