Skip to content

Commit af1544d

Browse files
pengyingpengying
committed
feat: adding kyb schema
1 parent a205da8 commit af1544d

28 files changed

Lines changed: 3223 additions & 12 deletions

‎mintlify/openapi.yaml‎

Lines changed: 1068 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎openapi.yaml‎

Lines changed: 1068 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎openapi/components/schemas/customers/BeneficialOwner.yaml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
type: object
2+
required:
3+
- id
4+
- customerId
5+
- roles
6+
- personalInfo
7+
- kycStatus
8+
- createdAt
9+
properties:
10+
id:
11+
type: string
12+
description: Unique identifier for this beneficial owner
13+
example: BeneficialOwner:019542f5-b3e7-1d02-0000-000000000001
14+
customerId:
15+
type: string
16+
description: The ID of the business customer this beneficial owner is associated with
17+
example: Customer:019542f5-b3e7-1d02-0000-000000000001
18+
roles:
19+
type: array
20+
items:
21+
$ref: ./BeneficialOwnerRole.yaml
22+
description: Roles of this person within the business
23+
example:
24+
- UBO
25+
- DIRECTOR
26+
ownershipPercentage:
27+
type: number
28+
format: float
29+
description: Percentage of ownership in the business (0-100)
30+
minimum: 0
31+
maximum: 100
32+
example: 51.0
33+
personalInfo:
34+
$ref: ./BeneficialOwnerPersonalInfo.yaml
35+
kycStatus:
36+
$ref: ./KycStatus.yaml
37+
createdAt:
38+
type: string
39+
format: date-time
40+
description: When this beneficial owner was created
41+
example: '2025-10-03T12:00:00Z'
42+
updatedAt:
43+
type: string
44+
format: date-time
45+
description: When this beneficial owner was last updated
46+
example: '2025-10-03T12:00:00Z'

‎openapi/components/schemas/customers/BeneficialOwnerCreateRequest.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
type: object
2+
required:
3+
- customerId
4+
- roles
5+
- personalInfo
6+
properties:
7+
customerId:
8+
type: string
9+
description: The ID of the business customer this beneficial owner is associated with
10+
example: Customer:019542f5-b3e7-1d02-0000-000000000001
11+
roles:
12+
type: array
13+
items:
14+
$ref: ./BeneficialOwnerRole.yaml
15+
description: Roles of this person within the business
16+
example:
17+
- UBO
18+
- DIRECTOR
19+
ownershipPercentage:
20+
type: number
21+
format: float
22+
description: Percentage of ownership in the business (0-100). Relevant when role includes UBO.
23+
minimum: 0
24+
maximum: 100
25+
example: 51.0
26+
personalInfo:
27+
$ref: ./BeneficialOwnerPersonalInfo.yaml

‎openapi/components/schemas/customers/BeneficialOwnerPersonalInfo.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
type: object
2+
required:
3+
- firstName
4+
- lastName
5+
properties:
6+
firstName:
7+
type: string
8+
description: First name of the individual
9+
example: Jane
10+
lastName:
11+
type: string
12+
description: Last name of the individual
13+
example: Smith
14+
middleName:
15+
type: string
16+
description: Middle name of the individual
17+
example: Marie
18+
birthDate:
19+
type: string
20+
format: date
21+
description: Date of birth in ISO 8601 format (YYYY-MM-DD)
22+
example: '1978-06-15'
23+
nationality:
24+
type: string
25+
description: Country of nationality (ISO 3166-1 alpha-2)
26+
example: US
27+
email:
28+
type: string
29+
format: email
30+
description: Email address of the individual
31+
example: jane.smith@acmecorp.com
32+
phoneNumber:
33+
type: string
34+
description: Phone number in E.164 format
35+
example: '+14155550192'
36+
pattern: '^\+[1-9]\d{1,14}$'
37+
address:
38+
$ref: ../common/Address.yaml
39+
personalIds:
40+
type: array
41+
description: Personal identification documents
42+
items:
43+
$ref: ./PersonalIdentification.yaml

‎openapi/components/schemas/customers/BeneficialOwnerRole.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
type: string
2+
enum:
3+
- UBO
4+
- DIRECTOR
5+
- COMPANY_OFFICER
6+
- CONTROL_PERSON
7+
- TRUSTEE
8+
- GENERAL_PARTNER
9+
description: Role of the beneficial owner within the business
10+
example: UBO

