production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/incomes/wealth
post /v1/customers/incomes/wealth
add-customer-source-of-wealth
API to Add Source Of Wealth information
API to add customer's SOW details
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businesscode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
AddSOWDetailsRequest
Optional in body
object
Customer's Source of Wealth
200
Normal response
204
The server successfully processed the request and is not returning any content
207
The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | A uthorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidatio nFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/incomes/wealth
put /v1/customers/incomes/wealth
update-customer-source-of-wealth
API to Update Source Of Wealth information
API to modify and update the SOW information of an existing customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businesscode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
updateSOWDetailsRequest
Required in body
object
Update Customer's Source o Wealth
200
normal response
204
The server successfully processed the request and is not returning any content
207
The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | A uthorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidatio nFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/incomes/wealth
/v1/customers/incomes/wealth/retrieve
post /v1/customers/incomes/wealth/retrieve
get-customer-source-of-wealth
API to GET Source Of Wealth information
API to inquiry a customer SOW detail associated to a Client ID
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businesscode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
GetSOWDetailsRequest
Required in body
object
Retrieve Customer's Source of Wealth
200
Normal response
204
The server successfully processed the request and is not returning any content
207
The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | A uthorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidatio nFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/incomes/wealth/retrieve
Definitions
{
"type": "object",
"properties": {
"incomeAmount": {
"type": "number",
"description": "Assets Under Management"
},
"incomeSource": {
"type": "string",
"maxLength": 20,
"description": "Primary Source of Wealth"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"maxLength": 20,
"description": "Client ID (Application ID) generated during application registration"
},
"customerType": {
"type": "string",
"maxLength": 15,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"firstName": {
"type": "string",
"maxLength": 50,
"description": "Customer First Name"
},
"lastName": {
"type": "string",
"maxLength": 50,
"description": "Customer Last Name"
},
"income": {
"$ref": "#/definitions/Income"
}
}
}
{
"type": "object",
"properties": {
"accumulatedEquityPositionCurrencyCd": {
"type": "string",
"maxLength": 3,
"description": "Accumulated equity currency code"
},
"accumulatedEquityPositionValue": {
"type": "number",
"description": "Accumulated equity value"
},
"annualCompensation": {
"type": "number",
"description": "Annual compensation"
},
"annualCompensationCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Annual compensation currency"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employerName": {
"type": "string",
"maxLength": 90,
"description": "Employer's name"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"addSOWDetailsRequest": {
"$ref": "#/definitions/SOWDetails"
}
}
}
{
"type": "object",
"properties": {
"annualCompensation": {
"type": "number",
"description": "Annual compensation"
},
"annualCompensationCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Annual compensation currency"
},
"annualPensionPaymentAmount": {
"type": "number",
"description": "Annual pension payment amount"
},
"annualPensionPaymentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Annual pension payment currency"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employerHeadquarterCountryCode": {
"type": "string",
"maxLength": 3,
"description": "Employer country of headquarters"
},
"employerName": {
"type": "string",
"maxLength": 90,
"description": "Employer's name"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Sub Category"
},
"pensionFlag": {
"type": "boolean",
"description": "Is the Client receiving any pension/retirement payment"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"amountReceivedbyClientFromSale": {
"type": "number",
"description": "Sale Amount"
},
"businessCalenderYear": {
"type": "string",
"maxLength": 4,
"description": "Start/Commencement Year of the Business"
},
"businessName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"businessValue": {
"type": "string",
"maxLength": 20,
"description": "Current business value"
},
"businessValueCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Current business value currency"
},
"currencyOfAmountReceivedbyClientFromSale": {
"type": "string",
"maxLength": 3,
"description": "Currency of the amount received by client from sale"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"inheritancePayer": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritanceInfoBO"
}
},
"inheritedBusinessFlag": {
"type": "boolean",
"description": "Inherited Business?"
},
"originalInvestmentAmount": {
"type": "number",
"description": "Initial investment Amount from user for Business"
},
"originalInvestmentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Original investment currency code"
},
"originalInvestmentSource": {
"type": "string",
"maxLength": 8,
"description": "Where the customer acquired fund for investing on business"
},
"otherDetails": {
"type": "string",
"maxLength": 150,
"description": "Detailed description"
},
"ownershipIncome": {
"type": "number",
"description": "Annual Personal Income from Business"
},
"ownershipIncomeCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of Annual Personal Income"
},
"ownershipPercentage": {
"type": "number",
"description": "Ownership percentage"
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Primary Contributor to Source of Wealth"
},
"primaryOperationCountry": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of primary business operations"
}
},
"publiclyTradedFlag": {
"type": "boolean",
"description": "Publicly Traded Business?"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"stockExchangeList": {
"type": "array",
"items": {
"type": "string",
"maxLength": 8,
"description": "List of major stock exchanges aligned to the Business"
}
},
"yearOfSale": {
"type": "string",
"maxLength": 3,
"description": "Year in which payment was received"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipInfo"
}
},
"creator": {
"$ref": "#/definitions/GrantorAndCreator"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentInfo"
}
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"otherDetails": {
"type": "string",
"maxLength": 150,
"description": "Other Details"
},
"sourceOfWealthCreation": {
"type": "string",
"maxLength": 50,
"description": "Creator's Source of Wealth "
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"giftAmount": {
"type": "number",
"description": "Value of Payment"
},
"giftYear": {
"type": "string",
"maxLength": 4,
"description": "Year in which payment was received"
},
"giftor": {
"$ref": "#/definitions/GiftorAndCreator"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipInfo"
}
},
"currencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of the income from Inheritance"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentInfo"
}
},
"giftAmount": {
"type": "number",
"description": "Value of Payment"
},
"giftYear": {
"type": "string",
"maxLength": 4,
"description": "Year in which payment was received"
},
"giftor": {
"$ref": "#/definitions/GiftorAndCreator"
},
"inheritanceCreator": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritanceCreator"
}
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The is the Entity name"
},
"otherDetails": {
"type": "string",
"maxLength": 150,
"description": "If Other Please Describe"
},
"payerCreatedWealthFlag": {
"type": "boolean",
"description": "Flag to indicate if wealth creator"
},
"sourceOfWealthCreation": {
"type": "string",
"maxLength": 50,
"description": "Creator's Source of Wealth "
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"wealthReputationFlag": {
"type": "boolean",
"description": "Are there any known reputational issues surrounding the inheritance"
},
"wealthReputationIssueDetails": {
"type": "string",
"maxLength": 150,
"description": "Detailed description of reputational issues surrounding the inheritance"
}
}
}
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of the income from Loan Scholarship"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"firstName": {
"type": "string",
"maxLength": 50,
"description": "Customer First Name"
},
"lastName": {
"type": "string",
"maxLength": 50,
"description": "Customer Last Name"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The is the Entity name"
},
"loanAmount": {
"type": "number",
"description": "It is the amount Value of Loan/Grant/Scholarship"
},
"relationshipType": {
"type": "string",
"maxLength": 20,
"description": "Customer RelationshipType"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipInfo"
}
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentInfo"
}
},
"grantor": {
"$ref": "#/definitions/GiftorAndCreator"
},
"grantorCreatedWealthFlag": {
"type": "boolean",
"description": "is Grantor Created wealth"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"otherDetails": {
"type": "string",
"maxLength": 150,
"description": "Other Details"
},
"sourceOfWealthCreation": {
"type": "string",
"maxLength": 50,
"description": "Creator's Source of Wealth "
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"trustFundCreator": {
"type": "array",
"items": {
"$ref": "#/definitions/TrustFundCreator"
}
},
"trustReputationFlag": {
"type": "boolean",
"description": "Are there any reputation issues surrounding the Trust"
},
"wealthReputationIssueDetails": {
"type": "string",
"maxLength": 150,
"description": "Detailed description of reputational issues surrounding the Trust"
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"firstName": {
"type": "string",
"maxLength": 50,
"description": "Customer First Name"
},
"lastName": {
"type": "string",
"maxLength": 50,
"description": "Customer Last Name"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"relationshipType": {
"type": "string",
"maxLength": 20,
"description": "Customer RelationshipType"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"purchaseYear": {
"type": "string",
"maxLength": 4,
"description": "Purchase year"
},
"realEstateSoldFlag": {
"type": "boolean",
"description": "Real state sold?"
},
"rentalIncomeAmount": {
"type": "number",
"description": "Rental Income Amount"
},
"rentalIncomeCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Rental Income Currency"
},
"rentalIncomeFlag": {
"type": "boolean",
"description": "Rental Income Flag"
},
"saleAmount": {
"type": "number",
"description": "Sale Amount"
},
"saleCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Sale Amount Currency"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"accumulatedEquityPositionCurrencyCd": {
"type": "string",
"maxLength": 3,
"description": "Accumulated equity currency code"
},
"accumulatedEquityPositionValue": {
"type": "number",
"description": "Accumulated equity value"
},
"annualCompensation": {
"type": "number",
"description": "Annual compensation"
},
"annualCompensationCurrencyCode": {
"type": "string",
"description": "Annual compensation currency"
},
"annualPensionPaymentAmount": {
"type": "number",
"description": "Annual pension payment amount"
},
"annualPensionPaymentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Annual pension payment currency"
},
"currentlyEmployedFlag": {
"type": "boolean",
"description": "Currently employed?"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employerBusinessActivity": {
"type": "string",
"maxLength": 300,
"description": "Brief overview of main business activity of the company"
},
"employerHeadquarterCountryCode": {
"type": "string",
"maxLength": 3,
"description": "Country of Incorporation"
},
"employerName": {
"type": "string",
"maxLength": 50,
"description": "Employer's name"
},
"employmentEndYear": {
"type": "integer",
"format": "int32",
"description": "Employment end year"
},
"employmentStartYear": {
"type": "integer",
"format": "int32",
"description": "Employment start year"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Sub Category"
},
"pensionFlag": {
"type": "boolean",
"description": "Is the Client receiving any pension/retirement payment"
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Flag to indicate primary contribuitor of sow"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipInfo"
}
},
"creator": {
"$ref": "#/definitions/GiftorAndCreator"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentInfo"
}
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"otherDetails": {
"description": "IF Other Please Describe",
"type": "string",
"maxLength": 150
},
"sourceOfWealthCreation": {
"type": "string",
"maxLength": 50,
"description": "Creator's Source of Wealth "
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"getSOWDetailsRequest": {
"$ref": "#/definitions/GetSOWDetailsRequest"
}
}
}
{
"type": "object",
"properties": {
"agentId": {
"type": "string",
"description": "Last updated user",
"maxLength": 10
},
"clientId": {
"type": "string",
"maxLength": 20,
"description": "Client ID (Application ID) generated during application registration"
},
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnership"
}
}
}
}
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"updateSOWDetailsRequest": {
"$ref": "#/definitions/SOWDetails"
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"govIncomeCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of the income from Government Support"
},
"governmentAgencyCountryCode": {
"type": "string",
"maxLength": 3,
"description": "Country of Government Agency"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"yearlyGovSupportIncome": {
"type": "number",
"description": "Yearly Income from Government Support"
}
}
}
{
"type": "object",
"properties": {
"firstName": {
"type": "string",
"maxLength": 50,
"description": "Giftor an creator's first name"
},
"lastName": {
"type": "string",
"maxLength": 50,
"description": "Giftor an creator's last name"
},
"relationshipType": {
"type": "string",
"maxLength": 20,
"description": "Giftor an creator's relationship type"
}
}
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Last updated user",
"type": "string",
"maxLength": 10
},
"customer": {
"$ref": "#/definitions/Customer"
},
"applicationId": {
"type": "string",
"maxLength": 20,
"description": "Denotes the source application from where the request is originated"
},
"accesToken": {
"type": "string",
"maxLength": 500,
"description": "Token used for verifying the calling application"
},
"queryTime": {
"type": "string",
"maxLength": 40,
"description": "Date and Time"
},
"occupationDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/OccupationDetails"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/Employment"
}
},
"selfEmployment": {
"type": "array",
"items": {
"$ref": "#/definitions/SelfEmployment"
}
},
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnership"
}
},
"governmentSupport": {
"type": "array",
"items": {
"$ref": "#/definitions/GovernmentSupport"
}
},
"loanScholarshipDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/LoanScholarshipDetails"
}
},
"inheritance": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritancePayer"
}
},
"investment": {
"type": "array",
"items": {
"$ref": "#/definitions/Investment"
}
},
"realEstate": {
"type": "array",
"items": {
"$ref": "#/definitions/PersonalRealEstate"
}
},
"trustFund": {
"type": "array",
"items": {
"$ref": "#/definitions/TrustFund"
}
},
"partnerSupport": {
"type": "array",
"items": {
"$ref": "#/definitions/PartnerSupport"
}
}
}
}
{
"type": "object",
"properties": {
"businessOperationsCountryCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of primary business operations"
}
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Sub Category"
},
"selfEmploymentAnnualIncome": {
"type": "number",
"description": "Approx Annual Amount Received"
},
"selfEmploymentIncomeCurrencyCd": {
"type": "string",
"maxLength": 3,
"description": "Currency of Annual Income"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"ownershipIncome": {
"type": "number",
"description": "Annual Personal Income from Business"
},
"ownershipIncomeCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of Annual Personal Income"
},
"primaryOperationCountry": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of primary business operations"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"grantor": {
"$ref": "#/definitions/GiftorAndCreator"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"countryOfCitizenship": {
"type": "array",
"items": {
"type": "string"
}
},
"dateOfBirth": {
"type": "string"
},
"domicileCountry": {
"type": "string"
},
"firstName": {
"type": "string"
},
"fundsProvider": {
"type": "array",
"items": {
"type": "string"
}
},
"lastName": {
"type": "string"
},
"ownerRole": {
"type": "array",
"items": {
"type": "string"
}
},
"ownerType": {
"type": "string"
},
"ownershipPercentage": {
"type": "number"
}
}
}
{
"type": "object",
"properties": {
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"trustCreationAmount": {
"type": "number",
"description": "Original Value Of Trust"
},
"trustCreationCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Original Value Of Trust Currency"
},
"trustFundGrantor": {
"type": "array",
"items": {
"$ref": "#/definitions/TrustFundGrantor"
}
}
}
}
{
"type": "object",
"properties": {
"businessOperationsCountryCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of primary business operations"
}
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 3,
"description": "Occupation Sub Category"
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Flag to indicate primary contribuitor of sow"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipDetail"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentDetails"
}
},
"evaluationAmount": {
"type": "number"
},
"evaluationAmountCurrencyCode": {
"type": "string"
},
"inheritancePayer": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritanceInfo"
}
},
"purchaseAmount": {
"type": "number",
"description": "Purchase Amount"
},
"purchaseCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Purchase Amount Currency"
},
"purchaseYear": {
"type": "string",
"maxLength": 4,
"description": "Purchase year"
},
"realEstateSoldFlag": {
"type": "boolean",
"description": "Real state sold?"
},
"rentalIncomeAmount": {
"type": "number",
"description": "Rental Income Amount"
},
"rentalIncomeCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Rental Income Currency"
},
"rentalIncomeFlag": {
"type": "boolean",
"description": "Rental Income Flag"
},
"saleAmount": {
"type": "number",
"description": "Sale Amount"
},
"saleCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Sale Amount Currency"
},
"sourceOfInvestment": {
"type": "array",
"items": {
"type": "string",
"maxLength": 90,
"description": "Identify the source(s) of wealth for investment portfolio and personal real estate"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"valueEvent": {
"type": "string",
"maxLength": 150,
"description": "Describe any significant event leading to increase or decrease of investment value"
}
}
}
{
"type": "object",
"properties": {
"firstName": {
"type": "string",
"maxLength": 50,
"description": "Giftor an creator's first name"
},
"lastName": {
"type": "string",
"maxLength": 50,
"description": "Giftor an creator's first name"
},
"relationshipType": {
"type": "string",
"maxLength": 20,
"description": "Giftor an creator's relationship"
}
}
}
{
"type": "object",
"properties": {
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of Incorporation"
},
"employerName": {
"type": "string",
"maxLength": 90,
"description": "Employer's name"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type of the employeer"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Sub Category"
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Flag to indicate primary contribuitor of sow"
}
}
}
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"maxLength": 90,
"description": "Name of Wealth creator's business"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"ownershipPercentage": {
"type": "number",
"description": "Client's ownership percentage"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"maxLength": 3,
"description": "Inheritance Currency"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of incorporation"
},
"giftAmount": {
"type": "number",
"description": "Approx Annual Amount Received"
},
"giftor": {
"$ref": "#/definitions/GiftorAndCreator"
},
"legalName": {
"type": "string",
"maxLength": 90,
"description": "The Entity name"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"clientId": {
"type": "string",
"maxLength": 20,
"description": "Client ID (Application ID) generated during application registration"
},
"applicationId": {
"type": "string",
"maxLength": 20,
"description": "Denotes the source application from where the request is originated"
},
"status": {
"type": "string",
"maxLength": 20,
"description": "Existing client status on S16"
}
}
}
{
"type": "object",
"properties": {
"businessOwnershipFlag": {
"type": "boolean",
"description": "Does the client own investment?"
},
"currentInvestmentAmount": {
"type": "number",
"description": "Current investment amount"
},
"currentInvestmentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Current investment currency"
},
"customerType": {
"type": "string",
"maxLength": 11,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"investmentSaleAmount": {
"type": "number",
"description": "Value of Investment as time of Sale"
},
"investmentSaleCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of value of investment at time of sale"
},
"investmentStartDate": {
"type": "string",
"maxLength": 40,
"description": "Start Year of Investment"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"fullName": {
"type": "string",
"maxLength": 180,
"description": "Partner's full name"
},
"relationshipType": {
"type": "string",
"maxLength": 20,
"description": "Partner relationship"
},
"annualSupportAmount": {
"type": "number",
"description": "Approx Annual Amount Received"
},
"currencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of the income from Partner Support"
},
"beneficialOwner": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficialOwner"
}
},
"beneficialOwnerSourceofIncome": {
"type": "array",
"items": {
"type": "string",
"maxLength": 15,
"description": "The sow of spouse/partner if they are earning through Business"
}
},
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipPS"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentDetailsPS"
}
},
"selfEmployment": {
"type": "array",
"items": {
"$ref": "#/definitions/SelfEmploymentPS"
}
},
"inheritance": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritanceInfo"
}
},
"investment": {
"type": "array",
"items": {
"$ref": "#/definitions/InvestmentPS"
}
},
"realEstate": {
"type": "array",
"items": {
"$ref": "#/definitions/PersonalRealEstatePS"
}
},
"trustFund": {
"type": "array",
"items": {
"$ref": "#/definitions/TrustFundPS"
}
},
"loanScholarshipDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/LoanScholarshipDetailsPS"
}
}
}
}
{
"type": "object",
"properties": {
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
},
"trustCreationAmount": {
"type": "number",
"description": "Original Value Of Trust"
},
"trustCreationCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Original Value Of Trust Currency"
},
"trustFundGrantor": {
"type": "array",
"items": {
"$ref": "#/definitions/TrustFundGrantorPS"
}
}
}
}
{
"type": "object",
"properties": {
"occupationStatus": {
"type": "string",
"description": "Current Occupation Status"
},
"employed": {
"type": "array",
"items": {
"$ref": "#/definitions/Employed"
}
},
"businessOwner": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwner"
}
},
"selfEmployed": {
"type": "array",
"items": {
"$ref": "#/definitions/SelfEmployed"
}
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"ownerDetails": {
"$ref": "#/definitions/OwnerDetails"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"activityOverview": {
"type": "string",
"maxLength": 150,
"description": "Brief Overview of self-employment activity"
},
"businessOperationsCountryCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of primary business operations"
}
},
"businessStartYear": {
"type": "integer",
"format": "int32",
"description": "Business start year"
},
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"occupationCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Category"
},
"occupationSubCategory": {
"type": "string",
"maxLength": 18,
"description": "Occupation Sub Category"
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Flag to indicate primary contribuitor of sow"
},
"selfEmploymentAnnualIncome": {
"type": "number",
"description": "Annual Personal income from self-employment"
},
"selfEmploymentIncomeCurrencyCd": {
"type": "string",
"maxLength": 3,
"description": "Annual Personal income currency"
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"maxLength": 90,
"description": "Name of Wealth creator's business"
},
"domicileCountry": {
"type": "string",
"maxLength": 3,
"description": "Country of Incorporation"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"primaryContributorToSowFlag": {
"type": "boolean",
"description": "Flag to indicate primary contribuitor of sow"
},
"primaryOperationCountry": {
"type": "array",
"items": {
"type": "string",
"maxLength": 3,
"description": "Country of Incorporation"
}
}
}
}
{
"type": "object",
"properties": {
"customerType": {
"type": "string",
"maxLength": 20,
"description": "INDIVIDUAL, CORPORATE, ALL"
},
"employerName": {
"type": "string",
"maxLength": 90,
"description": "Employer's name"
},
"industryTypeCode": {
"type": "array",
"items": {
"type": "string",
"maxLength": 20,
"description": "Industry type"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"type": "object",
"properties": {
"businessOwnership": {
"type": "array",
"items": {
"$ref": "#/definitions/BusinessOwnershipDetail"
}
},
"businessOwnershipFlag": {
"type": "boolean",
"description": "Does the client own investment?"
},
"currentInvestmentAmount": {
"type": "number",
"description": "Current investment amount"
},
"currentInvestmentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Current investment currency"
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/EmploymentDetails"
}
},
"inheritancePayer": {
"type": "array",
"items": {
"$ref": "#/definitions/InheritanceInfo"
}
},
"investmentSaleAmount": {
"type": "number",
"description": "Value of Investment as time of Sale"
},
"investmentSaleCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Currency of value of investment at time of sale"
},
"investmentStartDate": {
"type": "string",
"maxLength": 40,
"description": "Start Year of Investment"
},
"originalInvestmentAmount": {
"type": "number",
"description": "Initial investment Amount from user for Business"
},
"originalInvestmentCurrencyCode": {
"type": "string",
"maxLength": 3,
"description": "Original investment currency code"
},
"significantInvestmentHistory": {
"type": "string",
"maxLength": 150,
"description": "History / milestones of Source of Wealth"
},
"sourceOfInvestment": {
"type": "array",
"items": {
"type": "string",
"maxLength": 90,
"description": "Identify the source(s) of wealth for investment portfolio and personal real estate"
}
},
"sowCategoryId": {
"type": "string",
"maxLength": 11,
"description": "Sow parent category Id"
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}