diff --git a/docs/preview/index.mdx b/docs/preview/index.mdx index b3ae40dd7e..23e53fa4f7 100644 --- a/docs/preview/index.mdx +++ b/docs/preview/index.mdx @@ -28,6 +28,5 @@ These features are in beta and available for testing. We use feedback to refine | Feature | Description | ETA | |---------|-------------|-----| | [Card insurance](card-insurance) | Comprehensive insurance coverage for Swan-issued cards including theft, fraud, and travel protection | In private beta | -| [Multiple accounts](multiple-accounts) | Enable one company account holder to create additional accounts without repeating onboarding or KYB | In private beta | \ No newline at end of file diff --git a/docs/preview/multiple-accounts/guide-multiple-accounts-integration.mdx b/docs/topics/accounts/multiple-accounts/guide-multiple-accounts-integration.mdx similarity index 72% rename from docs/preview/multiple-accounts/guide-multiple-accounts-integration.mdx rename to docs/topics/accounts/multiple-accounts/guide-multiple-accounts-integration.mdx index a58617372c..b989618171 100644 --- a/docs/preview/multiple-accounts/guide-multiple-accounts-integration.mdx +++ b/docs/topics/accounts/multiple-accounts/guide-multiple-accounts-integration.mdx @@ -121,4 +121,70 @@ The mutation returns all of the requested information such as the account detail } } } +``` + +## Checking your account creation limit {#checking-your-account-creation-limit} + +### Query {#account-creation-limit-query} + +1. Call the `projectInfo` query (line 2). +1. Select `multipleAccountsSettings` (line 3). +1. Add `accountCreationLimit` and `canOpenAccount` to check your account creation limit (lines 4-5). + +

Query

+ +Open in API Explorer + +```graphql {2-5} showLineNumbers +query AccountCreationLimit { + projectInfo { + multipleAccountsSettings { + accountCreationLimit + canOpenAccount + } + } +} +``` +

Payloads

+ +The `multipleAccountsSettings` query returns a payload that indicates the current status of the multiple accounts feature for an account holder. + +**Example one: Multiple accounts not active** + +This payload shows the response when the multiple accounts feature has **not** been **activated**. + +- `accountCreationLimit`: `1` indicates that only the initial account can be created. +- `canOpenAccount`: `false` confirms that additional accounts cannot be created. + +```json {5,6} showLineNumbers +{ + "data": { + "projectInfo": { + "multipleAccountsSettings": { + "accountCreationLimit": 1, + "canOpenAccount": false + } + } + } +} +``` + +**Example two: Multiple accounts active** + +This payload shows the response when the multiple accounts feature has been **activated**. + +- `accountCreationLimit`: `6` shows that a maximum of six accounts can be created. +- `canOpenAccount`: `true` confirms that additional accounts can be opened. + +```json {5,6} showLineNumbers +{ + "data": { + "projectInfo": { + "multipleAccountsSettings": { + "accountCreationLimit": 6, + "canOpenAccount": true + } + } + } +} ``` \ No newline at end of file diff --git a/docs/preview/multiple-accounts/multiple-accounts.mdx b/docs/topics/accounts/multiple-accounts/index.mdx similarity index 80% rename from docs/preview/multiple-accounts/multiple-accounts.mdx rename to docs/topics/accounts/multiple-accounts/index.mdx index 9377ae26ac..f5faef9030 100644 --- a/docs/preview/multiple-accounts/multiple-accounts.mdx +++ b/docs/topics/accounts/multiple-accounts/index.mdx @@ -101,72 +101,9 @@ After the feature is activated, users may be granted a maximum number of account Users are restricted from creating new accounts after reaching the maximum limit. :::info Account status -Only accounts with an Opened status count toward the maximum limit. Suspended, Closing, or Closed accounts do not. +Only accounts with an `Opened` status count toward the maximum limit. `Suspended`, `Closing`, or `Closed` accounts do not. ::: -### Checking your account creation limit {#checking-your-account-creation-limit} - -1. Call the `projectInfo` query (line 2). -1. Select `multipleAccountsSettings` (line 3). -1. Add `accountCreationLimit` and `canOpenAccount` to check your account creation limit (lines 4-5). - -

Query

- -Open in API Explorer - -```graphql {2-5} showLineNumbers -query AccountCreationLimit { - projectInfo { - multipleAccountsSettings { - accountCreationLimit - canOpenAccount - } - } -} -``` -

Payloads

- -The `multipleAccountsSettings` query returns a payload that indicates the current status of the multiple accounts feature for an account holder. - -**Example one: Multiple accounts not active** - -This payload shows the response when the multiple accounts feature has **not** been **activated**. - -- `accountCreationLimit`: `1` indicates that only the initial account can be created. -- `canOpenAccount`: `false` confirms that additional accounts cannot be created. - -```json {5,6} showLineNumbers -{ - "data": { - "projectInfo": { - "multipleAccountsSettings": { - "accountCreationLimit": 1, - "canOpenAccount": false - } - } - } -} -``` - -**Example two: Multiple accounts active** - -This payload shows the response when the multiple accounts feature has been **activated**. - -- `accountCreationLimit`: `6` shows that a maximum of six accounts can be created. -- `canOpenAccount`: `true` confirms that additional accounts can be opened. - -```json {5,6} showLineNumbers -{ - "data": { - "projectInfo": { - "multipleAccountsSettings": { - "accountCreationLimit": 6, - "canOpenAccount": true - } - } - } -} -``` ## Shared account details {#shared-account-details} ### IBAN country {#iban-country} diff --git a/sidebars.js b/sidebars.js index 6c2f4a71c6..9942d9107a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -90,6 +90,15 @@ module.exports = { "topics/accounts/overview/guide-export", ], }, + { + type: "category", + label: "Multiple accounts", + link: { type: "doc", id: "topics/accounts/multiple-accounts/index" }, + collapsed: true, + items: [ + "/topics/accounts/multiple-accounts/guide-multiple-accounts-integration.mdx", + ], + }, { type: "category", label: "Account memberships", @@ -783,15 +792,6 @@ module.exports = { "preview/card-insurance/guide-insurance-integration", ], }, - { - type: "category", - label: "Multiple accounts", - link: { type: "doc", id: "preview/multiple-accounts/multiple-accounts" }, - collapsed: true, - items: [ - "preview/multiple-accounts/guide-multiple-accounts-integration", - ], - }, // Add more preview features here ], },