Skip to content

Beneficial Owner Resource #81

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Beneficial Owner Resource #81

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8278fc1
Beneficial Owner Resource
axshani Mar 14, 2024
b14e11a
update schemas
axshani Mar 17, 2024
2e56def
fix Beneficial Owner attributes
axshani Mar 17, 2024
b89477b
patch_beneficial_owners
axshani Mar 19, 2024
752a1aa
Merge branch 'main' into BeneficialOwner
axshani Mar 21, 2024
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
3 changes: 3 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"/applications/{applicationId}/documents/{documentId}/download/back": {
"$ref": "./schemas/application_paths.json#/download_back_side_document"
},
"/beneficial-owner/{beneficialOwnerId}": {
"$ref": "./schemas/beneficial_owner_paths.json#/beneficial_owners"
},
"/application-forms/{applicationFormId}": {
"$ref": "./schemas/application_paths.json#/application_form"
},
Expand Down
64 changes: 64 additions & 0 deletions schemas/beneficial_owner.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"title": "Beneficial Owner Resource",
"type": "object",
"properties": {
"id": {
"$ref": "types.json#/definitions/identifier"
},
"type": {
"type": "string",
"default": "beneficialOwner"
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["Approved", "Denied", "PendingReview"]
},
"fullName": {
"$ref": "types.json#/definitions/fullName"
},
"email": {
"$ref": "types.json#/definitions/email"
},
"phone": {
"$ref": "types.json#/definitions/phone"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"passport": {
"type": "string"
},
"nationality": {
"$ref": "types.json#/definitions/country"
},
"address": {
"type": "object"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"occupation": {
"$ref": "types.json#/definitions/occupation"
},
"annualIncome": {
"$ref": "types.json#/definitions/annualIncome"
},
"sourceOfIncome": {
"$ref": "types.json#/definitions/sourceOfIncome"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"id",
"type",
"attributes"
]
}
98 changes: 98 additions & 0 deletions schemas/beneficial_owner_paths.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
{
"updateBeneficialOwnerRequest": {
"title": "Update Beneficial Owner",
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "beneficialOwner"
},
"attributes": {
"type": "object",
"properties": {
"occupation": {
"$ref": "types.json#/definitions/occupation"
},
"annualIncome": {
"$ref": "types.json#/definitions/annualIncome"
},
"sourceOfIncome": {
"$ref": "types.json#/definitions/sourceOfIncome"
}
},
"relationships": {
"type": "object",
"properties": {
"application": {
"$ref": "types.json#/definitions/Relationship"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type",
"attributes"
]
},
"UnitBeneficialOwnerResponse": {
"type": "object",
"title": "UnitBeneficialOwnerResponse",
"properties": {
"data": {
"$ref": "beneficial_owner.json"
}
}
},
"patch_beneficial_owners": {
"patch": {
"tags": [
"Update Beneficial Owner"
],
"operationId": "execute",
"summary": "Update Beneficial Owner",
"description": "Update an Beneficial Owner via API ",
"parameters": [
{
"schema": {
"type": "string"
},
"name": "beneficialOwnerId",
"in": "path",
"required": true,
"description": "ID of the Beneficial Owner to update"
}
],
"requestBody": {
"description": "Update Beneficial Owner Request",
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/updateBeneficialOwnerRequest"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/vnd.api+json; charset=utf-8": {
"schema": {
"$ref": "#/UnitBeneficialOwnerResponse"
}
}
}
}
}
}
}
}
}
36 changes: 0 additions & 36 deletions schemas/update_application.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,41 +155,6 @@
"attributes"
]
},
"patchBusinessApplicationBeneficialOwner": {
"title": "Patch Business Application",
"type": "object",
"properties": {
"type": { "type": "string", "default": "beneficialOwner" },
"attributes": {
"type": "object",
"properties": {
"occupation": {
"$ref": "types.json#/definitions/occupation"
},
"annualIncome": {
"$ref": "types.json#/definitions/annualIncome"
},
"sourceOfIncome": {
"$ref": "types.json#/definitions/sourceOfIncome"
}
},
"relationships": {
"type": "object",
"properties": {
"application": {
"$ref": "types.json#/definitions/Relationship"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type",
"attributes"
]
},
"patchTrustApplication": {
"title": "Patch Trust Application",
"type": "object",
Expand Down Expand Up @@ -250,7 +215,6 @@
"oneOf": [
{ "$ref": "#/definitions/patchBusinessApplication" },
{ "$ref": "#/definitions/patchBusinessApplicationOfficer" },
{ "$ref": "#/definitions/patchBusinessApplicationBeneficialOwner" },
{ "$ref": "#/definitions/patchSoleProprietorApplication" },
{ "$ref": "#/definitions/patchIndividualApplication" },
{ "$ref": "#/definitions/patchTrustApplication" }
Expand Down