Skip to main content

Onboarding

Information provided during the onboarding process of an individual or a company

type Onboarding {
  id: String!
  accountName: String
  accountCountry: AccountCountry!
  acquisitionChannel: AcquisitionChannel
  createdAt: DateTime!
  email: String
  finalizedAt: DateTime
  language: AccountLanguage
  info: OnboardingAccountHolderInfo!
  accountHolder: AccountHolder
  onboardingUrl: String
  oAuthRedirectParameters: OAuthRedirectParameters
  statusInfo: OnboardingStatusInfo!
  tcuUrl: String!
  supportingDocumentCollection: SupportingDocumentCollection!
  updatedAt: DateTime!
  account: Account
  legalRepresentativeAcceptedIdentificationLevels: [IdentificationLevel]!
}

Fields

`Onboarding.id` ● `String!` non-null scalar

Unique identifier of an onboarding

`Onboarding.accountName` ● `String` scalar

Account name

`Onboarding.accountCountry` ● `AccountCountry!` non-null enum

Account Country

`Onboarding.acquisitionChannel` ● `AcquisitionChannel` enum

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

`Onboarding.createdAt` ● `DateTime!` non-null scalar

Creation date

`Onboarding.email` ● `String` scalar

Email

`Onboarding.finalizedAt` ● `DateTime` scalar

Finalization date

`Onboarding.language` ● `AccountLanguage` enum

Language of the onboarding process.

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

`Onboarding.info` ● `OnboardingAccountHolderInfo!` non-null interface

Information regarding the Individual or the company to onboard

`Onboarding.accountHolder` ● `AccountHolder` object

Account holder created at the end of the onboarding process

`Onboarding.onboardingUrl` ● `String` scalar

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

`Onboarding.oAuthRedirectParameters` ● `OAuthRedirectParameters` object

Extra parameters provided by partner

`Onboarding.statusInfo` ● `OnboardingStatusInfo!` non-null interface

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

`Onboarding.tcuUrl` ● `String!` non-null scalar

Swan TCU URL

`Onboarding.supportingDocumentCollection` ● `SupportingDocumentCollection!` non-null object

List of supporting document collection owned by the account holder.

`Onboarding.updatedAt` ● `DateTime!` non-null scalar

Creation date

`Onboarding.account` ● `Account` object

Account opened after the onboarding finalization

`Onboarding.legalRepresentativeAcceptedIdentificationLevels` ● `[IdentificationLevel]!` non-null enum

List of accepted identification level for the legal representative

Returned By

onboarding query

Member Of

AccountHolder object ● CapitalDepositCase object ● FinalizeOnboardingSuccessPayload object ● OnboardCompanyAccountHolderSuccessPayload object ● OnboardIndividualAccountHolderSuccessPayload object ● OnboardingEdge object ● OnboardingNotCompletedRejection object ● Shareholder object