---
title: "Member"
description: "A member is user within specific resource identified by resource id, resource type, and associated roles."
image: "https://developer.sumup.com/og/index.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.sumup.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: SumUp REST API

A member is user within specific resource identified by resource id, resource type, and associated roles.

## Fields

- `id` (`Member.id`; string, required) — ID of the member.
  - example `"mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"`
- `roles` (`Member.roles`; array<string>, required) — User's roles.
  - example `["role_admin"]`
- `permissions` (`Member.permissions`; array<string>, required, deprecated) — User's permissions.
  - example `["members_read","members_write","create_moto_payments","full_transaction_history_view","refund_transactions","create_referral","developer_settings_edit","developer_settings_access"]`
- `created_at` (`Member.created_at`; string, required) — The timestamp of when the member was created.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `updated_at` (`Member.updated_at`; string, required) — The timestamp of when the member was last updated.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `status` (`Member.status`; string, required) — The status of the membership.
  - one of `"accepted"`, `"pending"`, `"expired"`, `"disabled"`, `"unknown"`
- `user` (`Member.user`; object, optional) — Information about the user associated with the membership.
  - `id` (`Member.user.id`; string, required) — Identifier for the End-User (also called Subject).
    - example `"44ca0f5b-813b-46e1-aee7-e6242010662e"`
  - `type` (`Member.user.type`; string, required) — Type of the user account.
    - one of `"user"`, `"managed_user"`, `"service_account"`, `"system_account"`; example `"user"`
  - `email` (`Member.user.email`; string, required) — End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
    - example `"example@sumup.com"`
  - `mfa_on_login_enabled` (`Member.user.mfa_on_login_enabled`; boolean, required) — True if the user has enabled MFA on login.
    - example `true`
  - `virtual_user` (`Member.user.virtual_user`; boolean, required, deprecated) — True if the user is a virtual user (operator).
    - example `false`
  - `service_account_user` (`Member.user.service_account_user`; boolean, required, deprecated) — True if the user is a service account.
    - example `false`
  - `disabled_at` (`Member.user.disabled_at`; string, optional) — Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).
    - format `date-time`
  - `nickname` (`Member.user.nickname`; string, optional) — User's nickname. Used for display purposes only.
    - example `"Test User"`
  - `picture` (`Member.user.picture`; string, optional) — URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
    - format `uri`; example `"https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"`
  - `classic` (`Member.user.classic`; object, optional, deprecated) — Classic identifiers of the user.
    - `user_id` (`Member.user.classic.user_id`; integer, required)
      - min 0; max 2147483647
- `invite` (`Member.invite`; object, optional) — Pending invitation for membership.
  - `email` (`Member.invite.email`; string, required) — Email address of the invited user.
    - format `email`; example `"boaty.mcboatface@sumup.com"`
  - `expires_at` (`Member.invite.expires_at`; string, required)
    - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `metadata` (`Member.metadata`; object, optional) — Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
  - example `{}`
- `attributes` (`Member.attributes`; object, optional) — Object attributes that are modifiable only by SumUp applications.
  - example `{}`


Source: https://developer.sumup.com/api/schemas/Member/index.md