openapi: 3.0.1
info:
  title: Investors Wire Instructions
  version: v1
  description: Retrieve wire instructions associate with an investor for money movement.
servers:
  - url: 'https://build.api.seic.com/v1/investors'
    description: Integration Server with masked data.
  - url: 'https://test.api.seic.com/v1/investors'
    description: Test Server with unmasked data.
  - url: 'https://api.seic.com/v1/investors'
    description: Production Server with unmasked data.
paths:
  /{investorExternalId}/wireInstructions:
    get:
      tags:
      - wireInstructions
      operationId: wireInstructions
      summary: Returns all the information related to an investor identified by investor's externalId that is required to perform money movement
      parameters:
      - name: Authorization
        in: header
        required: true
        description: access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"
        schema:
          type: string
      - name: AppKey
        in: header
        required: true
        description: This is the Consumer Key provided during the App Registration process and is used to identify the user's application.
        schema:
          type: string
      - name: investorExternalId
        in: path
        required: true
        description: The client specific or external identifier that represents the product, fund, contact, investor, 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 records.
        schema:
          type: string
      - name: type
        in: query
        description: Method by which money is moved. Value options are 'SWIFT_BIC' or 'ABARoutingNo'.
        schema:
          type: string
      - name: active
        in: query
        description: Designates whether the wire instruction is active ("true") or inactive ("false").
        schema:
          type: boolean
      - name: lastModifiedSince
        in: query
        description: Valid values are thisQuarter, thisYear, thisMonth, thisWeek, yesterday
        schema:
          type: string
      - name: createdSince
        in: query
        description: Valid values are thisQuarter, thisYear, thisMonth, thisWeek, yesterday
        schema:
          type: string
      - name: productExternalId
        in: query
        description: Unique business identifier for a product recognized by SEI and a third party system or application.  Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.
        schema:
          type: string
      - name: investorAlternateId
        in: query
        description: Indicates the external investor Alternate identifier related to the contact relationship. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        schema:
          type: string
      - name: fundInvestorExternalId
        in: query
        description: Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor external ID is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.
        schema:
          type: string
      - name: validateRequest
        in: query
        schema:
          type: string
      - name: limit
        in: query
        description: Number of records per page. Many responses have a maximum of 50 records per page.
        schema:
          type: string
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultInvestorWireInstruction'
        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.
          content:
            application/json:
              schema:
                type: string
        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.
          content:
            application/json:
              schema:
                type: string
        403:
          description: Forbidden-The SEI Server understood the request but refuses
            to fulfill it.
          content:
            application/json:
              schema:
                type: string
        404:
          description: Not Found- The requested resource or the underlying resource
            does not exist.  Please resubmit the request after making the required
            corrections
          content:
            application/json:
              schema:
                type: string
        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.
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    ResultInvestorWireInstruction:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InvestorWireInstruction'
        paging:
          $ref: '#/components/schemas/Paging'
    InvestorWireInstruction:
      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.
          example: 9999-5
        investorExternalId:
          type: string
          description: Unique business identifier that represents an investor entity recognized by SEI and a third party system or application.
          example: Crump
        investorAlternateId:
          type: string
          description: Indicates the external investor Alternate identifier related to the contact relationship. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.
        fundInvestorExternalId:
          type: string
          description: Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor external ID is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.
        productExternalId:
          type: string
          description: Unique business identifier for a product recognized by SEI and a third party system or application.  Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.
        active:
          type: boolean
          description: Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis.
          example: true
        financialInstitution:
          $ref: '#/components/schemas/WireInstructionFinancialInstitution'
        alternateFinancialInstitution:
          $ref: '#/components/schemas/WireInstructionFinancialInstitution'
        templateId:
          type: string
        effectiveDate:
          type: string
          format: date-time
          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.
        groupWireFlag:
          type: boolean
          description: This flag on a wire instruction represents where money is pooled and sent to an intermediate (typically a custodian) who is responsible to make final payment to the end investor.
          example: false
        changeDate:
          type: string
          format: date-time
          description: 	Latest date the entity relevant to the API was modified. Datetime is Eastern Standard Time (EST). Date Format is UTC YYYY-MM-DDThh:mm:ss:mmm
        createDate:
          type: string
          format: date-time
          description: Initial create timestamp for the record. Datetime is Eastern Standard Time (EST). Date Format is UTC YYYY-MM-DDThh:mm:ss:mmm
        beneficiary:
          $ref: '#/components/schemas/WireInstructionBeneficiary'
        ultimateBeneficiary:
          $ref: '#/components/schemas/WireInstructionUltimateBeneficiary'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Paging:
      type: object
      properties:
        cursors:
          $ref: '#/components/schemas/Cursors'
        totalCount:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        previous:
          type: string
        next:
          type: string
        self:
          type: string
        first:
          type: string
        last:
          type: string
    WireInstructionFinancialInstitution:
      type: object
      properties:
        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."
          example: LUOBLCLCXXX
        name:
          type: string
          description: "The first, last, and middle name of the user as available in the SEI application."
          example: 1ST NATIONAL BANK ST.LUCIA LIMITED
        type:
          type: string
          description: "Describes the type of transaction. A full list of transaction types can be obtained through the Lists API."
          example: SWIFT_BIC
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    WireInstructionBeneficiary:
      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."
          example: CYPRUS POPULAR BANK PUBLIC CO LTD
        accountNumber:
          type: string
          description: "Code which uniquely identifies an individual or entity."
        abaRoutingNumber:
          type: string
          description: "Beneficiary American Bankers Association (ABA) routing number for money movement."
        iban:
          type: string
          description: "Ultimate beneficiary International Bank Account Number (IBAN) 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."
          example: LIKICY2NDOC
        sortCode:
          type: string
          description: "Beneficiary sort code for money movement."
    WireInstructionUltimateBeneficiary:
      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."
          example: INDUSTRIALBANK
        accountNumber:
          type: string
          description: "Code which uniquely identifies an individual or entity."
        iban:
          type: string
          description: "Ultimate beneficiary International Bank Account Number (IBAN) 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."
          example: IJSOUA2NDNI
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
    Cursors:
      type: object
      properties:
        before:
          type: string
        after:
          type: string
        max:
          type: string
        last:
          type: string
        resultCount:
          type: integer
          format: int32