---
swagger: "2.0"
info:
  description: Orchestrator Microservice to create customer's source of wealth historical
    data for further analytics and metrics which would help CBSU to decrease workload
    and operational staffing.
  version: 1.0.1
  title: CSMT-CRP-O-CustomerIncome
  x-ibm-name: CSMT-CRP-O-CustomerIncome
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/incomes/wealth:
    post:
      tags:
      - add-customer-source-of-wealth
      summary: API to Add Source Of Wealth information
      description: API to add customer's SOW details
      operationId: add-customer-source-of-wealth
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businesscode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: false
        type: string
        description: SessionId sent by Consumer
      - in: body
        name: AddSOWDetailsRequest
        description: Customer's Source of Wealth
        required: false
        schema:
          $ref: '#/definitions/AddSOWDetailsRequestBody'
      responses:
        200:
          description: Normal response
          schema:
            $ref: '#/definitions/SOWDetailsResponse'
        204:
          description: The server successfully processed the request and is not returning
            any content
        207:
          description: 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:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</t
            d><td>Missing or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>A
            uthorization credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidatio
            nFailed</td><td>Business validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - update-customer-source-of-wealth
      summary: API to Update Source Of Wealth information
      description: API to modify and update the SOW information of an existing customer
      operationId: update-customer-source-of-wealth
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businesscode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: false
        type: string
        description: SessionId sent by Consumer
      - in: body
        name: updateSOWDetailsRequest
        description: Update Customer's Source o Wealth
        required: true
        schema:
          $ref: '#/definitions/UpdateSOWDetailsRequestBody'
      responses:
        200:
          description: normal response
          schema:
            $ref: '#/definitions/SOWDetailsResponse'
        204:
          description: The server successfully processed the request and is not returning
            any content
        207:
          description: 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:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</t
            d><td>Missing or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>A
            uthorization credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidatio
            nFailed</td><td>Business validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/customers/incomes/wealth/retrieve:
    post:
      tags:
      - get-customer-source-of-wealth
      summary: API to GET Source Of Wealth information
      description: API to inquiry a customer SOW detail associated to a Client ID
      operationId: get-customer-source-of-wealth
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businesscode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: false
        type: string
        description: SessionId sent by Consumer
      - in: body
        name: GetSOWDetailsRequest
        description: Retrieve Customer's Source of Wealth
        required: true
        schema:
          $ref: '#/definitions/GetSOWDetailsRequestBody'
      responses:
        200:
          description: Normal response
          schema:
            $ref: '#/definitions/SOWDetails'
        204:
          description: The server successfully processed the request and is not returning
            any content
        207:
          description: 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:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</t
            d><td>Missing or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>A
            uthorization credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidatio
            nFailed</td><td>Business validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  Income:
    type: object
    properties:
      incomeAmount:
        type: number
        description: Assets Under Management
      incomeSource:
        type: string
        maxLength: 20
        description: Primary Source of Wealth
  Customer:
    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'
  EmploymentDetails:
    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
  AddSOWDetailsRequestBody:
    type: object
    properties:
      addSOWDetailsRequest:
        $ref: '#/definitions/SOWDetails'
  EmploymentDetailsPS:
    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
  BusinessOwnership:
    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
  TrustFundCreator:
    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
  InheritanceInfoBO:
    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
  InheritancePayer:
    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
  LoanScholarshipDetails:
    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
  TrustFundGrantor:
    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
  LoanScholarshipDetailsPS:
    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
  PersonalRealEstatePS:
    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
  Employment:
    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
  InheritanceCreator:
    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
  GetSOWDetailsRequestBody:
    type: object
    properties:
      getSOWDetailsRequest:
        $ref: '#/definitions/GetSOWDetailsRequest'
  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'
  BusinessOwnershipInfo:
    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
  UpdateSOWDetailsRequestBody:
    type: object
    properties:
      updateSOWDetailsRequest:
        $ref: '#/definitions/SOWDetails'
  GovernmentSupport:
    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
  GrantorAndCreator:
    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
  SOWDetails:
    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'
  SelfEmploymentPS:
    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
  BusinessOwnershipPS:
    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
  TrustFundGrantorPS:
    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
  OwnerDetails:
    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
  TrustFund:
    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'
  SelfEmployed:
    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
  PersonalRealEstate:
    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
  GiftorAndCreator:
    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
  Employed:
    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
  BusinessOwnershipDetail:
    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
  InheritanceInfo:
    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
  SOWDetailsResponse:
    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
  InvestmentPS:
    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
  PartnerSupport:
    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'
  TrustFundPS:
    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'
  OccupationDetails:
    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'
  BeneficialOwner:
    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
  SelfEmployment:
    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
  BusinessOwner:
    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
  EmploymentInfo:
    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
  Investment:
    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
  ErrorResponse:
    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
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
consumes:
- application/json
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...