Skip to content

Dev 1808: Union type enhancements #41

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
ShreyaThapa merged 3 commits into from
Nov 19, 2025
Merged

Dev 1808: Union type enhancements #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b594a2
Customer creation schema enhancments
ShreyaThapa Nov 17, 2025
08292bc
Document and Beneficial Owner schema enhancements
ShreyaThapa Nov 17, 2025
692adfb
bundle + fix warnings
ShreyaThapa Nov 17, 2025
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
476 changes: 345 additions & 131 deletions openapi.yml
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions specs/resources/customers/createListCustomers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ post:
- $ref: '../../schemas/customers/CreateCustomer.yml#/CreateVerifiedSolePropCustomer'
- $ref: '../../schemas/customers/CreateCustomer.yml#/CreateVerifiedBusinessCustomerWithController'
- $ref: '../../schemas/customers/CreateCustomer.yml#/CreateVerifiedBusinessCustomerWithInternationalController'
discriminator:
propertyName: type
mapping:
receive-only: '../../schemas/customers/CreateCustomer.yml#/CreateReceiveOnlyUser'
unverified: '../../schemas/customers/CreateCustomer.yml#/CreateUnverifiedCustomer'
personal: '../../schemas/customers/CreateCustomer.yml#/CreateVerifiedPersonalCustomer'
responses:
'201':
description: successful operation
Expand Down
6 changes: 3 additions & 3 deletions specs/resources/customers/retrieveUpdateCustomer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,8 @@ get:
schema:
oneOf:
- $ref: '../../schemas/customers/Customer.yml#/UnverifiedCustomer'
- $ref: '../../schemas/customers/Customer.yml#/UnverifiedBusinessCustomer'
- $ref: '../../schemas/customers/Customer.yml#/ReceiveOnlyCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedPersonalCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedSolePropCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedBusinessCustomer'
'403':
description: forbidden
Expand Down Expand Up @@ -160,6 +159,7 @@ post:
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpdateUnverifiedAndReceiveOnly'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpdateVerifiedPersonal'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpdateVerifiedBusiness'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpgradeToUnverified'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpgradeToVerifiedPersonal'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpgradeToVerifiedBusiness'
- $ref: '../../schemas/customers/UpdateCustomer.yml#/UpgradeToVerifiedSoleProp'
Expand All @@ -177,7 +177,7 @@ post:
schema:
oneOf:
- $ref: '../../schemas/customers/Customer.yml#/UnverifiedCustomer'
- $ref: '../../schemas/customers/Customer.yml#/UnverifiedBusinessCustomer'
- $ref: '../../schemas/customers/Customer.yml#/ReceiveOnlyCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedPersonalCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedSolePropCustomer'
- $ref: '../../schemas/customers/Customer.yml#/VerifiedBusinessCustomer'
Expand Down
9 changes: 9 additions & 0 deletions specs/resources/documents/createListBeneficialOwnerDocuments.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,18 @@ post:
multipart/form-data:
schema:
type: object
required:
- documentType
- file
properties:
documentType:
type: string
enum:
- passport
- license
- idCard
- other
example: license
file:
type: string
format: binary
Expand Down
9 changes: 9 additions & 0 deletions specs/resources/documents/createListCustomerDocuments.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,18 @@ post:
multipart/form-data:
schema:
type: object
required:
- documentType
- file
properties:
documentType:
type: string
enum:
- passport
- license
- idCard
- other
example: license
file:
type: string
format: binary
Expand Down
4 changes: 1 addition & 3 deletions specs/resources/exchanges/listCreateExchangesForAccount.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ post:
schema:
oneOf:
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateFinicitySecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateMXSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateFlinksSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreatePlaidSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateTokenBasedExchange'
responses:
'201':
description: Created
Expand Down
4 changes: 1 addition & 3 deletions specs/resources/exchanges/listCreateExchangesForCustomer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,8 @@ post:
schema:
oneOf:
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateFinicitySecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateMXSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateTokenBasedExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateMXOpenBankingExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreateFlinksSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreatePlaidSecureExchange'
- $ref: '../../schemas/exchanges/CreateExchange.yml#/CreatePlaidOpenBankingExchange'
responses:
'201':
Expand Down
24 changes: 20 additions & 4 deletions specs/resources/kba/verifyRetrieveKba.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,15 @@ get:
application/vnd.dwolla.v1.hal+json:
schema:
type: object
required:
- _links
- id
- questions
properties:
_links:
type: object
required:
- answer
properties:
answer:
type: object
Expand All @@ -82,21 +88,28 @@ get:
type: array
items:
type: object
required:
- id
- text
- answers
properties:
id:
type: string
example: 2355953375
example: '2355953375'
text:
type: string
example: In what county do you currently live?
answers:
type: array
items:
type: object
required:
- id
- text
properties:
id:
type: string
example: 2687969295
example: '2687969295'
text:
type: string
example: Pulaski
Expand Down Expand Up @@ -238,13 +251,16 @@ post:
type: array
items:
type: object
required:
- questionId
- answerId
properties:
questionId:
type: string
example: 2355953375
example: '2355953375'
answerId:
type: string
example: 2687969335
example: '2687969335'
responses:
'200':
description: created
Expand Down
2 changes: 1 addition & 1 deletion specs/resources/labels/createListCustomerLabels.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ post:
properties:
currency:
type: string
example: 12.34
example: '12.34'
value:
type: string
example: USD
Expand Down
14 changes: 14 additions & 0 deletions specs/schemas/beneficial-owners/BeneficialOwner.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ BeneficialOwner:
title: BeneficialOwner
description: Request body model for a Beneficial Owner
type: object
required:
- _links
- id
- firstName
- lastName
- address
- verificationStatus
- created
properties:
_links:
additionalProperties:
Expand All @@ -11,12 +19,18 @@ BeneficialOwner:
example: d3d6b41e-5567-4bc6-9c6e-0efd0a3e647e
firstName:
type: string
example: John
lastName:
type: string
example: Doe
address:
$ref: '../../schemas/common.yml#/components/schemas/InternationalAddress'
verificationStatus:
type: string
enum:
- verified
- document
- incomplete
example: verified
created:
type: string
Expand Down
7 changes: 7 additions & 0 deletions specs/schemas/beneficial-owners/BeneficialOwnership.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
BeneficialOwnership:
title: BeneficialOwnership
type: object
required:
- _links
- status
properties:
_links:
type: object
Expand All @@ -9,4 +12,8 @@ BeneficialOwnership:
$ref: '../../schemas/common.yml#/components/schemas/HalLink'
status:
type: string
enum:
- uncertified
- certified
- recertify
example: uncertified
11 changes: 9 additions & 2 deletions specs/schemas/beneficial-owners/CreateBeneficialOwner.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CreateUSBeneficialOwner:
title: CreateUSBeneficialOwner
description: Create a US Beneficial Owner (identified by SSN)
description: Create a US Beneficial Owner (identified by SSN). For US-based beneficial owners only. Use SSN for identity verification instead of passport.
required:
- firstName
- lastName
Expand All @@ -11,17 +11,21 @@ CreateUSBeneficialOwner:
properties:
firstName:
type: string
example: John
lastName:
type: string
example: Doe
dateOfBirth:
type: string
example: '1980-01-31'
address:
$ref: '../common.yml#/components/schemas/InternationalAddress'
ssn:
type: string
example: '123456789'
CreateInternationalBeneficialOwner:
title: CreateInternationalBeneficialOwner
description: Create an International Beneficial Owner (identified by Passport)
description: Create an International Beneficial Owner (identified by Passport). For non-US beneficial owners who don't have a US SSN. Requires passport information for identity verification.
required:
- firstName
- lastName
Expand All @@ -32,10 +36,13 @@ CreateInternationalBeneficialOwner:
properties:
firstName:
type: string
example: Jane
lastName:
type: string
example: Smith
dateOfBirth:
type: string
example: '1985-03-15'
address:
$ref: '../common.yml#/components/schemas/InternationalAddress'
passport:
Expand Down
28 changes: 16 additions & 12 deletions specs/schemas/customers/CreateCustomer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ CreateReceiveOnlyUser:
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand All @@ -40,6 +40,7 @@ CreateUnverifiedCustomer:
- firstName
- lastName
- email
- type
properties:
firstName:
type: string
Expand All @@ -50,12 +51,15 @@ CreateUnverifiedCustomer:
email:
type: string
example: accountAdmin@email.com
type:
type: string
const: unverified
ipAddress:
type: string
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand Down Expand Up @@ -92,7 +96,7 @@ CreateVerifiedPersonalCustomer:
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand All @@ -113,10 +117,10 @@ CreateVerifiedPersonalCustomer:
example: NY
postalCode:
type: string
example: 11101
example: '11101'
ssn:
type: string
example: 1234
example: '1234'
dateOfBirth:
type: string
example: 1980-09-12
Expand Down Expand Up @@ -153,7 +157,7 @@ CreateVerifiedSolePropCustomer:
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand All @@ -174,10 +178,10 @@ CreateVerifiedSolePropCustomer:
example: NY
postalCode:
type: string
example: 11101
example: '11101'
ssn:
type: string
example: 1234
example: '1234'
dateOfBirth:
type: string
example: 1980-09-12
Expand Down Expand Up @@ -232,7 +236,7 @@ CreateVerifiedBusinessCustomerWithController:
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand All @@ -253,7 +257,7 @@ CreateVerifiedBusinessCustomerWithController:
example: NY
postalCode:
type: string
example: 11101
example: '11101'
businessClassification:
type: string
example: 9ed3f670-7d6f-11e3-b1ce-5404a6144203
Expand Down Expand Up @@ -333,7 +337,7 @@ CreateVerifiedBusinessCustomerWithInternationalController:
example: 143.156.7.8
phone:
type: string
example: 5555555555
example: '5555555555'
correlationId:
type: string
example: fc451a7a-ae30-4404-aB95-e3553fcd733
Expand All @@ -354,7 +358,7 @@ CreateVerifiedBusinessCustomerWithInternationalController:
example: NY
postalCode:
type: string
example: 11101
example: '11101'
businessClassification:
type: string
example: 9ed3f670-7d6f-11e3-b1ce-5404a6144203
Expand Down
Loading
Loading