‎openapi/components/schemas/customers/BusinessInfo.yaml‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,48 @@ properties:
77
type: string
88
description: Legal name of the business
99
example: Acme Corporation, Inc.
10+
doingBusinessAs:
11+
type: string
12+
description: Trade name or DBA name of the business, if different from the legal name
13+
example: Acme
14+
country:
15+
type: string
16+
description: Country of incorporation or registration (ISO 3166-1 alpha-2)
17+
example: US
1018
registrationNumber:
1119
type: string
1220
description: Business registration number
13-
example: BRN-123456789
21+
example: '5523041'
22+
incorporatedOn:
23+
type: string
24+
format: date
25+
description: Date of incorporation in ISO 8601 format (YYYY-MM-DD)
26+
example: '2018-03-14'
27+
entityType:
28+
$ref: ./EntityType.yaml
1429
taxId:
1530
type: string
1631
description: Tax identification number
17-
example: EIN-987654321
32+
example: 47-1234567
33+
countriesOfOperation:
34+
type: array
35+
items:
36+
type: string
37+
description: List of countries where the business operates (ISO 3166-1 alpha-2)
38+
example:
39+
- US
40+
businessType:
41+
$ref: ./BusinessType.yaml
42+
purposeOfAccount:
43+
$ref: ./PurposeOfAccount.yaml
44+
sourceOfFunds:
45+
$ref: ./SourceOfFunds.yaml
46+
expectedActivityVolumes:
47+
$ref: ./ExpectedActivityVolumes.yaml
48+
expectedRecipientJurisdictions:
49+
type: array
50+
items:
51+
type: string
52+
description: List of countries where the business expects to send payments (ISO 3166-1 alpha-2)
53+
example:
54+
- US

‎openapi/components/schemas/customers/BusinessInfoUpdate.yaml‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,48 @@ properties:
55
type: string
66
description: Legal name of the business
77
example: Acme Corporation, Inc.
8+
doingBusinessAs:
9+
type: string
10+
description: Trade name or DBA name of the business, if different from the legal name
11+
example: Acme
12+
country:
13+
type: string
14+
description: Country of incorporation or registration (ISO 3166-1 alpha-2)
15+
example: US
816
registrationNumber:
917
type: string
1018
description: Business registration number
11-
example: BRN-123456789
19+
example: '5523041'
20+
incorporatedOn:
21+
type: string
22+
format: date
23+
description: Date of incorporation in ISO 8601 format (YYYY-MM-DD)
24+
example: '2018-03-14'
25+
entityType:
26+
$ref: ./EntityType.yaml
1227
taxId:
1328
type: string
1429
description: Tax identification number
15-
example: EIN-987654321
30+
example: 47-1234567
31+
countriesOfOperation:
32+
type: array
33+
items:
34+
type: string
35+
description: List of countries where the business operates (ISO 3166-1 alpha-2)
36+
example:
37+
- US
38+
businessType:
39+
$ref: ./BusinessType.yaml
40+
purposeOfAccount:
41+
$ref: ./PurposeOfAccount.yaml
42+
sourceOfFunds:
43+
$ref: ./SourceOfFunds.yaml
44+
expectedActivityVolumes:
45+
$ref: ./ExpectedActivityVolumes.yaml
46+
expectedRecipientJurisdictions:
47+
type: array
48+
items:
49+
type: string
50+
description: List of countries where the business expects to send payments (ISO 3166-1 alpha-2)
51+
example:
52+
- US

‎openapi/components/schemas/customers/BusinessType.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
type: string
2+
enum:
3+
- FINTECH
4+
- E_COMMERCE
5+
- BANKING
6+
- INSURANCE
7+
- HEALTHCARE
8+
- REAL_ESTATE
9+
- TECHNOLOGY
10+
- CONSULTING
11+
- MANUFACTURING
12+
- RETAIL
13+
- FOOD_AND_BEVERAGE
14+
- TRANSPORTATION
15+
- EDUCATION
16+
- ENTERTAINMENT
17+
- CRYPTO
18+
- OTHER
19+
description: The primary business area or industry
20+
example: FINTECH

‎openapi/components/schemas/customers/EntityType.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
type: string
2+
enum:
3+
- SOLE_PROPRIETORSHIP
4+
- PARTNERSHIP
5+
- LLC
6+
- CORPORATION
7+
- S_CORPORATION
8+
- NON_PROFIT
9+
- OTHER
10+
description: Legal entity type of the business
11+
example: LLC

0 commit comments

Comments
 (0)