Skip to content

feat: add expected jurisdiction EDD fields to individual customers #1029

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

Open
Ethan-Minghao wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add expected jurisdiction EDD fields to individual customers #1029

Show file tree
Hide file tree
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
14 changes: 14 additions & 0 deletions mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion mintlify/snippets/kyc/customer-data-requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Documents, uploaded via `POST /documents` — identity documents also require `d
- **Identity document** — a `PASSPORT` (single image), or a `DRIVERS_LICENSE` / `NATIONAL_ID` uploaded as separate `FRONT` and `BACK` images via the `side` field.
- **Proof of address** — requested in some jurisdictions and for some currencies. Any of `UTILITY_BILL`, `ELECTRICITY_BILL`, `RENT_OR_LEASE_AGREEMENT`, `BANK_STATEMENT`, or `TAX_RETURN`, dated within the last 3 months.

Some jurisdictions, flows, and volume tiers also require enhanced due diligence. These are optional top-level fields on the individual customer — `sourceOfFundsCategories`, `sourceOfWealthCategories`, `purposeOfAccount`, `expectedMonthlyTransactionCount`, `expectedMonthlyTransactionVolume`, `annualIncomeRange`, `netWorthRange`, and `pepStatus`. The provider decides which apply; you learn which ones through `MISSING_FIELD` errors on `POST /verifications` rather than up front. Each `*Categories` field that includes `OTHER` also requires its matching `*OtherDescription`.
Some jurisdictions, flows, and volume tiers also require enhanced due diligence. These are optional top-level fields on the individual customer — `sourceOfFundsCategories`, `sourceOfWealthCategories`, `purposeOfAccount`, `expectedMonthlyTransactionCount`, `expectedMonthlyTransactionVolume`, `expectedRecipientJurisdictions`, `expectedTransactionJurisdictions`, `annualIncomeRange`, `netWorthRange`, and `pepStatus`. The provider decides which apply; you learn which ones through `MISSING_FIELD` errors on `POST /verifications` rather than up front. Each `*Categories` field that includes `OTHER` also requires its matching `*OtherDescription`.

### KYB — business customers

Expand Down
14 changes: 14 additions & 0 deletions openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions openapi/components/schemas/customers/CustomerEdd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,22 @@ properties:
$ref: ./ExpectedMonthlyTransactionCount.yaml
expectedMonthlyTransactionVolume:
$ref: ./ExpectedMonthlyTransactionVolume.yaml
expectedRecipientJurisdictions:
type: array
items:
type: string
description: List of countries where the customer expects to send payments (ISO 3166-1 alpha-2)
example:
- US
expectedTransactionJurisdictions:
type: array
items:
type: string
description: >-
List of countries the customer's transactions are expected to involve, in
either direction (ISO 3166-1 alpha-2)
example:
- US
annualIncomeRange:
$ref: ./AnnualIncomeRange.yaml
netWorthRange:
Expand Down
Loading