Skip to content
Merged
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
5 changes: 4 additions & 1 deletion openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Unit OpenAPI specifications",
"description": "An OpenAPI specifications for unit-sdk clients",
"version": "0.3.2"
"version": "0.4.0"
},
"servers": [
{
Expand Down Expand Up @@ -47,6 +47,9 @@
"/beneficial-owner/{beneficialOwnerId}": {
"$ref": "./schemas/application/applicationPaths.json#/updateBusinessBeneficialOwner"
},
"/applications/{applicationId}/missing-fields": {
"$ref": "./schemas/application/applicationPaths.json#/applicationMissingFields"
},
"/accounts": {
"$ref": "./schemas/account/accountPaths.json#/accounts"
},
Expand Down
83 changes: 82 additions & 1 deletion schemas/application/application.json
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,48 @@
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
},
"sourceOfFunds": {
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessSourceOfFunds"
},
"sourceOfFundsDescription": {
"type": "string"
},
"businessIndustry": {
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessIndustry"
},
"businessDescription": {
"type": "string"
},
"isRegulated": {
"type": "boolean"
},
"regulatorName": {
"type": "string"
},
"usNexus": {
"type": "array",
"items": {
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessUsNexus"
}
},
"accountPurpose": {
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessAccountPurpose"
},
"accountPurposeDescription": {
"type": "string"
},
"accountPurposeDetail": {
"type": "string"
},
"transactionVolume": {
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessTransactionVolume"
},
"transactionVolumeDescription": {
"type": "string"
},
"stockExchangeName": {
"type": "string"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -625,7 +667,46 @@
"businessVertical": {
"$ref": "../types.json#/components/schemas/BusinessVertical"
},
"website": { "type": "string" }
"website": { "type": "string" },
"accountPurpose": {
"oneOf": [
{
"$ref": "./createApplication.json#/components/schemas/ThreadIndividualAccountPurpose"
},
{
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessAccountPurpose"
}
]
},
"accountPurposeDetail": {
"type": "string"
},
"sourceOfFunds": {
"oneOf": [
{
"$ref": "./createApplication.json#/components/schemas/ThreadIndividualSourceOfFunds"
},
{
"$ref": "./createApplication.json#/components/schemas/ThreadBusinessSourceOfFunds"
}
]
},
"transactionVolume": {
"oneOf": [
{
"$ref": "./createApplication.json#/components/schemas/ThreadIndividualTransactionVolume"
},
{
"$ref": "./createApplication.json#/components/schemas/ThreadSoleProprietorshipTransactionVolume"
}
]
},
"transactionVolumeDescription": {
"type": "string"
},
"profession": {
"$ref": "./createApplication.json#/components/schemas/ThreadIndividualProfession"
}
},
"additionalProperties": false,
"required": ["createdAt", "status", "fullName"]
Expand Down
104 changes: 104 additions & 0 deletions schemas/application/applicationMissingFields.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"components": {
"schemas": {
"MissingField": {
"title": "Missing Field",
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "The name of the application field that is missing"
},
"description": {
"type": "string",
"description": "Human-readable description which will indicate dependant fields that are also required"
}
},
"required": ["fieldName", "description"],
"additionalProperties": false
},
"IndividualApplicationMissingFields": {
"title": "Individual Application Missing Fields",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["individualApplicationMissingFields"],
"default": "individualApplicationMissingFields"
},
"attributes": {
"type": "object",
"properties": {
"missingFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MissingField"
},
"description": "An array of missing field objects. Empty when there are no missing fields."
}
},
"required": ["missingFields"],
"additionalProperties": false
}
},
"required": ["type", "attributes"],
"additionalProperties": false
},
"BusinessApplicationMissingFields": {
"title": "Business Application Missing Fields",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["businessApplicationMissingFields"],
"default": "businessApplicationMissingFields"
},
"attributes": {
"type": "object",
"properties": {
"missingFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MissingField"
},
"description": "An array of missing field objects. Empty when there are no missing fields."
}
},
"required": ["missingFields"],
"additionalProperties": false
}
},
"required": ["type", "attributes"],
"additionalProperties": false
},
"ApplicationMissingFields": {
"title": "Application Missing Fields",
"oneOf": [
{
"$ref": "#/components/schemas/IndividualApplicationMissingFields"
},
{
"$ref": "#/components/schemas/BusinessApplicationMissingFields"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"individualApplicationMissingFields": "#/components/schemas/IndividualApplicationMissingFields",
"businessApplicationMissingFields": "#/components/schemas/BusinessApplicationMissingFields"
}
}
},
"UnitApplicationMissingFieldsResponse": {
"type": "object",
"title": "Unit Application Missing Fields Response",
"properties": {
"data": {
"$ref": "#/components/schemas/ApplicationMissingFields"
}
},
"required": ["data"]
}
}
}
}
31 changes: 31 additions & 0 deletions schemas/application/applicationPaths.json
Original file line number Diff line number Diff line change
Expand Up @@ -850,5 +850,36 @@
}
}
}
},
"applicationMissingFields": {
"get": {
"tags": ["unit"],
"operationId": "getApplicationMissingFields",
"summary": "Get Missing Fields by Application ID",
"description": "Get list of missing due diligence fields by application id",
"parameters": [
{
"schema": {
"type": "string"
},
"name": "applicationId",
"in": "path",
"required": true,
"description": "ID of the application to get missing fields for"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/vnd.api+json; charset=utf-8": {
"schema": {
"$ref": "./applicationMissingFields.json#/components/schemas/UnitApplicationMissingFieldsResponse"
}
}
}
}
}
}
}
}
32 changes: 27 additions & 5 deletions schemas/application/createApplication.json
Original file line number Diff line number Diff line change
Expand Up @@ -404,11 +404,11 @@
"additionalProperties": false,
"required": [
"fullName",
"title",
"email",
"phone",
"address",
"dateOfBirth",
"occupation"
"dateOfBirth"
]
},
"CreateBeneficialOwner": {
Expand Down Expand Up @@ -446,7 +446,7 @@
},
"percentage": {
"type": "integer",
"minimum": 0,
"minimum": 25,
"maximum": 100
},
"EvaluationParams": {
Expand Down Expand Up @@ -548,6 +548,9 @@
},
"sourceOfIncome": {
"$ref": "../types.json#/components/schemas/SourceOfIncome"
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -669,6 +672,9 @@
},
"website": {
"type": "string"
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -900,6 +906,9 @@
},
"profession": {
"$ref": "#/components/schemas/ThreadIndividualProfession"
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -1046,6 +1055,9 @@
},
"businessDescription": {
"type": "string"
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
}
},
"additionalProperties": false,
Expand All @@ -1058,7 +1070,7 @@
"accountPurpose",
"sourceOfFunds",
"transactionVolume",
"profession"
"businessIndustry"
]
}
},
Expand Down Expand Up @@ -1194,6 +1206,9 @@
},
"entityType": {
"$ref": "../types.json#/components/schemas/ThreadApplicationEntityType"
},
"operatingAddress": {
"$ref": "../types.json#/components/schemas/Address"
}
},
"additionalProperties": false,
Expand All @@ -1209,7 +1224,14 @@
"beneficialOwners",
"accountPurpose",
"sourceOfFunds",
"transactionVolume"
"transactionVolume",
"website",
"businessIndustry",
"businessDescription",
"isRegulated",
"usNexus",
"countriesOfOperation",
"yearOfIncorporation"
]
}
},
Expand Down
Loading