Membership fields

Field-level requirements and validation rules for account membership data. Use this alongside the membership permissions reference; for the model and lifecycle, see Account memberships.

Country requirements for account memberships

To invite an account member, you must provide specific account membership fields.

Requirements vary depending on the IBAN country. Swan automatically sets these requirements based on the member's permissions, accountCountry, and residencyAddress.country.

Field Requirements Legend

● REQ Required:Must be completed.

◐ CND Conditional:Required only in specific situations.

○ OPT Optional:Isn't required; may have a default value.

API field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇳🇱 Netherlands	🇪🇸 Spain	🇮🇹 Italy
accountId	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
canInitiatePayments	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
canManageAccountMembership	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
canManageBeneficiaries	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
canManageCards	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
canViewAccount	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
consentRedirectUrl	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND
email	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
language	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
residencyAddress.addressLine1	○ OPT	○ OPT	◐ CND	◐ CND	○ OPT	● REQ
residencyAddress.addressLine2	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
residencyAddress.city	○ OPT	○ OPT	◐ CND	◐ CND	○ OPT	● REQ
residencyAddress.country	○ OPT	○ OPT	◐ CND	◐ CND	○ OPT	● REQ
residencyAddress.postalCode	○ OPT	○ OPT	◐ CND	◐ CND	○ OPT	● REQ
residencyAddress.state	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
restrictedTo.firstName	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
restrictedTo.lastName	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
restrictedTo.phoneNumber	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND
restrictedTo.birthDate	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND	◐ CND
taxIdentificationNumber	○ OPT	○ OPT	◐ CND	○ OPT	○ OPT	◐ CND

Detailed optional and conditional requirements

Birthdate

The restrictedTo.birthDate field is required if any of the following account membership permissions are set to true:

• canManageBeneficiaries
• canInitiatePayments
• canManageAccountMembership
• canManageCards

Consent redirect URL

The consentRedirectUrl field is required when the account membership grants any permissions; the API returns a validation rejection if it's omitted. It's optional for view-only access or memberships with no permissions.

Default value for canManageCards

If no value is provided for canManageCards, it defaults to the value of canManageAccountMembership.

Phone number

The restrictedTo.phoneNumber field is required if any of the following account membership permissions are set to true:

• canManageBeneficiaries
• canInitiatePayments
• canManageAccountMembership

Residency address fields

The addressLine1, city, country, and postalCode fields are required regardless of residencyAddress.country, in the following cases:

• The accountCountry is 🇮🇹 Italy.
• The accountCountry is 🇩🇪 Germany or 🇳🇱 Netherlands, and one or both of the following account membership permissions are set to true:
  • canViewAccount
  • canInitiatePayments

Tax identification number

The taxIdentificationNumber field is required in the following cases:

• If both accountCountry and residencyAddress.country are 🇮🇹 Italy, and the account membership has the canInitiatePayments permission set to true.
• If both accountCountry and residencyAddress.country are 🇩🇪 Germany, and one or both of the following account membership permissions are set to true:
  • canViewAccount
  • canInitiatePayments

Validation rules

Certain account membership fields must follow specific validation patterns.

First name and last name

The restrictedTo.firstName and restrictedTo.lastName fields must match the following validation pattern:

/^[\p{L}]+(?:[-'\s][\p{L}]+)*'?$/u

This pattern accepts the following characters:

• Any Unicode letter (\p{L}), covering Latin, Cyrillic, Greek, Armenian, Georgian, Korean, Japanese, Chinese, and more.
• Spaces.
• Apostrophes (').
• Hyphens (-).

Names must start with a letter. Separators (hyphen, apostrophe, and space) must be followed by at least one letter and can't appear consecutively. Names may optionally end with an apostrophe.

Aligned with user creation

These validation rules are the same as those applied when creating users.