Skip to content
Closed
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
22 changes: 7 additions & 15 deletions mintlify/openapi.yaml

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

10 changes: 5 additions & 5 deletions mintlify/snippets/sandbox-verification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The **last 3 characters** of the `fullName` on `POST /customers` (with `customer

Because terminal suffixes resolve at creation, only `001` and `003` customers can be submitted for verification. Use any non-suffixed name to mint ready-to-transact approved customers, and a `001` name to exercise the full submission flow.

Submitting for verification has the same data requirements as production: full name, birth date, nationality, `taxIdType` + `taxIdentifier`, address, and an identity document uploaded via `POST /documents`. Anything missing comes back as `verificationStatus: RESOLVE_ERRORS` with one entry per problem in `errors`:
Submitting for verification has the same data requirements as production: full name, birth date, nationality, `idType` + `identifier`, address, and an identity document uploaded via `POST /documents`. Anything missing comes back as `verificationStatus: RESOLVE_ERRORS` with one entry per problem in `errors`:

```json
{
Expand All @@ -22,8 +22,8 @@ Submitting for verification has the same data requirements as production: full n
{
"resourceId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"type": "MISSING_FIELD",
"field": "taxIdentifier",
"reason": "Tax identifier is required"
"field": "identifier",
"reason": "Identifier is required"
},
{
"resourceId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
Expand Down Expand Up @@ -74,8 +74,8 @@ Fix-and-resubmit example — the standard integration loop:
-H "Content-Type: application/json" \
-d '{
"customerType": "INDIVIDUAL",
"taxIdType": "SSN",
"taxIdentifier": "111-22-3333",
"idType": "SSN",
"identifier": "111-22-3333",
"address": { "line1": "123 Main St", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US" }
}'

Expand Down
22 changes: 7 additions & 15 deletions openapi.yaml

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

Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,3 @@ title: Individual Customer Create Request
allOf:
- $ref: ./CustomerCreateRequest.yaml
- $ref: ./IndividualCustomerFields.yaml
- type: object
properties:
idType:
$ref: ./IdentificationType.yaml
identifier:
type: string
writeOnly: true
description: >-
The individual's tax identification number. Required to onboard the
individual as a US account holder. Only SSN and ITIN are currently
accepted for an individual account holder; other identification
types are rejected. Write-only — never returned in customer
responses.
example: 123-45-6789
18 changes: 10 additions & 8 deletions openapi/components/schemas/customers/IndividualCustomerFields.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,21 @@ allOf:
example: US
address:
$ref: ../common/Address.yaml
taxIdType:
idType:
$ref: ./IdentificationType.yaml
taxIdentifier:
identifier:
type: string
writeOnly: true
description: >-
Tax-identification number. For US persons this is the SSN (format
`###-##-####`) or ITIN. For non-US persons this is the tax number
issued by `taxIdCountryOfIssuance`.
The individual's identification number, required to onboard them as
a US account holder. Only SSN (format `###-##-####`) and ITIN are
currently accepted; other identification types are rejected.
Write-only — never returned in customer responses.
example: 123-45-6789
taxIdCountryOfIssuance:
countryOfIssuance:
type: string
description: >-
Country that issued the tax identifier (ISO 3166-1 alpha-2). Required
when `taxIdType` is `NON_US_TAX_ID`.
Country that issued the identification (ISO 3166-1 alpha-2). Required
when `idType` is `NON_US_TAX_ID`.
example: US
- $ref: ./CustomerEdd.yaml
2 changes: 1 addition & 1 deletion openapi/components/schemas/errors/FieldError.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ properties:
field:
type: string
description: Dot-notation path to the offending field.
example: taxIdentifier
example: identifier
constraint:
$ref: ./FieldConstraint.yaml
message:
Expand Down
Loading