--- title: "POST /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry" method: POST path: "/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry" tags: ["share-invite-monetary-account-inquiry"] --- # POST /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry `POST /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry` [DEPRECATED - use /share-invite-monetary-account-response] Create a new share inquiry for a monetary account, specifying the permission the other bunq user will have on it. ## Path parameters - `userID` integer, required - `monetary-accountID` integer, required ## 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 ## Request body - ShareInviteMonetaryAccountInquiry - `counter_user_alias` 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. - `access_type` string — Type of access that is in place. - `draft_share_invite_bank_id` integer — DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank. - `share_detail` ShareDetail - `payment` ShareDetailPayment - `make_payments` boolean — If set to true, the invited user will be able to make payments from the shared account. - `make_draft_payments` boolean — If set to true, the invited user will be able to make draft payments from the shared account. - `view_balance` boolean — If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean — If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean — If set to true, the invited user will be able to view events starting from the time the share became active. - `read_only` ShareDetailReadOnly - `view_balance` boolean — If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean — If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean — If set to true, the invited user will be able to view events starting from the time the share became active. - `draft_payment` ShareDetailDraftPayment - `make_draft_payments` boolean — If set to true, the invited user will be able to make draft payments from the shared account. - `view_balance` boolean — If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean — If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean — If set to true, the invited user will be able to view events starting from the time the share became active. - `status` string — The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `relationship` string — The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc - `share_type` string — DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL. - `start_date` string — DEPRECATED: USE `access_type` INSTEAD | The start date of this share. - `end_date` string — DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `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. - `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. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` 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. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `user_alias_created` 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. - `user_alias_revoked` 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. - `monetary_account_id` integer — The id of the monetary account the share applies to. - `id` integer — The id of the newly created share invite. ## Response `200` [DEPRECATED - use /share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted/rejected by the other party. - ShareInviteMonetaryAccountInquiryCreate - `id` integer — The id of the newly created share invite. ## 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)