Skip to content

docs(kyc): align EDD sandbox example with OpenAPI schema #755

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jklein24 merged 1 commit into from
Jul 30, 2026
+5 −5
Merged

docs(kyc): align EDD sandbox example with OpenAPI schema #755

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
10 changes: 5 additions & 5 deletions mintlify/snippets/sandbox-verification.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The **last 3 characters** of the `fullName` on `POST /customers` (with `customer
|--------|---------|----------|
| **001** | `verificationStatus: IN_PROGRESS`, `kycStatus: PENDING` | KYC verification remains pending (manual review) |
| **002** | `verificationStatus: REJECTED`, `kycStatus: REJECTED` | KYC verification is rejected |
| **003** | `verificationStatus: RESOLVE_ERRORS` with `MISSING_FIELD` errors on `edd.*` fields | EDD is required — call `POST /customers/edd` with `customerId` and the requested fields, then retry `POST /verifications` |
| **003** | `verificationStatus: RESOLVE_ERRORS` with `MISSING_FIELD` errors on `edd.*` fields | EDD is required — call `PATCH /customers/{customerId}` with the requested fields, then retry `POST /verifications` |
| **Any other** | `verificationStatus: IN_PROGRESS`, `kycStatus: APPROVED` | KYC verification is approved |

EDD flow example:
Expand All @@ -32,14 +32,14 @@ curl -X POST "https://api.lightspark.com/grid/2025-10-13/verifications" \
-H "Content-Type: application/json" \
-d '{ "customerId": "Customer:..." }'

# Supply the EDD fields
curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers/edd" \
# Supply the EDD fields via PATCH
curl -X PATCH "https://api.lightspark.com/grid/2025-10-13/customers/Customer:..." \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{
"customerId": "Customer:...",
"customerType": "INDIVIDUAL",
"sourceOfWealthCategories": ["SALARY"],
"purposeOfAccount": "PERSONAL_SPEND",
"purposeOfAccount": "P2P_TRANSFERS",
"annualIncomeRange": "RANGE_100K_250K"
}'

Expand Down
Loading