Skip to content

docs: document ownershipType field for external accounts - #801

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260805
Open

docs: document ownershipType field for external accounts#801
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260805

Conversation

@claude

@claude claude Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add documentation for the new ownershipType field on external accounts
  • Field was added in feat: add optional ownershipType to external account schema #784 but docs were not updated
  • Documents the two values: FIRST_PARTY (customer's own account) and THIRD_PARTY (another person's account)
  • Includes example JSON showing usage

Test plan

  • Ran make lint - passes with 0 errors
  • Verified documentation renders correctly in the external accounts snippet

🤖 Generated with Claude Code

Add documentation for the new optional ownershipType field (FIRST_PARTY,
THIRD_PARTY) introduced in #784. This field helps platforms distinguish
between first-party transfers (to customer's own account) and third-party
transfers (to another person's account) for compliance purposes.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Aug 5, 2026 9:01am
grid-wallet-demo Ignored Ignored Aug 5, 2026 9:01am

Request Review

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Aug 5, 2026, 9:02 AM

@greptile-apps

greptile-apps Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR documents the optional external-account ownershipType field and its two supported values.

  • Adds descriptions for FIRST_PARTY and THIRD_PARTY.
  • Adds a third-party USD account request example and omission guidance.
  • The new example omits beneficiary address data that the page identifies as required for US USD accounts.

Confidence Score: 4/5

The documentation should be corrected before merging so the new USD example includes the beneficiary address required by the same page.

The ownershipType values and placement match the API schema, but developers copying the new third-party USD example would omit fields that the documentation identifies as required for US beneficiaries.

Files Needing Attention: mintlify/snippets/external-accounts.mdx

Important Files Changed

Filename Overview
mintlify/snippets/external-accounts.mdx Adds ownership-type guidance, but the new USD example conflicts with the page's documented minimum beneficiary requirements.
Prompt To Fix All With AI
### Issue 1
mintlify/snippets/external-accounts.mdx:1914-1917
**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"
      }
    }
```

---

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

Reviews (1): Last reviewed commit: "docs: document ownershipType field for e..." | Re-trigger Greptile

Comment on lines +1914 to +1917
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
"fullName": "Jane Smith"
}

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants