Individual onboarding fields

Use this reference to determine which fields are required, optional, conditional, or not applicable for each country when creating an individual onboarding. For GraphQL types and validation constraints, refer to CreateIndividualAccountHolderOnboardingInput in the API reference.

Supporting documents

All requested supporting documents must be submitted to complete onboarding.

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.

⊘ N/A Not applicable: Not used.

Account information

Related field: accountInfo

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
country	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
name	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT

Available options

• country: FRA, DEU, ESP, NLD, ITA, BEL.

Account administrator

Related field: accountAdmin

Account admin fields and sign-up

Although many accountAdmin fields are optional during onboarding, they are required when the user signs up. We recommend collecting and sending this information before the end of the onboarding flow.

If you provide accountAdmin information through the API and include the onboarding ID in the OAuth redirect parameters, Swan pre-fills this information during the user sign-up flow.

Personal information

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
email	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
firstName	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
lastName	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
nationality	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
preferredLanguage	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
signupDate	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
acquisitionChannel	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT

acquisitionChannel is hidden from end users. Provide it through your backend integration only.

Available options

• preferredLanguage: de, en, es, fi, fr, it, nl, pt.
• acquisitionChannel: InboundOrganic, InboundReferral, OutboundSales, OutboundAccountingFirm.

Address

Related field: accountAdmin.address

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
addressLine1	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
addressLine2	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
city	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
country	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
postalCode	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
state	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT

country only accepts country codes. For an address in a territory such as Réunion, send FRA and keep the territory detail in city and postalCode.

If the address is in an area where Swan doesn't offer accounts, the onboarding is Invalid. See country coverage.

Birth information

Related field: accountAdmin.birthInfo

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
birthDate	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
city	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
country	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
postalCode	○ OPT ¹	⊘ N/A	⊘ N/A	⊘ N/A	⊘ N/A	⊘ N/A

¹ postalCode is only for people born in France. Don't provide it otherwise.

All birth fields are optional in the API. If you don't prefill them, the account admin is asked at sign-up.

country only accepts country codes. For someone born in a territory such as Réunion, send FRA.

Financial information

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
employmentStatus	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
monthlyIncome	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
sourcesOfFunds	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT

Available options

employmentStatus

Craftsman, Employee, Entrepreneur, Farmer, Manager, Practitioner, Retiree, ShopOwner, Student, Unemployed.

monthlyIncome

LessThan500, Between500And1500, Between1500And3000, Between3000And4500, MoreThan4500.

sourcesOfFunds

BusinessActivity, CapitalGains, FamilyContributions, InheritanceOrGift, Other, PersonalWealth, RealEstateIncome, Salary, SaleOfAssets, SelfEmployment.

Tax information

Related field: accountAdmin.taxIdentificationNumber

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
taxIdentificationNumber	◐ CND ²	● REQ	● REQ	● REQ	◐ CND ²	◐ CND ²

² taxIdentificationNumber is required if any of the following conditions are true:

• accountAdmin.address.country is different from accountInfo.country.
• accountAdmin.address.country is Germany, Italy, or Belgium.

US tax information

Related field: accountAdmin.unitedStatesTaxInfo

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
isUnitedStatesPerson	● REQ	● REQ	● REQ	● REQ	● REQ	● REQ
unitedStatesTaxIdentificationNumber	◐ CND ³	◐ CND ³	◐ CND ³	◐ CND ³	◐ CND ³	◐ CND ³

³ unitedStatesTaxIdentificationNumber is required if accountAdmin.unitedStatesTaxInfo.isUnitedStatesPerson is true.

User device information

Related field: accountAdmin.userDeviceInfo

These fields are hidden from end users. Provide them through your backend integration only.

Field	🇫🇷 France	🇧🇪 Belgium	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain
geoloc.lat	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
geoloc.lng	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
ip	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT
userAgent	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT	○ OPT

OAuth redirect parameters

Related field: oAuthRedirectParameters

These fields are hidden from end users. Provide them through your backend integration only.

Field	Description
redirectUrl	URL to redirect to after the OAuth flow.
state	Opaque value passed through the OAuth flow.

No-code Web Banking

If you use Swan's no-code Web Banking, the following fields are collected during the onboarding and sign-up flows.

• accountAdmin.firstName, lastName, nationality.
• accountAdmin.address: addressLine1, city, country, postalCode.
• accountAdmin.birthInfo: birthDate, city, country. postalCode is only collected when the account country is France and country is France.
• accountAdmin.unitedStatesTaxInfo.

API mapping

Use this table to map fields from the deprecated API to the new API.

Account

Deprecated field	New field
accountCountry	accountInfo.country
accountName	accountInfo.name

Account administrator

Deprecated field	New field
-	accountAdmin.acquisitionChannel
residencyAddress.addressLine1	accountAdmin.address.addressLine1
residencyAddress.addressLine2	accountAdmin.address.addressLine2
residencyAddress.city	accountAdmin.address.city
residencyAddress.country	accountAdmin.address.country
residencyAddress.postalCode	accountAdmin.address.postalCode
residencyAddress.state	accountAdmin.address.state
-	accountAdmin.birthInfo.birthDate
-	accountAdmin.birthInfo.city
-	accountAdmin.birthInfo.country
-	accountAdmin.birthInfo.postalCode
email	accountAdmin.email
employmentStatus	accountAdmin.employmentStatus
-	accountAdmin.firstName
-	accountAdmin.lastName
monthlyIncome	accountAdmin.monthlyIncome
-	accountAdmin.nationality
language	accountAdmin.preferredLanguage
-	accountAdmin.signupDate
-	accountAdmin.sourcesOfFunds
taxIdentificationNumber	accountAdmin.taxIdentificationNumber
-	accountAdmin.unitedStatesTaxInfo.isUnitedStatesPerson
-	accountAdmin.unitedStatesTaxInfo.unitedStatesTaxIdentificationNumber
-	accountAdmin.userDeviceInfo.geoloc.lat
-	accountAdmin.userDeviceInfo.geoloc.lng
-	accountAdmin.userDeviceInfo.ip
-	accountAdmin.userDeviceInfo.userAgent