Skip to content

docs: document ownershipType field for external accounts #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
claude wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document ownershipType field for external accounts #801

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions mintlify/snippets/external-accounts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1893,6 +1893,36 @@ For business accounts, include business information:
}
```

### Account ownership type

Use the optional `ownershipType` field to indicate whether the external account belongs to the customer themselves or to a third party:

| Value | Description |
| --- | --- |
| `FIRST_PARTY` | The account belongs to the customer (e.g., their own bank account at another institution) |
| `THIRD_PARTY` | The account belongs to someone else (e.g., paying a vendor or sending to a family member) |

```json
{
"currency": "USD",
"customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"ownershipType": "THIRD_PARTY",
"accountInfo": {
"accountType": "USD_ACCOUNT",
"accountNumber": "987654321",
"routingNumber": "021000021",
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
"fullName": "Jane Smith"
}
Comment on lines +1914 to +1917

@greptile-apps greptile-apps Bot Aug 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 USD beneficiary address omitted

When a developer copies this THIRD_PARTY USD example, the request omits the beneficiary address that the same page identifies as required for US individual beneficiaries, causing the request to be under-specified for the documented compliance requirements.

Suggested change
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
"fullName": "Jane Smith"
}
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
"fullName": "Jane Smith",
"address": {
"line1": "123 Main Street",
"city": "San Francisco",
"postalCode": "94105",
"country": "US"
}
}

Context Used: mintlify/AGENTS.md (source)

Knowledge Base Used: Mintlify Documentation Site

Prompt To Fix With AI 
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 1914-1917

Comment:
**USD beneficiary address omitted**

When a developer copies this `THIRD_PARTY` USD example, the request omits the beneficiary address that the same page identifies as required for US individual beneficiaries, causing the request to be under-specified for the documented compliance requirements.

```suggestion
    "beneficiary": {
      "beneficiaryType": "INDIVIDUAL",
      "fullName": "Jane Smith",
      "address": {
        "line1": "123 Main Street",
        "city": "San Francisco",
        "postalCode": "94105",
        "country": "US"
      }
    }
```

**Context Used:** mintlify/AGENTS.md ([source](https://github.com/lightsparkdev/grid-api/blob/main/mintlify/AGENTS.md))

**Knowledge Base Used:** [Mintlify Documentation Site](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/mintlify-docs-site.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

}
}
```

<Info>
`ownershipType` is optional. When omitted, Grid does not assume a default. Use this field when your compliance requirements distinguish between first-party and third-party transfers.
</Info>

## Minimum required beneficiary fields

The following tables show the minimum required fields for individual and business beneficiaries. All other fields are optional but recommended for faster compliance review.
Expand Down
Loading