--- title: "Retrieve a profile" method: GET path: "/v0.1/me" tags: ["Merchant"] --- # Retrieve a profile `GET /v0.1/me` Returns user profile information. ## Query parameters - `include[]` string[] ## Response `200` OK - MerchantAccount — Details of the merchant account. - `account` Account — Profile information. - `username` string — Username of the user profile. - `type` 'normal' | 'operator' — The role of the user. - `personal_profile` PersonalProfile — Account's personal profile. - `first_name` string — First name of the user - `last_name` string — Last name of the user - `date_of_birth` string — Date of birth - `mobile_phone` string — Mobile phone number - `address` AddressWithDetails — Details of the registered address. - `address_line1` string — Address line 1 - `address_line2` string — Address line 2 - `city` string — City - `country` string — Country ISO 3166-1 code - `region_id` number — Country region id - `region_name` string — Region name - `region_code` string — Region code - `post_code` string — Postal code - `landline` string — Landline number - `first_name` string — undefined - `last_name` string — undefined - `company` string — undefined - `country_details` CountryDetails — Country Details - `currency` string — Currency ISO 4217 code - `iso_code` string — Country ISO code - `en_name` string — Country EN name - `native_name` string — Country native name - `timeoffset_details` TimeoffsetDetails — TimeOffset Details - `post_code` string — Postal code - `offset` number — UTC offset - `dst` boolean — Daylight Saving Time - `state_id` string — undefined - `complete` boolean - `merchant_profile` MerchantProfile — Account's merchant profile - `merchant_code` string — Unique identifying code of the merchant profile - `company_name` string — Company name - `website` string — Website - `legal_type` LegalType — Id of the legal type of the merchant profile - `id` number — Unique id - `full_description` string — Legal type description - `description` string — Legal type short description - `sole_trader` boolean — Sole trader legal type if true - `merchant_category_code` string — Merchant category code - `mobile_phone` string — Mobile phone number - `company_registration_number` string — Company registration number - `vat_id` string — Vat ID - `permanent_certificate_access_code` string — Permanent certificate access code (Portugal) - `nature_and_purpose` string — Nature and purpose of the business - `address` AddressWithDetails — Details of the registered address. - `address_line1` string — Address line 1 - `address_line2` string — Address line 2 - `city` string — City - `country` string — Country ISO 3166-1 code - `region_id` number — Country region id - `region_name` string — Region name - `region_code` string — Region code - `post_code` string — Postal code - `landline` string — Landline number - `first_name` string — undefined - `last_name` string — undefined - `company` string — undefined - `country_details` CountryDetails — Country Details - `currency` string — Currency ISO 4217 code - `iso_code` string — Country ISO code - `en_name` string — Country EN name - `native_name` string — Country native name - `timeoffset_details` TimeoffsetDetails — TimeOffset Details - `post_code` string — Postal code - `offset` number — UTC offset - `dst` boolean — Daylight Saving Time - `state_id` string — undefined - `business_owners` object[] — Business owners information. - `first_name` string — BO's first name - `last_name` string — BO's last name of the user - `date_of_birth` string — Date of birth - `mobile_phone` string — Mobile phone number - `landline` string — BO's Landline - `ownership` number — Ownership percentage - `doing_business_as` DoingBusinessAs — Doing Business As information - `business_name` string — Doing business as name - `company_registration_number` string — Doing business as company registration number - `vat_id` string — Doing business as VAT ID - `website` string — Doing business as website - `email` string — Doing business as email - `address` object - `address_line1` string — Address line 1 - `address_line2` string — Address line 2 - `city` string — City - `country` string — Country ISO 3166-1 code - `region_id` number — Country region ID - `region_name` string — Country region name - `post_code` string — Postal code - `settings` MerchantSettings — Merchant settings (like \"payout_type\", \"payout_period\") - `tax_enabled` boolean — Whether to show tax in receipts (saved per transaction) - `payout_type` string — Payout type - `payout_period` string — Payout frequency - `payout_on_demand_available` boolean — Whether merchant can edit payouts on demand - `payout_on_demand` boolean — Whether merchant will receive payouts on demand - `printers_enabled` boolean — Whether to show printers in mobile app - `payout_instrument` string — Payout Instrument - `moto_payment` 'UNAVAILABLE' | 'ENFORCED' | 'ON' | 'OFF' — Whether merchant can make MOTO payments - `stone_merchant_code` string — Stone merchant code - `daily_payout_email` boolean — Whether merchant will receive daily payout emails - `monthly_payout_email` boolean — Whether merchant will receive monthly payout emails - `gross_settlement` boolean — Whether merchant has gross settlement enabled - `vat_rates` VatRates — Merchant VAT rates - `id` number — Internal ID - `description` string — Description - `rate` number — Rate - `ordering` number — Ordering - `country` string — Country ISO code - `locale` string — Merchant locale (for internal usage only) - `bank_accounts` BankAccount[] - `bank_code` string — Bank code - `branch_code` string — Branch code - `swift` string — SWIFT code - `account_number` string — Account number - `iban` string — IBAN - `account_type` string — Type of the account - `account_category` string — Account category - business or personal - `account_holder_name` string - `status` string — Status in the verification process - `primary` boolean — The primary bank account is the one used for payouts - `created_at` string — Creation date of the bank account - `bank_name` string — Bank name - `extdev` boolean — True if the merchant is extdev - `payout_zone_migrated` boolean — True if the payout zone of this merchant is migrated - `country` string — Merchant country code formatted according to [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) (for internal usage only) - `app_settings` AppSettings — Mobile app settings - `checkout_preference` string — Checkout preference - `include_vat` boolean — Include vat. - `manual_entry_tutorial` boolean — Manual entry tutorial. - `mobile_payment_tutorial` boolean — Mobile payment tutorial. - `tax_enabled` boolean — Tax enabled. - `mobile_payment` string — Mobile payment. - `reader_payment` string — Reader payment. - `cash_payment` string — Cash payment. - `advanced_mode` string — Advanced mode. - `expected_max_transaction_amount` number — Expected max transaction amount. - `manual_entry` string — Manual entry. - `terminal_mode_tutorial` boolean — Terminal mode tutorial. - `tipping` string — Tipping. - `tip_rates` number[] — Tip rates. - `barcode_scanner` string — Barcode scanner. - `referral` string — Referral. - `permissions` Permissions — User permissions - `create_moto_payments` boolean — Create MOTO payments - `full_transaction_history_view` boolean — Can view full merchant transaction history - `refund_transactions` boolean — Refund transactions - `create_referral` boolean — Create referral - `is_migrated_payleven_br` boolean — Merchant comes from payleven BR migration ## Other responses - `401` — Unauthorized ## Changes - **2025-02-25** `cdadac3315a1` — 2 info - the endpoint scheme security `apiKey` was added to the API - the endpoint scheme security `oauth2` was added to the API [Change history](https://skmtc.dev/sumup/apis/sumup-rest-api/changes/v0.1/me/get.md) --- [API](https://skmtc.dev/sumup/apis/sumup-rest-api.md) · [All operations](https://skmtc.dev/sumup/apis/sumup-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sumup/sumup-rest-api/revisions/2b6f466f2efe/schema)