Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/preview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,5 @@ These features are in beta and available for testing. We use feedback to refine
| Feature | Description | ETA |
|---------|-------------|-----|
| <span style={{whiteSpace: 'nowrap'}}>[Card insurance](card-insurance)</span> | Comprehensive insurance coverage for Swan-issued cards including theft, fraud, and travel protection | <span style={{whiteSpace: 'nowrap'}}>In private beta</span> |
| <span style={{whiteSpace: 'nowrap'}}>[Multiple accounts](multiple-accounts)</span> | Enable one company account holder to create additional accounts without repeating onboarding or KYB | <span style={{whiteSpace: 'nowrap'}}>In private beta</span> |

</div>
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<h3 id="query-main">Query</h3>

<a href="https://explorer.swan.io?query=cXVlcnkgQWNjb3VudENyZWF0aW9uTGltaXQgewogIHByb2plY3RJbmZvIHsKICAgIG11bHRpcGxlQWNjb3VudHNTZXR0aW5ncyB7CiAgICAgIGFjY291bnRDcmVhdGlvbkxpbWl0CiAgICAgIGNhbk9wZW5BY2NvdW50CiAgICB9CiAgfQp9Cg%3D%3D&tab=api" className="explorer-badge">Open in API Explorer</a>

```graphql {2-5} showLineNumbers
query AccountCreationLimit {
projectInfo {
multipleAccountsSettings {
accountCreationLimit
canOpenAccount
}
}
}
```
<h3 id="payload-main">Payloads</h3>

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
}
}
}
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<h3 id="query-main">Query</h3>

<a href="https://explorer.swan.io?query=cXVlcnkgQWNjb3VudENyZWF0aW9uTGltaXQgewogIHByb2plY3RJbmZvIHsKICAgIG11bHRpcGxlQWNjb3VudHNTZXR0aW5ncyB7CiAgICAgIGFjY291bnRDcmVhdGlvbkxpbWl0CiAgICAgIGNhbk9wZW5BY2NvdW50CiAgICB9CiAgfQp9Cg%3D%3D&tab=api" className="explorer-badge">Open in API Explorer</a>

```graphql {2-5} showLineNumbers
query AccountCreationLimit {
projectInfo {
multipleAccountsSettings {
accountCreationLimit
canOpenAccount
}
}
}
```
<h3 id="payload-main">Payloads</h3>

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}
Expand Down
18 changes: 9 additions & 9 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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
],
},
Expand Down