openapi: 3.0.1
info:
  title: Forms Data
  version: v1
  description: |
    # Getting Started
    For more information on how to start using our APIs, please refer to the Getting Started guide. 
    ***
    # Servers
    SEI's API products have various environments available depending on your stage of integration. The server URL should correspond with the environment of your application. Please refer to the Getting Started guide for a list of all environments and URLs. 
    
    **Note** For all Client applications,  the Two-way TLS URL must be used. This is essential in order for the client server making API calls to establish a successful Two-Way SSL communication with SEI.
    ***
servers:
  - url: 'https://test.mtls.api.seic.com'
    description: Two-way SSL Test Server.
  - url: 'https://mtls.api.seic.com'
    description: Two-way SSL Production Server.
  - url: 'https://build.api.seic.com'
    description: Integration Server with masked data.
  - url: 'https://sandbox.api.seic.com'
    description: Sandbox Server with masked data. 
  - url: 'https://test.api.seic.com'
    description: Test Server with unmasked data.
  - url: 'https://api.seic.com'
    description: Production Server with unmasked data.
paths:
  /v1/trade/autofill/formdata/{trackingNumber}:
    post:
      security:
        - oauth2: []
          bearerAuth: []
          ApiKeyAuth: []
      tags:
      - FormData
      summary: After creating a transaction with the POST Initiation API endpoint, use the trackingNumber from the response and submit the form data.
      operationId: PostFormData
      parameters:
      - name: trackingNumber
        in: path
        description: Unique PpmNumber to identify opportunity. Located within the Initiation response. 
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Request content type. The valid value is application/json.
        required: true
        schema:
          type: string
      x-codeSamples:
        - lang: 'cURL'
          source: |
            curl --location --request POST \
            'https://api.seic.com/v1/trade/autofill/formdata/6287D447PEWPRED' \
            --header 'Authorization: Bearer YOUR_ACCESSTOKEN' \
            --header 'AppKey: YOUR_APPKEY' \
            --header 'Content-Type: application/json'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/autofillrequestDataPOST'
        required: false
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/autofillresponseDataPOST'
        400:
          description: Bad request - The server cannot or will not process the request
            due to an inaccurate request submitted by the client application.  Please
            resubmit the request after making the required corrections indicated in
            the error response.  For more Info on SEI Error Standards please refer
            to the API Standards FAQ under Support.
        401:
          description: Unauthorized - Invalid authentication details have been provided.  Also
            useful to trigger an authorization pop up if the API is used from a browser.
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections.
        500:
          description: Internal Server Error - The server was unable to fulfill the
            request due to an unknown condition. Please contact SEI for support. For
            More Info please refer to the "Response & Errors" FAQ under support.
    get:
      security:
        - oauth2: []
          bearerAuth: []
          ApiKeyAuth: []
      tags:
      - FormData
      operationId: GetFormData
      summary: Receive the submitted form data information by trackingNumber. 
      parameters:
      - name: trackingNumber
        in: path
        description: Unique PpmNumber to identify opportunity. Located within the Initiation response. 
        required: true
        schema:
          type: string
      x-codeSamples:
        - lang: 'cURL'
          source: |
            curl --location --request GET \
            'https://api.seic.com/v1/trade/autofill/formdata/6287D447PEWPRED' \
            --header 'Authorization: Bearer YOUR_ACCESSTOKEN' \
            --header 'AppKey: YOUR_APPKEY' \
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAutofillResults'
        400:
          description: Bad request - The server cannot or will not process the request
            due to an inaccurate request submitted by the client application.  Please
            resubmit the request after making the required corrections indicated in
            the error response.  For more Info on SEI Error Standards please refer
            to the API Standards FAQ under Support.
        401:
          description: Unauthorized - Invalid authentication details have been provided.  Also
            useful to trigger an authorization pop up if the API is used from a browser.
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections.
        500:
          description: Internal Server Error - The server was unable to fulfill the
            request due to an unknown condition. Please contact SEI for support. For
            More Info please refer to the "Response & Errors" FAQ under support.
    put:
      security:
        - oauth2: []
          bearerAuth: []
          ApiKeyAuth: []
      tags:
      - FormData
      operationId: PutFormData
      summary: Update the existing form data.
      parameters:
      - name: trackingNumber
        in: path
        description: Unique PpmNumber to identify opportunity. Located within the Initiation response. 
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Request content type. The valid value is application/json.
        required: true
        schema:
          type: string
      x-codeSamples:
        - lang: 'cURL'
          source: |
            curl --location --request PUT \
            'https://api.seic.com/v1/trade/autofill/formdata/6287D447PEWPRED' \
            --header 'Authorization: Bearer YOUR_ACCESSTOKEN' \
            --header 'AppKey: YOUR_APPKEY' \
            --header 'Content-Type: application/json'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/autofillrequestDataPOST'
        required: false
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/autofillresponseDataPOST'
        400:
          description: Bad request - The server cannot or will not process the request
            due to an inaccurate request submitted by the client application.  Please
            resubmit the request after making the required corrections indicated in
            the error response.  For more Info on SEI Error Standards please refer
            to the API Standards FAQ under Support.
        401:
          description: Unauthorized - Invalid authentication details have been provided.  Also
            useful to trigger an authorization pop up if the API is used from a browser.
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections
        500:
          description: Internal Server Error - The server was unable to fulfill the
            request due to an unknown condition. Please contact SEI for support. For
            More Info please refer to the "Response & Errors" FAQ under support.
  /v1/trade/autofill/formdata/customfield:
    get:
      security:
        - oauth2: []
          bearerAuth: []
          ApiKeyAuth: []
      tags:
      - Custom Fields
      operationId: GetCustomFields
      summary: Receive the list of custom fields. Custom fields depend on your organization.
      x-codeSamples:
        - lang: 'cURL'
          source: |
            curl --location --request GET \
            'https://api.seic.com/v1/trade/autofill/formdata/customfield' \
            --header 'Authorization: Bearer YOUR_ACCESSTOKEN' \
            --header 'AppKey: YOUR_APPKEY' \
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAutofillCustomFieldResults'
              examples:
                Response Example:
                  $ref: '#/components/examples/CustomFieldExample'
        400:
          description: Bad request - The server cannot or will not process the request
            due to an inaccurate request submitted by the client application.  Please
            resubmit the request after making the required corrections indicated in
            the error response.  For more Info on SEI Error Standards please refer
            to the API Standards FAQ under Support.
        401:
          description: Unauthorized - Invalid authentication details have been provided.  Also
            useful to trigger an authorization pop up if the API is used from a browser.
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections
        500:
          description: Internal Server Error - The server was unable to fulfill the
            request due to an unknown condition. Please contact SEI for support. For
            More Info please refer to the "Response & Errors" FAQ under support.
  /v1/trade/autofill/healthcheck:
    get:
      security:
        - oauth2: []
          bearerAuth: []
          ApiKeyAuth: []
      tags:
      - Health Check
      operationId: GetHealthCheck
      description: Check the availability of the backend API and database.
      x-codeSamples:
        - lang: 'cURL'
          source: |
            curl --location --request GET \
            'https://api.seic.com/v1/trade/autofill/healthcheck' \
            --header 'Authorization: Bearer YOUR_ACCESSTOKEN' \
            --header 'AppKey: YOUR_APPKEY' \
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAutofillHealthcheckResults'
              examples:
                Response Example:
                  $ref: '#/components/examples/HealthcheckExample'
        400:
          description: Bad request - The server cannot or will not process the request
            due to an inaccurate request submitted by the client application.  Please
            resubmit the request after making the required corrections indicated in
            the error response.  For more Info on SEI Error Standards please refer
            to the API Standards FAQ under Support.
        401:
          description: Unauthorized - Invalid authentication details have been provided.  Also
            useful to trigger an authorization pop up if the API is used from a browser.
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections.
        500:
          description: Internal Server Error - The server was unable to fulfill the
            request due to an unknown condition. Please contact SEI for support. For
            More Info please refer to the "Response & Errors" FAQ under support.
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: To access any API, first obtain an OAuth Token. Refer to the Access Token documentation for more information. The token has a 60 minutes active TTL and 30 minutes inactive TTL. An application making SEI API Requests from a Client/Server or Server/Server type of infrastructure will leverage the grant_type client_credentials while minting an OAuth from the Token API. 
      flows:
        clientCredentials:
          tokenUrl: /v2/oauthtoken
          scopes: {}
    bearerAuth:
      type: http
      scheme: bearer
      description: After successfully obtaining an OAuth token, pass the access_token value to the desired API endpoint by including the header parameter 'Authorization' with the value 'Bearer access_token'. 
    ApiKeyAuth:
      type: apiKey
      in: header
      name: AppKey
      description: Pass the header parameter 'AppKey' to the API endpoint to authenticate your application. This value can be found within the 'My Apps' page. This value uniquely identifies the registered application. 
  schemas:
    getAutofillHealthcheckResults:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PingData'
    PingData:
      type: object
      properties:
        backendApi:
          type: string
        database:
          type: string
    getAutofillCustomFieldResults:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CustomFieldsData'
    CustomFieldsData:
      type: object
      properties:
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/FieldArray'
    FieldArray:
      type: object
      properties:
        field:
          type: string
        displayName:
          type: string
        dataType:
          type: string
    autofillresponseDataPOST:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalAutoFillData'
    ExternalAutoFillData:
      type: object
      properties:
        message:
          type: string
          example: The Request has been submitted and record created successfully.
    autofillrequestDataPOST:
      type: object
      properties:
        accountHolders:
          type: array
          items:
            $ref: '#/components/schemas/AccountHolders'
        advisor:
          $ref: '#/components/schemas/AdvisorData'
        beneficialOwners:
          type: array
          items:
            $ref: '#/components/schemas/BeneficialOwners'
        beneficiaries:
          type: array
          items:
            $ref: '#/components/schemas/Beneficiaries'
        custodian:
          $ref: '#/components/schemas/Custodian'
        endClient:
          $ref: '#/components/schemas/EndClient'
        investor:
          $ref: '#/components/schemas/InvestorData'
        thirdParties:
          type: array
          items:
            $ref: '#/components/schemas/ThirdParties'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transactions'
        wireInstructions:
          $ref: '#/components/schemas/WireInstructions'
        customFields:
            $ref: '#/components/schemas/CustomFields'


    AccountHolders:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        prefix:
          type: string
          description: Prefix for a Third Party where Third Party is an Individual. Value for Prefix - Mr., Mrs., Ms., Dr.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: The last name for the financial advisor, investor,manager or contact or third party
        suffix:
          type: string
          description: Suffix for a Third Party where Third Party is an Individual.Value for Suffix - Jr., Sr., Esq.
        classification:
          type: string
          description: Identifies whether the investor is an individual or entity.
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
        investorStatus:
          type: string
          description: Identifies whether the investor is a US investor or not. A full list of investor types can be obtained through the Lists API.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        domicileCountryIsoCode:
          type: string
          description: Identifies the domicile country in ISO 3166-1 alpha-2 code format.
        principalPlaceOfBusinessCountry:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        principalPlaceOfBusinessStateProvince:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        ownershipPercentage:
          type: number
          format: double
          description: Investor's percentage ownership in the product as of the Period End date
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
        email:
          type: string
          description: The email address at which communications can be sent or received.
        address:
          $ref: '#/components/schemas/Address'
    AdvisorData:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        employeeId:
          type: string
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: The last name for the financial advisor, investor,manager or contact or third party
        email:
          type: string
          description: The email address at which communications can be sent or received.
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
        firmName:
          type: string
        firmId:
          type: string
        subfirmName:
          type: string
        subfirmId:
          type: string
        address:
          $ref: '#/components/schemas/Address'
    BeneficialOwners:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        prefix:
          type: string
          description: Prefix for a Third Party where Third Party is an Individual. Value for Prefix - Mr., Mrs., Ms., Dr.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: The last name for the financial advisor, investor,manager or contact or third party
        suffix:
          type: string
          description: Suffix for a Third Party where Third Party is an Individual.Value for Suffix - Jr., Sr., Esq.
        classification:
          type: string
          description: Identifies whether the investor is an individual or entity.
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
        investorStatus:
          type: string
          description: Identifies whether the investor is a US investor or not. A full list of investor types can be obtained through the Lists API.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        domicileCountryIsoCode:
          type: string
          description: Identifies the domicile country in ISO 3166-1 alpha-2 code format.
        principalPlaceOfBusinessCountry:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        principalPlaceOfBusinessStateProvince:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        ownershipPercentage:
          type: number
          format: double
          description: Investor's percentage ownership in the product as of the Period End date
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
        email:
          type: string
          description: The email address at which communications can be sent or received.
        address:
          $ref: '#/components/schemas/Address'
    Beneficiaries:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        prefix:
          type: string
          description: Prefix for a Third Party where Third Party is an Individual. Value for Prefix - Mr., Mrs., Ms., Dr.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: The last name for the financial advisor, investor,manager or contact or third party
        suffix:
          type: string
          description: Suffix for a Third Party where Third Party is an Individual.Value for Suffix - Jr., Sr., Esq.
        classification:
          type: string
          description: Identifies whether the investor is an individual or entity.
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
        investorStatus:
          type: string
          description: Identifies whether the investor is a US investor or not. A full list of investor types can be obtained through the Lists API.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        domicileCountryIsoCode:
          type: string
          description: Identifies the domicile country in ISO 3166-1 alpha-2 code format.
        principalPlaceOfBusinessCountry:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        principalPlaceOfBusinessStateProvince:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        ownershipPercentage:
          type: number
          format: double
          description: Investor's percentage ownership in the product as of the Period End date
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
        email:
          type: string
          description: The email address at which communications can be sent or received.
        address:
          $ref: '#/components/schemas/Address'
    Custodian:
      type: object
      properties:
        custodianId:
          type: string
          description: The SEI unique identifier of the custodian. 
        custodianName:
          type: string
        custodianAccountNumber:
          type: string
        custodianContact:
          type: string
        email:
          type: string
          description: The email address at which communications can be sent or received.
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
    EndClient:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        prefix:
          type: string
          description: Prefix for a Third Party where Third Party is an Individual. Value for Prefix - Mr., Mrs., Ms., Dr.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: The last name for the financial advisor, investor,manager or contact or third party
        suffix:
          type: string
          description: Suffix for a Third Party where Third Party is an Individual.Value for Suffix - Jr., Sr., Esq.
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
        classification:
          type: string
          description: Identifies whether the investor is an individual or entity.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        domicileCountryIsoCode:
          type: string
          description: Identifies the domicile country in ISO 3166-1 alpha-2 code format.
        secondaryCitizenshipCountryIsoCode:
          type: string
          description: Secondary citizenship country code
        principalPlaceOfBusinessCountry:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        principalPlaceOfBusinessStateProvince:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        maritalStatus:
          type: string
          description: Indicates the Marital Status
        gender:
          type: string
          description: Identifies the gender. 
        employmentStatus:
          type: string
          description: Identifies the Employment status.
        employerName:
          type: string
          description:   Indicates the name of the end client's employer
        annualIncome:
          type: number
          format: double
          description: Annual income of the Third Party
        netWorth:
          type: number
          format: double
        currency:
          type: string
          description: ISO 4217 alphabetic code
        lastNetProfit:
          type: number
          format: double
          description: Identifies the Last Net Profit of a Third Party.
        incomeType:
          type: string
        incomeTaxBandRate:
          type: number
          format: double
          description: The income tax band rate of the Third Party.
        investmentObjective:
          type: string
          description: Represents the objective for investment in the account.
        riskRating:
          type: string
          description: Indicates the investment risk rating of the account. It can be a value from 0 to 99. A value of 0 means the risk is not rated or specified. Value 1 is the lowest risk (most conservative) and value 99 is the highest risk (most aggressive).
        address:
          $ref: '#/components/schemas/Address'
    InvestorData:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        accountNumber:
          type: string
          description: This is the General Ledger Financial Account Number
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
        secondaryTaxIdType:
          type: string
          description: Secondary TaxIdType of the account. Tax ID can be of type SSN, EIN, or Other.
        secondaryTaxId:
          type: string
          description: Secondary social security number or tax identification number for an investor provided on tax form and/or subscription document.
        legalFormOfEntity:
          type: string
          description: Identifies the legal form of the investor. A full list of values can be obtained through the Lists API.
        taxType:
          type: string
          description: Investor's tax type as indicated on the tax form. A full list of tax types can be obtained through the Lists API.
        subscriberType:
          type: string
          description: Investor's subscriber type as indicated on the subscription document. A full list of subscriber types can be obtained through the Lists API.
        taxStatus:
          type: string
          description: Indicates whether the investor is exempt from US taxation or not. A full list of tax statuses can be obtained through the Lists API.
        accountStatus:
          type: string
          description: Indicates the status of the account.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        domicileCountryIsoCode:
          type: string
          description: Identifies the domicile country in ISO 3166-1 alpha-2 code format.
        organizedUnderLawsOf:
          type: string
          description: Identifies the country where the investor was formed under ISO 3166-1 alpha-2 code format.
        principalPlaceOfBusinessCountry:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        principalPlaceOfBusinessStateProvince:
          type: string
          description: The country and/or state specific to the primary location where business is performed. This is generally where the investor's books and records are kept and usually where the investor is located for tax reporting purposes.
        erisaType:
          type: string
          description:   ERISA status of investors as indicated on subscription document.
        erisaPercent:
          type: number
          format: double
          description: Percentage of earnings contributed to an ERISA participant’s account as indicated on the subscription document.
        benefitPlanEmployee:
          type: boolean
          description: Identifies the Type of Benefit Plan Investor in terms of yes or no if the investor is defined as An employee benefit plan subject to the provisions of Title I of the Employee Retirement Income Security Act of 1974, as amended (generally retirement plans of U.S. private employers).
        benefitPlanIndividual:
          type: boolean
          description: Identifies the Type of Benefit Plan Investor in terms of yes or no if the investor is defined as A plan such as an Individual Retirement Account and certain retirement arrangements for self-employed individuals subject to the prohibited transaction provisions of Section 4975 of the Internal Revenue Code of 1986, as amended.
        accreditedInvestor:
          type: boolean
          description: Designates whether an investor is an accredited investor or not. A full list of accredited investor types can be obtained through the Lists API.
        qualifiedPurchaser:
          type: boolean
          description: Designates whether an investor is a qualified purchaser or not. A full list of qualified purchaser types can be obtained through the Lists API.
        finra5130:
          type: string
          description: FINRA 5130 Status for the Investor as indicated on the subscription document. A full list of FINRA 5130 types can be obtained through the Lists API.
        finra5130Percent:
          type: number
          format: double
          description: Investor's percentage of beneficial interest in regard to FINRA 5130. FINRA rule 5130 prohibits FINRA members from selling new issues to any account in which “restricted persons” have a beneficial interest.
        finra5131:
          type: string
          description: FINRA 5131 Status for the Investor as indicated on the subscription document. Value options are Yes, No, & or blank. The percentage of investor's assets that are subject to FINRA regulation.
        finra5131CompanyName:
          type: string
          description: Represents the company name when investor is applicable company under FINRA Rule 5131.
        finra5131Percent:
          type: number
          format: double
          description: Investor's percentage of beneficial interest in regard to FINRA 5131. FINRA rule 5131 addresses the potential misconduct in the allocation and distribution of new issues.
        employeeEligible:
          type: boolean
          description: Indicates whether the investor is employee eligible.
        friendsFamily:
          type: boolean
          description: Indicates whether the investor is identified as part of friends and family.
        generalPartner:
          type: boolean
          description: Indicates whether the investor is a general partner.
        limitedPartner:
          type: boolean
          description: Indicates whether the investor is a limited partner.
        seniorPoliticalFigure:
          type: boolean
          description: During the subscription process, the investor must represent they are in compliance with various federal, state and international laws and regulations, as well as a set of other disclosures relevant to AML and OFAC compliance. The representations should also include a statement regarding the status of the investor as a senior political figure and if the investor is a fund of funds or an entity that is acting as an agent or nominee on behalf of a senior political figure. Value options are 'true', 'false' or blank.
        seniorPoliticalFigureName:
          type: string
        beneOwnerType:
          type: string
          description: Type of Beneficial Owner on Form PF reporting requirements as indicated on subscription document. The full list of beneficial owner types is available from the Lists product.
        beneOwnerName:
          type: string
          description: Name of the beneficial owner on Form PF. Form PF is a report provided to the Securities and Exchange Commission (SEC) by private product managers.
        aifmdInvestorType:
          type: string
          description: The Alternative Investment Fund Managers Directive 2011/61/EU (AIFMD) is an EU law on the financial regulation of hedge funds, private equity, real estate funds and other Alternative Investment Fund Managers in the European Union. The full list of AIFMD types is available from the Lists API.
        reverseSolicitCert:
          type: boolean
          description: Indicates the investor's AIFMD reverse solicitation status. Value options are Yes, No or blank.
        cpoInvestorType:
          type: string
        cpoExempt:
          type: string
          description: Information about the reason for exemption as indicated on the subscription document. Free text.
        regExemptCpo:
          type: string
          description: Status of the CPO as indicated on the subscription document. Value options are Exempt, Registered or blank.
        fatcaPreexisting:
          type: boolean
          description: Indicator that denotes whether the Investor was a pre-existing FATCA account. Value of true indicates pre-existing.
        crsPreexisting:
          type: boolean
          description: Indicator that denotes whether the Investor was a pre-existing CRS account. Value of true indicates pre-existing. CRS is Common Standard on Reporting, the global version of FATCA.
        investorIsInsuranceCo:
          type: boolean
          description: Identifies if the investor is an insurance company.
        placementAgent:
          type: string
          description: Identifies if a placement agent was used to bring the investor into the fund. Value options are Yes, No, N/A or blank. A placement agent is an intermediary who raises capital for an investment fund by bringing qualified investors to the investment manager.
        regDBadActor:
          type: boolean
          description: Indicates if the investor qualifies for Regulation D Bad Actor status. Value options are Yes, No or blank.
        regDDesc:
          type: string
          description: Describes the nature of the Regulation D status.
        usGovtEntity:
          type: boolean
          description: The collection of data points specific to an investor who is a government entity or investing on behalf of a government entity.
        usBankHoldingCo:
          type: boolean
          description: Indicator that denotes whether the investor is  a bank holding company. A bank holding company is a company that controls one or more banks, but does not necessarily engage in banking itself.
        investorGovtEntityAffiliation:
          type: boolean
          description: Indicates whether this Investor is a US government entity.
        cftcCertification:
          type: boolean
          description: Identifies the investor's Commodity Futures Trading Commission (CFTC) Rule 4.7 status. Value options are true, false or blank.
        nfaId:
          type: string
          description: National Futures Association (NFA) number for the Investor as indicated on the subscription document.
        address:
          $ref: '#/components/schemas/Address'
    ThirdParties:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        primaryContact:
          type: boolean
          description: Designates who is the primary contact for the investor and/or product.
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        prefix:
          type: string
          description: Prefix for a Third Party where Third Party is an Individual. Value for Prefix - Mr., Mrs., Ms., Dr.
        firstName:
          type: string
          description: The first name for the financial advisor, investor,manager or contact or third party
        middleName:
          type: string
          description: Middle name for Third Party 
        lastName:
          type: string
          description: Last name for Third Party
        suffix:
          type: string
          description: Suffix for a Third Party where Third Party is an Individual.Value for Suffix - Jr., Sr., Esq.
        classification:
          type: string
          description: Identifies whether the investor is an individual or entity.
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
        dob:
          type: string
          format: date
          description: Date of birth or date of formation in the format MM/DD/YYYY.
        birthCountryIsoCode:
          type: string
          description: Investor's country of birth provided on subscription document in ISO 3166-1 alpha-2 code format.
        citizenshipCountryIsoCode:
          type: string
          description: Identifies the country of nationality for the investor in ISO 3166-1 alpha-2 code format.
        phoneCountryCode:
          type: string
        phoneNumber:
          type: string
          description: The contact's phone number. Phone numbers may not be maintained for the contact.
        phoneType:
          type: string
        email:
          type: string
          description: The email address at which communications can be sent or received.
        address:
          $ref: '#/components/schemas/Address'
    Transactions:
      type: object
      properties:
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        transactionType:
          type: string
          description: Describes the type of transaction.
        productName:
          type: string
          description: One of three values that determine the kit which drives the process and form details that will need to be completed (i.e. WWC Event Driven Fund, L.P.). The other fields are requestType and and channel.
        productId:
          type: string
          description: The SEI internal system identifier for the product or fund. This query parameter is used to retrieve a limited set of positions data.
        subProductName:
          type: string
          description: The name of description specific to the subproduct, such as a class, series or vehicle.
        subProductId:
          type: string
        amountType:
          type: string
          description: Specifies whether the transaction amount is in $, % or shares.
        currencyIsoCode:
          type: string
          description: The currency code in which the transaction is paid in.
        amount:
          type: number
          format: double
          description: Debit Credit Amount
        unitAmount:
          type: number
          format: double
          description: Transaction amount when in shares or percent.
        placementFees:
          type: number
          format: double
          description: Placement fees, only applicable for incoming transactions.
        effectiveDate:
          type: string
          description: Date on which something becomes or was instituted within the context of the API in ISO 8601 UTC format. Format MM/DD/YYYY.
        transferTo:
          $ref: '#/components/schemas/TransferTo'
    WireInstructions:
      type: object
      properties:
        financialInstitution:
          $ref: '#/components/schemas/FinancialInstitution'
        beneficiary:
          $ref: '#/components/schemas/Beneficiary'
        ultimateBeneficiary:
          $ref: '#/components/schemas/UltimateBeneficiary'
        effectiveDate:
          type: string
          description: Date on which something becomes or was instituted within the context of the API in ISO 8601 UTC format. Format MM/DD/YYYY.
        additionalWireInfo:
          type: string
          description: Free text with additional information related to the wire instruction.
        chipsParticipantNumber:
          type: string
          description: Clearing House Interbank Payments System (CHIPS) approved participant identification number.
        alternateFinancialInstitution:
          type: string
          description: A collection of data specifc to a financial instiution where the financial institution is used in an alternate capacity, and is not being used as the primary.
    CustomFields:
      type: object
      properties:
        field:
          type: string
        value:
          type: string
          description:   Describes the value that will be taken for the selected label.
    Address:
      type: object
      properties:
        type:
          type: string
          description: Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.
        attention1:
          type: string
          description: The first attention line of the address, typically used for a specific recipient.
        attention2:
          type: string
          description: The second attention line of the address.
        addressLine1:
          type: string
          description: The first line of the address, typically used for the street address.
        addressLine2:
          type: string
          description: The second line of the address.
        addressLine3:
          type: string
          description: The third line of the address.
        addressLine4:
          type: string
          description: The fourth line of the address.
        city:
          type: string
          description: The city of the address.
        stateCode:
          type: string
          description: The two character code for US and Canadian states and provinces.
        stateName:
          type: string
        postalCode:
          type: string
          description: The postal code of the address.
        countryIsoCode:
          type: string
          description: ISO country code ISO 3166-1 alpha-2 code format.
    TransferTo:
      type: object
      properties:
        fullName:
          type: string
          description: The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.
        externalId:
          type: string
          description: Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application.  Many times the externalId is used to synchronize SEI sourced data with another data source for the same record.
        alternateId:
          type: string
          description: Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        accountNumber:
          type: string
          description: This is the General Ledger Financial Account Number
        taxIdType:
          type: string
          description: Party Tax Identifier Type.
        taxId:
          type: string
          description: Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing.
    FinancialInstitution:
      type: object
      properties:
        name:
          type: string
          description: Indicates the name of the bank or other financial institution dealing with monetary transactions.
        code:
          type: string
          description: ‘Swift’ or ‘ABA’ Code to identify the Financial Institution. A full or partial code is required if a value is not passed in the ‘Name’ parameter. ie. If a user passes Type=ABA, Code= 001, the results will return all financial institutions with ‘001’ in the ABA code.
        type:
          type: string
          description: Type of Financial Institution
    Beneficiary:
      type: object
      properties:
        fullName:
          type: string
          description: Specific to a wire instruction, this is the collection of data that defines the receiving bank used to faciliate money movement.
        accountNumber:
          type: string
          description:   This is the General Ledger Financial Account Number
        abaRoutingNumber:
          type: string
          description: Beneficiary American Bankers Association (ABA) routing number for money movement.
        swiftBic:
          type: string
          description: Ultimate beneficiary Society for Worldwide Interbank Financial Telecommunication (SWIFT) code, also known as a Bank Identifier Code (BIC), for money movement.
        iban:
          type: string
          description: Ultimate beneficiary International Bank Account Number (IBAN) for money movement.
        sortCode:
          type: string
          description: Beneficiary sort code for money movement.
    UltimateBeneficiary:
      type: object
      properties:
        fullName:
          type: string
          description: Specific to a wire instruction, this is the collection of data that defines the receiving bank used to faciliate money movement.
        accountNumber:
          type: string
          description:   This is the General Ledger Financial Account Number
        swiftBic:
          type: string
          description: Ultimate beneficiary Society for Worldwide Interbank Financial Telecommunication (SWIFT) code, also known as a Bank Identifier Code (BIC), for money movement.
        iban:
          type: string
          description: Ultimate beneficiary International Bank Account Number (IBAN) for money movement.
    getAutofillResults:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data'
    Data:
      type: object
      properties:
        baseDocument:
          $ref: '#/components/schemas/ElementData'
        subFormData:
          type: array
          items:
            $ref: '#/components/schemas/SubFormData'
    ElementData:
      type: object
      properties:
        accountHolders:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/AccountHolders'
        advisor:
            $ref: '#/components/schemas/AdvisorData'
        beneficialOwners:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/BeneficialOwners'
        beneficiaries:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Beneficiaries'
        custodian:
          $ref: '#/components/schemas/Custodian'
        endClient:
          $ref: '#/components/schemas/EndClient'
        investor:
          $ref: '#/components/schemas/InvestorData'
        thirdParties:
          type: array
          items:
            $ref: '#/components/schemas/ThirdParties'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transactions'
        wireInstructions:
          $ref: '#/components/schemas/WireInstructions'
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFields'
    SubFormData:
      type: object
      properties:
        name:
          type: string
          description: The business description for an entity in the context of the API, sometimes called a proper name. A name can apply to a Calendar, Financial Institution, Investor, Account, Advisor and various other entities.
        subformDocument:
            $ref: '#/components/schemas/ElementData'
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: The code to identify the warning/failure.
        message:
          type: string
          description: Message indicates that the web service has accomplished the said functionality.
        userMessage:
          type: string
          description: A localized message based on the locale of the user. If unspecified, defaults to message.
        trackingId:
          type: string
          description: A unique tracking ID assigned to a specific request.
        transient:
          type: boolean
        documentationalUrl:
          type: string
          description: An optional field for linking to external documentation about the record.
        remediationInfo:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Errors'
        debugInfo:
          type: array
          items:
            $ref: '#/components/schemas/DebugInfo'
    Errors:
      type: object
      properties:
        field:
          type: string
        location:
          type: string
        reason:
          type: string
    DebugInfo:
      type: object
      properties:
        type:
          type: string
        reason:
          type: string
        remediationMsg:
          type: string
        debugInfo:
          type: array
          items:
            $ref: '#/components/schemas/DebugInfo'
    Class:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
    SubForm:
      type: object
      properties:
        name:
          type: string
          description: Unique name of the subform
        id:
          type: string
          description: Unique id of the subform.
        isAlwaysShow:
          type: integer
          format: int32
          enum:
          - 0
          - 1
    KitInformationResults:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/KitInformation'
    KitInformation:
      type: object
      properties:
        productName:
          type: string
          description: One of three values that determine the kit which drives the process and form details that will need to be completed (i.e. WWC Event Driven Fund, L.P.). The other fields are requestType and and channel.
        channel:
          type: string
          description: Unique name of the channel.
        transactionType:
          type: string
          description: Describes the type of transaction.
        classes:
          type: array
          items:
            $ref: '#/components/schemas/Class'
        workflowName:
          type: string
          description: Unique name of the workflow.
        kitStatus:
          type: integer
          format: int32
          description: Unique status of the kit.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
        lastUpdatedDate:
          type: string
          format: date-time
          description: The most recent update on the request state represented in a date time stamp format
        signingOptions:
          type: array
          items:
            type: string
            enum:
            - ESign
            - Manual
        subForms:
          type: array
          items:
            $ref: '#/components/schemas/SubForm'
    SubformInformationResults:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubformInformation'
    SubformInformation:
      type: object
      properties:
        subFormName:
          type: string
          description: Unique name of the subform.
        subformId:
          type: string
          description: Unique id of the subform.
        subformStatus:
          type: integer
          format: int32
          description: Unique status of the subform.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
        lastUpdatedDate:
          type: string
          format: date-time
          description: The most recent update on the request state represented in a date time stamp format
          example: 2020-11-03T19:04:00:610Z
        kits:
          type: array
          items:
            $ref: '#/components/schemas/Kit'
    Kit:
      type: object
      properties:
        productName:
          type: string
          description: One of three values that determine the kit which drives the process and form details that will need to be completed (i.e. WWC Event Driven Fund, L.P.). The other fields are requestType and and channel.
        channel:
          type: string
          description: Unique name of the channel.
        transactionType:
          type: string
          description: Describes the type of transaction.
  examples:
    CustomFieldExample:
      value:
            - field: payer1
              displayName: payer1
              dataType: String
            - field: amount1
              displayName: amount1
              dataType: Number
            - field: reference1
              displayName: reference1
              dataType: String
            - field: payer2
              displayName: payer2
              dataType: String
            - field: amount2
              displayName: amount2
              dataType: Number
            - field: reference2
              displayName: reference2
              dataType: String
            - field: payer3
              displayName: payer3
              dataType: String
            - field: amount3
              displayName: amount3
              dataType: Number
            - field: reference3
              displayName: reference3
              dataType: String
            - field: payer4
              displayName: payer4
              dataType: String
            - field: amount4
              displayName: amount4
              dataType: Number
            - field: reference4
              displayName: reference4
              dataType: String
            - field: payer5
              displayName: payer5
              dataType: String
            - field: amount5
              displayName: amount5
              dataType: Number
            - field: reference5
              displayName: reference5
    HealthcheckExample:
      value:
        data:
          backendApi: available
          database: available