Skip to main content

OnboardingInfo

No description

type OnboardingInfo {
  id: String!
  accountName: String
  accountCountry: AccountCountry
  acquisitionChannel: AcquisitionChannel
  email: String
  language: AccountLanguage
  info: OnboardingAccountHolderInfo!
  onboardingUrl: String!
  onboardingState: OnboardingState @deprecated
  redirectUrl: String!
  projectInfo: ProjectInfo
  verificationFlow: VerificationFlow! @deprecated
  oAuthRedirectParameters: OAuthRedirectParameters
  statusInfo: OnboardingStatusInfo!
  supportingDocumentCollection: SupportingDocumentCollection!
  legalRepresentativeAcceptedIdentificationLevels: [IdentificationLevel]!
  tcuUrl: String!
}

Fields​

OnboardingInfo.id ● String! non-null scalar​

Unique identifier of an onboarding

OnboardingInfo.accountName ● String scalar​

Account name

OnboardingInfo.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

OnboardingInfo.acquisitionChannel ● AcquisitionChannel enum​

Acquisition Channel to specify how the user joined, such as "InboundOrganic", "OutboundSales", etc.

OnboardingInfo.email ● String scalar​

email

OnboardingInfo.language ● AccountLanguage enum​

Language of the onboarding process.

  • Accepted languages: ["en", "fr", "nl", "de", "it", "es", "pt", "fi"]

OnboardingInfo.info ● OnboardingAccountHolderInfo! non-null interface​

Information regarding the Individual or the company to onboard

OnboardingInfo.onboardingUrl ● String! non-null scalar​

Redirect the legal representative of a new account holder to this URL to start the onboarding process

OnboardingInfo.onboardingState ● OnboardingState deprecated enum​

DEPRECATED

use statusInfo instead

Current computed state of onboarding @deprecated(reason: "use statusInfo instead")

OnboardingInfo.redirectUrl ● String! non-null scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking.

OnboardingInfo.projectInfo ● ProjectInfo object​

Project infos you set in the dashboard

OnboardingInfo.verificationFlow ● VerificationFlow! deprecated non-null enum​

DEPRECATED

The progressive verification flow is no longer a supported feature, as all new account holders are now required to complete full KYC upfront.

@deprecated(reason: "The progressive verification flow is no longer a supported feature, as all new account holders are now required to complete full KYC upfront.")

OnboardingInfo.oAuthRedirectParameters ● OAuthRedirectParameters object​

Extra parameters provided by partner

OnboardingInfo.statusInfo ● OnboardingStatusInfo! non-null interface​

Status (valid/invalid/finalized) and details of errors on fields

OnboardingInfo.supportingDocumentCollection ● SupportingDocumentCollection! non-null object​

Supporting document collection related to onboarding.

OnboardingInfo.legalRepresentativeAcceptedIdentificationLevels ● [IdentificationLevel]! non-null enum​

List of accepted identification level for the legal representative

OnboardingInfo.tcuUrl ● String! non-null scalar​

Swan TCU URL

Member Of​

UpdateCompanyOnboardingSuccessPayload object ● UpdateIndividualOnboardingSuccessPayload object