Individual onboarding fields

Field reference for individual account holder onboarding, including country-specific requirements and available options.

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.

accountInfo

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

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.

Personal information

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
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 (accountAdmin.address)

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
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

Birth information (accountAdmin.birthInfo)

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
birthDate	○ 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

Financial information

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
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

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

¹ 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.

United States tax information (accountAdmin.unitedStatesTaxInfo)

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
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 (accountAdmin.userDeviceInfo)

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

Field	🇫🇷 France	🇩🇪 Germany	🇮🇹 Italy	🇳🇱 Netherlands	🇪🇸 Spain	🇧🇪 Belgium
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

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.

Swan-hosted onboarding

If you use Swan-hosted onboarding, 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.
• 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