--- title: "GET /user" method: GET path: "/user" tags: ["user"] --- # GET /user `GET /user` Get a collection of all available users. ## Headers - `Cache-Control` string - `User-Agent` string, required - `X-Bunq-Language` string - `X-Bunq-Region` string - `X-Bunq-Client-Request-Id` string - `X-Bunq-Geolocation` string - `X-Bunq-Client-Authentication` string, required ## Response `200` Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints. - UserListing[] - `UserPerson` UserPerson - `subscription_type` string — The subscription type the user should start on. - `first_name` string — The person's first name. - `middle_name` string — The person's middle name. - `last_name` string — The person's last name. - `public_nick_name` string — The public nick name for the person. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `avatar_uuid` string — The public UUID of the user's avatar. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `document_type` string — The type of identification document the person registered with. - `document_number` string — The identification document number the person registered with. - `document_country_of_issuance` string — The country which issued the identification document the person registered with. - `document_front_attachment_id` integer — The reference to the uploaded picture/scan of the front side of the identification document. - `document_back_attachment_id` integer — The reference to the uploaded picture/scan of the back side of the identification document. - `date_of_birth` string — The person's date of birth. Accepts ISO8601 date formats. - `nationality` string — The person's nationality. Formatted as a SO 3166-1 alpha-2 country code. - `all_nationality` string[] — All of the person's nationalities. - `language` string — 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. - `region` string — 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. - `gender` string — The person's gender. Can be MALE, FEMALE or UNKNOWN. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `legal_guardian_alias` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `session_timeout` integer — The setting for the session timeout of the user in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `display_name` string — The display name for the person. - `signup_track_type` string — The type of signup track the user is following. - `id` integer — The id of the modified person object. - `created` string — The timestamp of the person object's creation. - `updated` string — The timestamp of the person object's last update. - `public_uuid` string — The person's public UUID. - `legal_name` string — The person's legal name. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `place_of_birth` string — The person's place of birth. - `country_of_birth` string — The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserPerson. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `pointer_monetary_account` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `status` string — The status of the employee card. - `card` Card - `pin_code` string — The plaintext pin code. Requests require encryption to be enabled. - `activation_code` string — DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION. - `status` string — The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after. - `order_status` string — The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced. - `card_limit` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `card_limit_atm` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `country_permission` CardCountryPermission[] — The countries for which to grant (temporary) permissions to use the card. - `country` string — The country to allow transactions in (e.g. NL, DE). - `expiry_time` string — Expiry time of this rule. - `id` integer — The id of the card country permission entry. - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - `type` string — PIN type. Can be PRIMARY, SECONDARY or TERTIARY - `routing_type` string — Routing type. - `pin_code` string — The 4 digit PIN to be assigned to this account. - `monetary_account_id` integer — The ID of the monetary account to assign to this pin for the card. - `status` string — The status of the card pin assignment. - `primary_account_numbers` CardPrimaryAccountNumber[] — Array of PANs and their attributes. - `id` integer — The ID for this Virtual PAN. - `description` string — The description for this PAN. - `status` string — The status for this PAN, only for Online Cards. - `monetary_account_id` integer — The ID of the monetary account to assign to this PAN, only for Online Cards. - `uuid` string — The UUID for this Virtual PAN. - `four_digit` string — The last four digits of the PAN. - `type` string — The type of the PAN. - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `preferred_name_on_card` string — The user's preferred name as it will be on the card. - `second_line` string — The second line of text on the card - `cancellation_reason` string — The reason for card cancellation. - `amount_spent_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `UserCompany` UserCompany - `name` string — The company name. - `public_nick_name` string — The company's public nick name. - `avatar_uuid` string — The public UUID of the company's avatar. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `language` string — 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. - `region` string — 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. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `ubo` Ubo[] — The names of the company's ultimate beneficiary owners. Minimum zero, maximum four. - `name` string — The name of the ultimate beneficiary owner. - `date_of_birth` string — The date of birth of the ultimate beneficiary owner. - `nationality` string — The nationality of the ultimate beneficiary owner. - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `legal_form` string — The company's legal form. - `status` string — The user status. Can be: ACTIVE, SIGNUP, RECOVERY. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `session_timeout` integer — The setting for the session timeout of the company in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `id` integer — The id of the modified company. - `created` string — The timestamp of the company object's creation. - `updated` string — The timestamp of the company object's last update. - `public_uuid` string — The company's public UUID. - `display_name` string — The company's display name. - `alias` Pointer[] — The aliases of the account. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `type_of_business_entity` string — The type of business entity. - `sector_of_industry` string — The sector of industry. - `counter_bank_iban` string — The company's other bank account IBAN, through which we verify it. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `directors` LabelUser[] — The existing bunq aliases for the company's directors. - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserCompany. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `customer` Customer - `billing_account_id` string — The primary billing account account's id. - `invoice_notification_preference` string — The preferred notification type for invoices. - `id` integer — The id of the customer. - `created` string — The timestamp of the customer object's creation. - `updated` string — The timestamp of the customer object's last update. - `customer_limit` CustomerLimit - `limit_monetary_account` integer — The limit of monetary accounts. - `limit_monetary_account_remaining` integer — The amount of additional monetary accounts you can create. - `limit_card_debit_maestro` integer — The limit of Maestro cards. - `limit_card_debit_mastercard` integer — The limit of MasterCard cards. - `limit_card_debit_wildcard` integer — DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_wildcard` integer — The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_replacement` integer — The limit of free replacement cards. - `limit_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `spent_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `billing_contract` BillingContractSubscription[] — The subscription of the company. - `subscription_type` string — 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. - `id` integer — The id of the billing contract. - `created` string — The timestamp when the billing contract was made. - `updated` string — The timestamp when the billing contract was last updated. - `contract_date_start` string — The date from when the billing contract is valid. - `contract_date_end` string — The date until when the billing contract is valid. - `contract_version` integer — The version of the billing contract. - `subscription_type_downgrade` string — The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible. - `status` string — The subscription status. - `sub_status` string — The subscription substatus. - `deny_reason` string — The user deny reason. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `pointer_monetary_account` Pointer, required - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `status` string — The status of the employee card. - `card` Card - `pin_code` string — The plaintext pin code. Requests require encryption to be enabled. - `activation_code` string — DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION. - `status` string — The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after. - `order_status` string — The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced. - `card_limit` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `card_limit_atm` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `country_permission` CardCountryPermission[] — The countries for which to grant (temporary) permissions to use the card. - `country` string — The country to allow transactions in (e.g. NL, DE). - `expiry_time` string — Expiry time of this rule. - `id` integer — The id of the card country permission entry. - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - `type` string — PIN type. Can be PRIMARY, SECONDARY or TERTIARY - `routing_type` string — Routing type. - `pin_code` string — The 4 digit PIN to be assigned to this account. - `monetary_account_id` integer — The ID of the monetary account to assign to this pin for the card. - `status` string — The status of the card pin assignment. - `primary_account_numbers` CardPrimaryAccountNumber[] — Array of PANs and their attributes. - `id` integer — The ID for this Virtual PAN. - `description` string — The description for this PAN. - `status` string — The status for this PAN, only for Online Cards. - `monetary_account_id` integer — The ID of the monetary account to assign to this PAN, only for Online Cards. - `uuid` string — The UUID for this Virtual PAN. - `four_digit` string — The last four digits of the PAN. - `type` string — The type of the PAN. - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `preferred_name_on_card` string — The user's preferred name as it will be on the card. - `second_line` string — The second line of text on the card - `cancellation_reason` string — The reason for card cancellation. - `amount_spent_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `UserApiKey` UserApiKey - `id` integer — The id of the user. - `created` string — The timestamp of the user object's creation. - `updated` string — The timestamp of the user object's last update. - `requested_by_user` UserApiKeyAnchoredUser - `UserPerson` UserPerson - `subscription_type` string — The subscription type the user should start on. - `first_name` string — The person's first name. - `middle_name` string — The person's middle name. - `last_name` string — The person's last name. - `public_nick_name` string — The public nick name for the person. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `avatar_uuid` string — The public UUID of the user's avatar. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `document_type` string — The type of identification document the person registered with. - `document_number` string — The identification document number the person registered with. - `document_country_of_issuance` string — The country which issued the identification document the person registered with. - `document_front_attachment_id` integer — The reference to the uploaded picture/scan of the front side of the identification document. - `document_back_attachment_id` integer — The reference to the uploaded picture/scan of the back side of the identification document. - `date_of_birth` string — The person's date of birth. Accepts ISO8601 date formats. - `nationality` string — The person's nationality. Formatted as a SO 3166-1 alpha-2 country code. - `all_nationality` string[] — All of the person's nationalities. - `language` string — 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. - `region` string — 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. - `gender` string — The person's gender. Can be MALE, FEMALE or UNKNOWN. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `legal_guardian_alias` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `session_timeout` integer — The setting for the session timeout of the user in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `display_name` string — The display name for the person. - `signup_track_type` string — The type of signup track the user is following. - `id` integer — The id of the modified person object. - `created` string — The timestamp of the person object's creation. - `updated` string — The timestamp of the person object's last update. - `public_uuid` string — The person's public UUID. - `legal_name` string — The person's legal name. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `place_of_birth` string — The person's place of birth. - `country_of_birth` string — The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserPerson. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - … - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - … - `pointer_monetary_account` Pointer, required - … - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - … - `status` string — The status of the employee card. - `card` Card - … - `amount_spent_monthly` Amount - … - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `UserCompany` UserCompany - `name` string — The company name. - `public_nick_name` string — The company's public nick name. - `avatar_uuid` string — The public UUID of the company's avatar. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `language` string — 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. - `region` string — 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. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `ubo` Ubo[] — The names of the company's ultimate beneficiary owners. Minimum zero, maximum four. - `name` string — The name of the ultimate beneficiary owner. - `date_of_birth` string — The date of birth of the ultimate beneficiary owner. - `nationality` string — The nationality of the ultimate beneficiary owner. - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `legal_form` string — The company's legal form. - `status` string — The user status. Can be: ACTIVE, SIGNUP, RECOVERY. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `session_timeout` integer — The setting for the session timeout of the company in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `id` integer — The id of the modified company. - `created` string — The timestamp of the company object's creation. - `updated` string — The timestamp of the company object's last update. - `public_uuid` string — The company's public UUID. - `display_name` string — The company's display name. - `alias` Pointer[] — The aliases of the account. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `type_of_business_entity` string — The type of business entity. - `sector_of_industry` string — The sector of industry. - `counter_bank_iban` string — The company's other bank account IBAN, through which we verify it. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `directors` LabelUser[] — The existing bunq aliases for the company's directors. - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserCompany. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `customer` Customer - `billing_account_id` string — The primary billing account account's id. - `invoice_notification_preference` string — The preferred notification type for invoices. - `id` integer — The id of the customer. - `created` string — The timestamp of the customer object's creation. - `updated` string — The timestamp of the customer object's last update. - `customer_limit` CustomerLimit - `limit_monetary_account` integer — The limit of monetary accounts. - `limit_monetary_account_remaining` integer — The amount of additional monetary accounts you can create. - `limit_card_debit_maestro` integer — The limit of Maestro cards. - `limit_card_debit_mastercard` integer — The limit of MasterCard cards. - `limit_card_debit_wildcard` integer — DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_wildcard` integer — The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_replacement` integer — The limit of free replacement cards. - `limit_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `spent_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `billing_contract` BillingContractSubscription[] — The subscription of the company. - `subscription_type` string — 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. - `id` integer — The id of the billing contract. - `created` string — The timestamp when the billing contract was made. - `updated` string — The timestamp when the billing contract was last updated. - `contract_date_start` string — The date from when the billing contract is valid. - `contract_date_end` string — The date until when the billing contract is valid. - `contract_version` integer — The version of the billing contract. - `subscription_type_downgrade` string — The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible. - `status` string — The subscription status. - `sub_status` string — The subscription substatus. - `deny_reason` string — The user deny reason. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - … - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - … - `pointer_monetary_account` Pointer, required - … - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - … - `status` string — The status of the employee card. - `card` Card - … - `amount_spent_monthly` Amount - … - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `UserPaymentServiceProvider` UserPaymentServiceProvider - `id` integer — The id of the user. - `created` string — The timestamp of the user object's creation. - `updated` string — The timestamp of the user object's last update. - `certificate_distinguished_name` string — The distinguished name from the certificate used to identify this user. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED or DENIED. - `sub_status` string — The user sub-status. Can be: NONE - `public_uuid` string — The providers's public UUID. - `display_name` string — The display name for the provider. - `public_nick_name` string — The public nick name for the provider. - `language` string — The provider's language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `region` string — The provider's region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `session_timeout` integer — The setting for the session timeout of the user in seconds. - `granted_by_user` UserApiKeyAnchoredUser - `UserPerson` UserPerson - `subscription_type` string — The subscription type the user should start on. - `first_name` string — The person's first name. - `middle_name` string — The person's middle name. - `last_name` string — The person's last name. - `public_nick_name` string — The public nick name for the person. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `avatar_uuid` string — The public UUID of the user's avatar. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `document_type` string — The type of identification document the person registered with. - `document_number` string — The identification document number the person registered with. - `document_country_of_issuance` string — The country which issued the identification document the person registered with. - `document_front_attachment_id` integer — The reference to the uploaded picture/scan of the front side of the identification document. - `document_back_attachment_id` integer — The reference to the uploaded picture/scan of the back side of the identification document. - `date_of_birth` string — The person's date of birth. Accepts ISO8601 date formats. - `nationality` string — The person's nationality. Formatted as a SO 3166-1 alpha-2 country code. - `all_nationality` string[] — All of the person's nationalities. - `language` string — 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. - `region` string — 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. - `gender` string — The person's gender. Can be MALE, FEMALE or UNKNOWN. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `legal_guardian_alias` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `session_timeout` integer — The setting for the session timeout of the user in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `display_name` string — The display name for the person. - `signup_track_type` string — The type of signup track the user is following. - `id` integer — The id of the modified person object. - `created` string — The timestamp of the person object's creation. - `updated` string — The timestamp of the person object's last update. - `public_uuid` string — The person's public UUID. - `legal_name` string — The person's legal name. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `place_of_birth` string — The person's place of birth. - `country_of_birth` string — The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserPerson. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - … - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - … - `pointer_monetary_account` Pointer, required - … - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - … - `status` string — The status of the employee card. - `card` Card - … - `amount_spent_monthly` Amount - … - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `UserCompany` UserCompany - `name` string — The company name. - `public_nick_name` string — The company's public nick name. - `avatar_uuid` string — The public UUID of the company's avatar. - `address_main` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_postal` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `language` string — 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. - `region` string — 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. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `ubo` Ubo[] — The names of the company's ultimate beneficiary owners. Minimum zero, maximum four. - `name` string — The name of the ultimate beneficiary owner. - `date_of_birth` string — The date of birth of the ultimate beneficiary owner. - `nationality` string — The nationality of the ultimate beneficiary owner. - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `legal_form` string — The company's legal form. - `status` string — The user status. Can be: ACTIVE, SIGNUP, RECOVERY. - `sub_status` string — The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT. - `session_timeout` integer — The setting for the session timeout of the company in seconds. - `daily_limit_without_confirmation_login` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `id` integer — The id of the modified company. - `created` string — The timestamp of the company object's creation. - `updated` string — The timestamp of the company object's last update. - `public_uuid` string — The company's public UUID. - `display_name` string — The company's display name. - `alias` Pointer[] — The aliases of the account. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `type_of_business_entity` string — The type of business entity. - `sector_of_industry` string — The sector of industry. - `counter_bank_iban` string — The company's other bank account IBAN, through which we verify it. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `version_terms_of_service` string — The version of the terms of service accepted by the user. - `directors` LabelUser[] — The existing bunq aliases for the company's directors. - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `notification_filters` NotificationFilter[] — The types of notifications that will result in a push notification or URL callback for this UserCompany. - `notification_delivery_method` string — 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` string — 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. - `category` string — 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. - `customer` Customer - `billing_account_id` string — The primary billing account account's id. - `invoice_notification_preference` string — The preferred notification type for invoices. - `id` integer — The id of the customer. - `created` string — The timestamp of the customer object's creation. - `updated` string — The timestamp of the customer object's last update. - `customer_limit` CustomerLimit - `limit_monetary_account` integer — The limit of monetary accounts. - `limit_monetary_account_remaining` integer — The amount of additional monetary accounts you can create. - `limit_card_debit_maestro` integer — The limit of Maestro cards. - `limit_card_debit_mastercard` integer — The limit of MasterCard cards. - `limit_card_debit_wildcard` integer — DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_wildcard` integer — The limit of wildcards, e.g. Maestro or MasterCard cards. - `limit_card_replacement` integer — The limit of free replacement cards. - `limit_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `spent_amount_monthly` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `billing_contract` BillingContractSubscription[] — The subscription of the company. - `subscription_type` string — 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. - `id` integer — The id of the billing contract. - `created` string — The timestamp when the billing contract was made. - `updated` string — The timestamp when the billing contract was last updated. - `contract_date_start` string — The date from when the billing contract is valid. - `contract_date_end` string — The date until when the billing contract is valid. - `contract_version` integer — The version of the billing contract. - `subscription_type_downgrade` string — The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible. - `status` string — The subscription status. - `sub_status` string — The subscription substatus. - `deny_reason` string — The user deny reason. - `relations` RelationUser[] — The relations for this user. - `user_id` string — The user's ID. - `counter_user_id` string — The counter user's ID. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `relationship` string — The requested relation type. - `status` string — The request's status, only for UPDATE. - `user_status` string — The account status of a user - `counter_user_status` string — The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - … - `status` string — Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer — The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[] — Cards accessible by the company employee - `pointer_counter_user` Pointer, required - … - `pointer_monetary_account` Pointer, required - … - `type` string, required — The type of card to order. - `product_type` string, required — The product type of the card to order. - `company_name_on_card` string — The name of the company that should be displayed on the card. - `employee_name_on_card` string — The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string — The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - … - `status` string — The status of the employee card. - `card` Card - … - `amount_spent_monthly` Amount - … - `number_of_company_employee_card_receipt_pending` integer — The number of transactions that still need a receipt. - `tax_resident` TaxResident[] — The user's tax residence numbers for different countries. - `country` string — The country of the tax number. - `tax_number` string — The tax number. - `status` string — The status of the tax number. Either CONFIRMED or UNCONFIRMED. - `id` integer — The id of the tax resident. - `UserPaymentServiceProvider` UserPaymentServiceProvider - `id` integer — The id of the user. - `created` string — The timestamp of the user object's creation. - `updated` string — The timestamp of the user object's last update. - `certificate_distinguished_name` string — The distinguished name from the certificate used to identify this user. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED or DENIED. - `sub_status` string — The user sub-status. Can be: NONE - `public_uuid` string — The providers's public UUID. - `display_name` string — The display name for the provider. - `public_nick_name` string — The public nick name for the provider. - `language` string — The provider's language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `region` string — The provider's region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `session_timeout` integer — The setting for the session timeout of the user in seconds. - `UserPaymentServiceProvider` UserPaymentServiceProvider - `id` integer — The id of the user. - `created` string — The timestamp of the user object's creation. - `updated` string — The timestamp of the user object's last update. - `certificate_distinguished_name` string — The distinguished name from the certificate used to identify this user. - `alias` Pointer[] — The aliases of the user. - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `status` string — The user status. The user status. Can be: ACTIVE, BLOCKED or DENIED. - `sub_status` string — The user sub-status. Can be: NONE - `public_uuid` string — The providers's public UUID. - `display_name` string — The display name for the provider. - `public_nick_name` string — The public nick name for the provider. - `language` string — The provider's language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `region` string — The provider's region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. - `session_timeout` integer — The setting for the session timeout of the user in seconds. ## Other responses - `400` — This is how the error response looks like for 4XX response codes --- [API](https://skmtc.net/bunq/apis/bunq-api.md) · [All operations](https://skmtc.net/bunq/apis/bunq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bunq/bunq-api/revisions/369477c7bd26/schema)