openapi: 3.0.1
info:
  title: Lists
  version: v1
  description: Retrieve a predefined list of values from a source of fields in SEI's KYC system. A master List of Lists can be viewed, along with the actual values associated to each List. These lists can collectively be used with existing products in the Investor Lifecycle.
servers:
  - url: 'https://build.api.seic.com/v1'
    description: Integration Server with masked data.
  - url: 'https://test.api.seic.com/v1'
    description: Test Server with unmasked data.
  - url: 'https://api.seic.com/v1'
    description: Production Server with unmasked data.
paths:
  /lists/metadata:
    get:
      tags:
      - Lists Metadata
      operationId: lists
      summary: Returns the collection of all reference data as it pertains to Investors, Contacts, their relationships and pending capital transaction activity.
      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: externalId
        in: query
        description: The pneumonic of the lookup name
        schema:
          type: string
      - name: name
        in: query
        description: The look up name.
        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
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMetadata'
              examples:
                Example:
                  value:
                    externalId: ABCDE
                    name: ApprovalQueueCategoryType
                    displayName: Approval Queue Category Type
                    createDate: 2018-05-25T15:13:25:287
                    changeDate: 2018-05-25T15:13:25:287
                    links: 
                      rel: List
                      href: https://api.seic.com/v1/lists?externalId=ABCDE
                    child: 
                      externalId: ABCDESUB
                      name: ApprovalQueueSubCategoryType
                      displayName: Approval Queue Sub Category Type
                      createDate: 2018-05-25T15:13:25:287
                      changeDate: 2018-05-25T15:13:25:287
                      links: 
                            rel: List
                            href: https://api.seic.com/v1/lists?externalId=ABCDESUB
                    paging: 
                      totalCount: 165
                      limit: 0
                      first: null
                      last: null
                      previous: null
                      next: null
                      self: https://api.seic.com/v1/lists/metadata?limit
        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
  /lists:
    get:
      tags:
      - List Values
      operationId: listsByPneumonic
      summary: Returns the acceptable values for a specific List.
      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
          default: Bearer ADsgdnnkjnfdIKJN
      - 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
          default: gsedgaerhDSHGRSH
      - name: externalId
        in: query
        required: true
        description: The pneumonic of the lookup name
        schema:
          type: string
      - 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
      responses:
        200:
          description: OK- The request has succeeded and the response has been returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListValues'
              examples:
                Example:
                  value:
                    data: 
                      externalId: ABCDE
                      name: ApprovalQueueCategoryType
                      id: 1
                      displayName: Approval Queue Category Type
                      valueId: Firm
                      changeDate: 2018-08-23T18:23:39.79
                      createDate: 2015-08-21T20:01:22.0366667
                      valueExternalId: M1
                      valueDisplayName: null
                      parentId: null
                      permissionCode: null
                      sortOrder: 2
                      child: 
                        externalId: ABCDESUB
                        name: ApprovalQueueSubCategoryType
                        id: 1
                        displayName: Approval Queue Sub Category Type
                        valueId: Firm Information
                        changeDate: 2018-08-23T18:23:39.79
                        createDate: 2015-08-21T20:01:22.16
                        valueExternalId: M1
                        valueDisplayName: null
                        parentId: 1
                        permissionCode: null
                        sortOrder: 13
                    paging: 
                        totalCount: 8
                        limit: 0
                        first: null
                        last: null
                        previous: null
                        next: null
                        self: https://api.seic.com/v1/lists?externalId=ABCDE&limit=1
        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:
    ListMetadata:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CodeListClassType'
        paging:
          type: object
          properties:
            totalCount:
              type: integer
            limit:
              type: integer
            first:
              type: string
            last:
              type: string
            previous:
              type: string
            next:
              type: string
            self:
              type: string
    ListValues:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ListItem'
        paging:
          type: object
          properties:
            totalCount:
              type: integer
            limit:
              type: integer
            first:
              type: string
            last:
              type: string
            previous:
              type: string
            next:
              type: string
            self:
              type: string
    ListItem:
      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.
        name:
          type: string
          description: The first, last, and middle name of the user as available in the SEI application.
        id:
          type: string
          description: The unique identifier for an entity such as a calendar, event, document, account, position or tax lot.
        displayName:
          type: string
        valueId:
          type: string
        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
        valueExternalId:
          type: string
        valueDisplayName:
          type: string
        parentId:
          type: string
          description: Insight unique product system identifier of the parent product, when one exists. Typically a series rolls up to a class and a class rolls up to fund.
        permissionCode:
          type: string
        sortorder:
          type: number
          description: Default sortOrder is ascending and '-' can be passed for descending.
        child:
          type: array
          items:
            $ref: '#/components/schemas/ListItemChild'
    CodeListClassType:
      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.
        name:
          type: string
          description: The first, last, and middle name of the user as available in the SEI application.
        displayName:
          type: string
        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
        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
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        child:
          type: array
          items:
            $ref: '#/components/schemas/CodeListClassTypeChild'
    Link:
      type: object
      properties:
        rel:
          type: string
          description: The name of a link returned by the href URL. This is immutable.
        href:
          type: string
          description: Fully configured URL to obtain more information regarding an entity. Allows for easier navigation across products. These links should not be cached.
    CodeListClassTypeChild:
      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.
        name:
          type: string
          description: The first, last, and middle name of the user as available in the SEI application.
        displayName:
          type: string
        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
        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
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    ListItemChild:
      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.
        name:
          type: string
          description: The first, last, and middle name of the user as available in the SEI application.
        id:
          type: string
          description: The unique identifier for an entity such as a calendar, event, document, account, position or tax lot.
        displayName:
          type: string
        valueId:
          type: string
        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
        valueExternalId:
          type: string
        valueDisplayName:
          type: string
        parentId:
          type: string
          description: Insight unique product system identifier of the parent product, when one exists. Typically a series rolls up to a class and a class rolls up to fund.
        permissionCode:
          type: string
        sortorder:
          type: number
          description: Default sortOrder is ascending and '-' can be passed for descending.