|
| 1 | +--- |
| 2 | +title: Account onboarding enhancements |
| 3 | +--- |
| 4 | + |
| 5 | +# Account onboarding enhancements |
| 6 | + |
| 7 | +Redesigned onboarding mutations and queries with cleaner naming, typed responses, and improved data collection for enhanced risk assessment and regulatory compliance. |
| 8 | + |
| 9 | +:::info Target availability |
| 10 | +This API is in active development and will be available by the end of Q1 2026. |
| 11 | +::: |
| 12 | + |
| 13 | +## Overview |
| 14 | + |
| 15 | +We are introducing a redesigned onboarding API that replaces the existing mutations and queries. The new API provides improved developer experience through consistent naming conventions, structured input types, and typed responses. |
| 16 | + |
| 17 | +### What's changing |
| 18 | + |
| 19 | +| Aspect | Current API | New API | |
| 20 | +|---|---|---| |
| 21 | +| **Naming** | Mixed patterns (`onboardIndividualAccountHolder`, `unauthenticatedOnboardPublic...`). | Consistent pattern (`createIndividualAccountHolderOnboarding`, `createPublicIndividualAccountHolderOnboarding`). | |
| 22 | +| **Input structure** | Flat input with all fields at root level. | Nested structure with `accountInfo`, `accountAdmin`, and `company` objects. | |
| 23 | +| **Data requirements** | Limited data collection. | New fields to strengthen risk assessment and compliance. | |
| 24 | +| **Response types** | Generic `Onboarding` type for all responses. | Typed `IndividualAccountHolderOnboarding` and `CompanyAccountHolderOnboarding`. | |
| 25 | +| **Registry data** | Automatically populates empty onboarding fields. | Dedicated query; no auto-population. | |
| 26 | + |
| 27 | +### Authentication patterns |
| 28 | + |
| 29 | +The new API uses a consistent pattern across all endpoints. |
| 30 | + |
| 31 | +| Endpoint type | Token required | Use case | |
| 32 | +|---|---|---| |
| 33 | +| `Public` mutations and queries | None | Public onboarding links. | |
| 34 | +| Standard mutations and queries | Project access token | Backend integrations, partner-initiated onboarding. | |
| 35 | +| `finalize` mutation | User access token | Completing onboarding after user identification. | |
| 36 | + |
| 37 | +## Individual onboarding |
| 38 | + |
| 39 | +### Create an individual onboarding |
| 40 | + |
| 41 | +Call the `createIndividualAccountHolderOnboarding` mutation with a project access token. |
| 42 | + |
| 43 | +| New mutation | Replaces | |
| 44 | +|---|---| |
| 45 | +| `createIndividualAccountHolderOnboarding` | `onboardIndividualAccountHolder` | |
| 46 | +| `createPublicIndividualAccountHolderOnboarding` | `unauthenticatedOnboardPublicIndividualAccountHolder` | |
| 47 | + |
| 48 | +The input uses a nested structure with two required objects: |
| 49 | + |
| 50 | +- `accountInfo`: Account-level details (`country`, `name`, `intendedUsages` <sup>(new)</sup>). |
| 51 | +- `accountAdmin`: Individual's personal information (`email`, `employmentStatus`, `monthlyIncome`, `address`, `sourcesOfFunds` <sup>(new)</sup>, etc.). |
| 52 | + |
| 53 | +```graphql |
| 54 | +input CreateIndividualAccountHolderOnboardingInput { |
| 55 | + accountInfo: IndividualAccountHolderOnboardingAccountInput! |
| 56 | + accountAdmin: IndividualAccountHolderOnboardingAccountAdminInput! |
| 57 | + oAuthRedirectParameters: OAuthRedirectParametersInput |
| 58 | +} |
| 59 | +``` |
| 60 | + |
| 61 | +### Update an individual onboarding |
| 62 | + |
| 63 | +Call the `updateIndividualAccountHolderOnboarding` mutation with a project access token. |
| 64 | + |
| 65 | +| New mutation | Replaces | |
| 66 | +|---|---| |
| 67 | +| `updateIndividualAccountHolderOnboarding` | `updateIndividualOnboarding` | |
| 68 | +| `updatePublicIndividualAccountHolderOnboarding` | `unauthenticatedUpdateIndividualOnboarding` | |
| 69 | + |
| 70 | +## Company onboarding |
| 71 | + |
| 72 | +### Create a company onboarding |
| 73 | + |
| 74 | +Call the `createCompanyAccountHolderOnboarding` mutation with a project access token. |
| 75 | + |
| 76 | +| New mutation | Replaces | |
| 77 | +|---|---| |
| 78 | +| `createCompanyAccountHolderOnboarding` | `onboardCompanyAccountHolder` | |
| 79 | +| `createPublicCompanyAccountHolderOnboarding` | `unauthenticatedOnboardPublicCompanyAccountHolder` | |
| 80 | + |
| 81 | +The input uses a nested structure with three required objects: |
| 82 | + |
| 83 | +- `accountInfo`: Account-level details (`country`, `name`, `intendedUsages` <sup>(new)</sup>). |
| 84 | +- `accountAdmin`: Legal representative's personal information (`email`, `firstName`, `lastName`, `typeOfRepresentation`, etc.). |
| 85 | +- `company`: Company details (`registrationNumber`, `name`, `legalForm`, `ultimateBeneficialOwners`, `representatives`, etc.). |
| 86 | + |
| 87 | +```graphql |
| 88 | +input CreateCompanyAccountHolderOnboardingInput { |
| 89 | + accountInfo: CompanyAccountHolderOnboardingAccountInput! |
| 90 | + accountAdmin: CompanyAccountHolderOnboardingAccountAdminInput! |
| 91 | + oAuthRedirectParameters: OAuthRedirectParametersInput |
| 92 | + company: CompanyInfoInput! |
| 93 | +} |
| 94 | +``` |
| 95 | + |
| 96 | +### Update a company onboarding |
| 97 | + |
| 98 | +Call the `updateCompanyAccountHolderOnboarding` mutation with a project access token. |
| 99 | + |
| 100 | +| New mutation | Replaces | |
| 101 | +|---|---| |
| 102 | +| `updateCompanyAccountHolderOnboarding` | `updateCompanyOnboarding` | |
| 103 | +| `updatePublicCompanyAccountHolderOnboarding` | `unauthenticatedUpdateCompanyOnboarding` | |
| 104 | + |
| 105 | +## Finalize onboarding |
| 106 | + |
| 107 | +The `finalizeAccountHolderOnboarding` mutation replaces `finalizeOnboarding`. It requires a **user access token** and returns an `AccountHolderOnboarding` union type. |
| 108 | + |
| 109 | +| New mutation | Replaces | |
| 110 | +|---|---| |
| 111 | +| `finalizeAccountHolderOnboarding` | `finalizeOnboarding` | |
| 112 | + |
| 113 | +## Queries |
| 114 | + |
| 115 | +### Retrieve onboarding information |
| 116 | + |
| 117 | +| New query | Authentication | Replaces | |
| 118 | +|---|---|---| |
| 119 | +| `publicAccountHolderOnboarding` | None | `onboardingInfo` | |
| 120 | +| `accountHolderOnboarding` | Project access token | `onboarding` | |
| 121 | +| `accountHolderOnboardings` | Project access token | `onboardings` | |
| 122 | + |
| 123 | +Single-onboarding queries return a payload union that includes the `AccountHolderOnboarding` on success. The `accountHolderOnboardings` query returns an `AccountHolderOnboardingConnection` for [paginated results](/developers/using-api/pagination). |
| 124 | + |
| 125 | +### Company registry data |
| 126 | + |
| 127 | +A new dedicated query retrieves company information from official registries, enabling pre-fill capabilities for smoother onboarding. Currently available for companies registered in **France (`FRA`) only**. This replaces the previous behavior where empty onboarding fields were automatically populated with registry data. |
| 128 | + |
| 129 | +| New query | Authentication | |
| 130 | +|---|---| |
| 131 | +| `companyInfoRegistryData` | Project access token | |
| 132 | + |
| 133 | +The query requires a `registrationNumber` and `residencyAddressCountry`. |
| 134 | + |
| 135 | +:::caution Behavior change |
| 136 | +The new API **does not** automatically populate onboarding fields with registry data. You must explicitly query the registry, then use that data when creating or updating the onboarding. |
| 137 | +::: |
| 138 | + |
| 139 | +#### Query |
| 140 | + |
| 141 | +```graphql |
| 142 | +query GetCompanyRegistryData { |
| 143 | + companyInfoRegistryData( |
| 144 | + input: { |
| 145 | + registrationNumber: "123456789" |
| 146 | + residencyAddressCountry: FRA |
| 147 | + } |
| 148 | + ) { |
| 149 | + ... on CompanyInfoRegistryDataSuccessPayload { |
| 150 | + companyInfo { |
| 151 | + name |
| 152 | + legalForm |
| 153 | + registrationDate |
| 154 | + address { |
| 155 | + addressLine1 |
| 156 | + city |
| 157 | + postalCode |
| 158 | + country |
| 159 | + } |
| 160 | + ultimateBeneficialOwners { |
| 161 | + firstName |
| 162 | + lastName |
| 163 | + } |
| 164 | + representatives { |
| 165 | + ... on OnboardingIndividualRepresentative { |
| 166 | + firstName |
| 167 | + lastName |
| 168 | + roles |
| 169 | + } |
| 170 | + } |
| 171 | + } |
| 172 | + } |
| 173 | + ... on CompanyRegistryNotFoundRejection { |
| 174 | + message |
| 175 | + registrationNumber |
| 176 | + country |
| 177 | + } |
| 178 | + } |
| 179 | +} |
| 180 | +``` |
| 181 | + |
| 182 | +## Field reference |
| 183 | + |
| 184 | +:::warning Work in progress |
| 185 | +Field requirements and validations are being finalized. This section will be updated before release. |
| 186 | +::: |
| 187 | + |
| 188 | +The following pages provide complete field mappings from the deprecated API to the new API: |
| 189 | + |
| 190 | +- [Individual onboarding fields](./individual) |
| 191 | +- [Company onboarding fields](./company) |
| 192 | + |
| 193 | +Field requirements vary by country. French company onboardings support pre-fill via the `companyInfoRegistryData` query for company, representative, and UBO fields. |
| 194 | + |
| 195 | +## Response types |
| 196 | + |
| 197 | +### IndividualAccountHolderOnboarding |
| 198 | + |
| 199 | +```graphql |
| 200 | +type IndividualAccountHolderOnboarding implements AccountHolderOnboardingBase { |
| 201 | + id: ID! |
| 202 | + statusInfo: OnboardingStatusInfo! |
| 203 | + supportingDocumentCollection: SupportingDocumentCollection |
| 204 | + createdAt: DateTime! |
| 205 | + updatedAt: DateTime! |
| 206 | + accountInfo: IndividualAccountHolderOnboardingAccount |
| 207 | + accountAdmin: IndividualAccountHolderOnboardingAccountAdmin |
| 208 | +} |
| 209 | +``` |
| 210 | + |
| 211 | +### CompanyAccountHolderOnboarding |
| 212 | + |
| 213 | +```graphql |
| 214 | +type CompanyAccountHolderOnboarding implements AccountHolderOnboardingBase { |
| 215 | + id: ID! |
| 216 | + statusInfo: OnboardingStatusInfo! |
| 217 | + supportingDocumentCollection: SupportingDocumentCollection |
| 218 | + createdAt: DateTime! |
| 219 | + updatedAt: DateTime! |
| 220 | + accountInfo: CompanyAccountHolderOnboardingAccount |
| 221 | + accountAdmin: CompanyAccountHolderOnboardingAccountAdmin |
| 222 | + company: CompanyInfo |
| 223 | +} |
| 224 | +``` |
| 225 | + |
| 226 | +### AccountHolderOnboarding union |
| 227 | + |
| 228 | +```graphql |
| 229 | +union AccountHolderOnboarding = IndividualAccountHolderOnboarding | CompanyAccountHolderOnboarding |
| 230 | +``` |
0 commit comments