Skip to main content

AccountHolderOnboardingBase

Base interface for account holder onboarding

interface AccountHolderOnboardingBase {
id: ID!
statusInfo: OnboardingStatusInfo!
supportingDocumentCollection: SupportingDocumentCollection
createdAt: DateTime!
updatedAt: DateTime!
projectInfo: ProjectInfo!
oAuthRedirectParameters: OAuthRedirectParameters
onboardingUrl: String
account: Account
}

Fields

AccountHolderOnboardingBase.id ● ID! non-null scalar

Unique identifier of an onboarding

AccountHolderOnboardingBase.statusInfo ● OnboardingStatusInfo! non-null interface

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

AccountHolderOnboardingBase.supportingDocumentCollection ● SupportingDocumentCollection object

Supporting document collection related to onboarding

AccountHolderOnboardingBase.createdAt ● DateTime! non-null scalar

Creation timestamp of the onboarding

AccountHolderOnboardingBase.updatedAt ● DateTime! non-null scalar

Last update timestamp of the onboarding

AccountHolderOnboardingBase.projectInfo ● ProjectInfo! non-null object

Project information set in the dashboard

AccountHolderOnboardingBase.oAuthRedirectParameters ● OAuthRedirectParameters object

OAuth parameters provided in order to redirect the user at the end of the flow

AccountHolderOnboardingBase.onboardingUrl ● String scalar

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

AccountHolderOnboardingBase.account ● Account object

Implemented By

CompanyAccountHolderOnboarding object ● IndividualAccountHolderOnboarding object