action bunq_list_all_company_for_user { description: "Create and manage companies." provider: bunq method: GET path: "/user/{userID}/company" encoding: json input: { type: "object" properties: { userID: { type: "integer" } } required: ["userID"] additionalProperties: false } output: { type: "array" items: { type: "object" properties: { UserCompany: { type: "object" properties: { address_main: { type: "object" properties: { city: { type: "string" description: "The city." } country: { type: "string" description: "The country as an ISO 3166-1 alpha-2 country code." } extra: { type: "string" description: "The apartment, building or other extra information for addresses." } house_number: { type: "string" description: "The house number." } is_user_address_updated: { type: "boolean" description: "To show whether user created or updated her address for app event listing." } mailbox_name: { type: "string" description: "The name on the mailbox (only used for Postal addresses)." } po_box: { type: "string" description: "The PO box." } postal_code: { type: "string" description: "The postal code." } province: { type: "string" description: "The province according to local standard." } street: { type: "string" description: "The street." } } } address_postal: { type: "object" additionalProperties: true } alias: { type: "array" description: "The aliases of the account." items: { type: "object" properties: { name: { type: "string" description: "The alias name." } service: { type: "string" description: "The pointer service. Only required for external counterparties." } type: { type: "string" description: "The alias type, can be: EMAIL|PHONE_NUMBER|IBAN." } value: { type: "string" description: "The alias value." } } } } avatar: { type: "object" properties: { anchor_uuid: { type: "string" description: "The public UUID of object this avatar is anchored to." } image: { type: "array" description: "The actual image information of this avatar." items: { type: "object" properties: { attachment_public_uuid: { type: "string" description: "The public UUID of the public attachment containing the image." } content_type: { type: "string" description: "The content-type as a MIME filetype." } height: { type: "integer" description: "The image height in pixels." } width: { type: "integer" description: "The image width in pixels." } } } } style: { type: "string" description: "The style (if applicable) for this Avatar." } uuid: { type: "string" description: "The public UUID of the avatar." } } } avatar_uuid: { type: "string" description: "The public UUID of the company's avatar." } billing_contract: { type: "array" description: "The subscription of the company." items: { type: "object" properties: { contract_date_end: { type: "string" description: "The date until when the billing contract is valid." } contract_date_start: { type: "string" description: "The date from when the billing contract is valid." } contract_version: { type: "integer" description: "The version of the billing contract." } created: { type: "string" description: "The timestamp when the billing contract was made." } id: { type: "integer" description: "The id of the billing contract." } status: { type: "string" description: "The subscription status." } sub_status: { type: "string" description: "The subscription substatus." } subscription_type: { type: "string" description: "The subscription type of the user. Can be one of PERSON_SUPER_LIGHT_V1, PERSON_LIGHT_V1, PERSON_MORE_V1, PERSON_FREE_V1, PERSON_PREMIUM_V1, COMPANY_V1, or COMPANY_V2." } subscription_type_downgrade: { type: "string" description: "The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible." } updated: { type: "string" description: "The timestamp when the billing contract was last updated." } } } } chamber_of_commerce_number: { type: "string" description: "The company's chamber of commerce number." } counter_bank_iban: { type: "string" description: "The company's other bank account IBAN, through which we verify it." } country: { type: "string" description: "The country as an ISO 3166-1 alpha-2 country code." } created: { type: "string" description: "The timestamp of the company object's creation." } customer: { type: "object" properties: { billing_account_id: { type: "string" description: "The primary billing account account's id." } created: { type: "string" description: "The timestamp of the customer object's creation." } id: { type: "integer" description: "The id of the customer." } invoice_notification_preference: { type: "string" description: "The preferred notification type for invoices." } updated: { type: "string" description: "The timestamp of the customer object's last update." } } } customer_limit: { type: "object" properties: { limit_amount_monthly: { type: "object" properties: { currency: { type: "string" description: "The currency of the amount. It is an ISO 4217 formatted currency code." } value: { type: "string" description: "The amount formatted to two decimal places." } } } limit_card_debit_maestro: { type: "integer" description: "The limit of Maestro cards." } limit_card_debit_mastercard: { type: "integer" description: "The limit of MasterCard cards." } limit_card_debit_wildcard: { type: "integer" description: "DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards." } limit_card_replacement: { type: "integer" description: "The limit of free replacement cards." } limit_card_wildcard: { type: "integer" description: "The limit of wildcards, e.g. Maestro or MasterCard cards." } limit_monetary_account: { type: "integer" description: "The limit of monetary accounts." } limit_monetary_account_remaining: { type: "integer" description: "The amount of additional monetary accounts you can create." } spent_amount_monthly: { type: "object" additionalProperties: true } } } daily_limit_without_confirmation_login: { type: "object" additionalProperties: true } deny_reason: { type: "string" description: "The user deny reason." } directors: { type: "array" description: "The existing bunq aliases for the company's directors." items: { type: "object" properties: { avatar: { type: "object" additionalProperties: true } country: { type: "string" description: "The country of the user. 000 stands for \"unknown\"" } display_name: { type: "string" description: "The name to be displayed for this user, as it was given on the request." } public_nick_name: { type: "string" description: "The current nickname of the user." } uuid: { type: "string" description: "The public UUID of the label-user." } } } } display_name: { type: "string" description: "The company's display name." } id: { type: "integer" description: "The id of the modified company." } language: { type: "string" description: "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." } legal_form: { type: "string" description: "The company's legal form." } name: { type: "string" description: "The company name." } notification_filters: { type: "array" description: "The types of notifications that will result in a push notification or URL callback for this UserCompany." items: { type: "object" properties: { category: { type: "string" description: "The notification category that will match this notification filter. Possible choices are BILLING, CARD_TRANSACTION_FAILED, CARD_TRANSACTION_SUCCESSFUL, CHAT, DRAFT_PAYMENT, IDEAL, SOFORT, MONETARY_ACCOUNT_PROFILE, MUTATION, PAYMENT, PROMOTION, REQUEST, SCHEDULE_RESULT, SCHEDULE_STATUS, SHARE, SUPPORT, TAB_RESULT, USER_APPROVAL." } notification_delivery_method: { type: "string" description: "The delivery method via which notifications that match this notification filter will be delivered. Possible choices are PUSH for delivery via push notification and URL for delivery via URL callback." } notification_target: { type: "string" description: "The target of notifications that match this notification filter. For URL notification filters this is the URL to which the callback will be made. For PUSH notifications filters this should always be null." } } } } public_nick_name: { type: "string" description: "The company's public nick name." } public_uuid: { type: "string" description: "The company's public UUID." } region: { type: "string" description: "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." } relations: { type: "array" description: "The relations for this user." items: { type: "object" properties: { counter_label_user: { type: "object" additionalProperties: true } counter_user_id: { type: "string" description: "The counter user's ID." } counter_user_status: { type: "string" description: "The account status of a user" } label_user: { type: "object" additionalProperties: true } relationship: { type: "string" description: "The requested relation type." } status: { type: "string" description: "The request's status, only for UPDATE." } user_id: { type: "string" description: "The user's ID." } user_status: { type: "string" description: "The account status of a user" } } } } sector_of_industry: { type: "string" description: "The sector of industry." } session_timeout: { type: "integer" description: "The setting for the session timeout of the company in seconds." } status: { type: "string" description: "The user status. Can be: ACTIVE, SIGNUP, RECOVERY." } sub_status: { type: "string" description: "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT." } tax_resident: { type: "array" description: "The user's tax residence numbers for different countries." items: { type: "object" properties: { country: { type: "string" description: "The country of the tax number." } status: { type: "string" description: "The status of the tax number. Either CONFIRMED or UNCONFIRMED." } tax_number: { type: "string" description: "The tax number." } } } } type_of_business_entity: { type: "string" description: "The type of business entity." } ubo: { type: "array" description: "The names of the company's ultimate beneficiary owners. Minimum zero, maximum four." items: { type: "object" properties: { date_of_birth: { type: "string" description: "The date of birth of the ultimate beneficiary owner." } name: { type: "string" description: "The name of the ultimate beneficiary owner." } nationality: { type: "string" description: "The nationality of the ultimate beneficiary owner." } } } } updated: { type: "string" description: "The timestamp of the company object's last update." } version_terms_of_service: { type: "string" description: "The version of the terms of service accepted by the user." } } } } } } }