openapi: 3.0.1
info:
  title: Shareworks Admin REST API
  description: Shareworks Admin REST API
  version: 1.0.0
servers:
- url: https://shareworks.solium.com/rest/admin
  description: Production
- url: https://sum-qa02.shareworks.com/rest/admin
  description: Sandbox
security:
- accessToken: []
paths:
  /v1/auth/tokens:
    post:
      tags:
      - Authentication Token
      - Read Access
      summary: POST Auth Token
      description: Create a JWT authentication request and retrieve an access token
      operationId: issue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/refresh/tokens:
    post:
      tags:
      - Authentication Token
      - Read Access
      summary: POST Refresh Auth Token
      description: Create a JWT authentication request and get a new access token
      operationId: refresh
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessTokenRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/terminate/tokens:
    post:
      tags:
      - Authentication Token
      - Read Access
      summary: POST Terminate Token
      description: 'Revoke access to the token '
      operationId: terminateSession
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessTokenRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital:
    get:
      tags:
      - Authorized Capital
      - Read Access
      summary: GET Authorized Capital
      description: Retrieve the top-level calculated cap table information for the
        company
      operationId: getCompanyEquityDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizedCapitalDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/plan/{planId}:
    get:
      tags:
      - Authorized Capital
      - Read Access
      summary: GET Authorized Capital Plan
      description: Retrieve an in-depth calculated summary for the specified plan
      operationId: getCompanyPlanDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: planId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanSummaryDetailsWithGrants'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/securities/{classOfSecurities}:
    get:
      tags:
      - Authorized Capital
      - Read Access
      summary: GET Authorized Capital Class
      description: Retrieve an in-depth calculated summary for the specified class
        of securities
      operationId: getCompanySecuritiesDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: classOfSecurities
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassOfSecuritiesDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/409a:
    get:
      tags:
      - Authorized Capital
      - Read Access
      summary: GET 409A Valuations
      description: Retrieve a list of the 409A valuations for all funds within a company
      operationId: getFundDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/designations:
    get:
      tags:
      - Authorized Capital
      - Read Access
      summary: GET Stock Designations (All)
      description: Retrieve a list of all stock designations within a company
      operationId: getStockDesignations
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecuritiesDesignationDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/award-type:
    get:
      tags:
      - Award Type
      - Read Access
      summary: GET Award Type (All)
      description: Retrieve a list of all award types assigned to the specified company
      operationId: getAllAwardTypeDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AwardTypeDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/integration:
    post:
      tags:
      - Company Integration
      - Read Access
      summary: POST Company Integration Key
      description: Verifies and Activates a Company Integration Key
      operationId: submit
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyIntegrationRequest'
      responses:
        '201':
          description: Successfully activated the Company Integration Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyIntegrationDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company:
    get:
      tags:
      - Company
      - Read Access
      summary: GET Company (All)
      description: Retrieve the details of all managed companies
      operationId: getAllCompanyDetails
      parameters:
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 50. Maximum is
          250
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Company
      - Write Access
      summary: POST Company (Create)
      description: Create a new private company with the default setup
      operationId: createCompany
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}:
    get:
      tags:
      - Company
      - Read Access
      summary: GET Company (Single)
      description: Retrieve the details of the specified company
      operationId: getCompanyDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Company
      - Write Access
      summary: PUT Company (Update)
      description: Update the details of the specified company
      operationId: updateCompany
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/plan:
    post:
      tags:
      - Plan
      - Write Access
      summary: POST Plan (Create)
      description: Create a plan for the specified company
      operationId: createEquityIncentivePlan
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharePoolPlanCreationRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharePoolPlanDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/{stakeholderId}/stock-certificate:
    get:
      tags:
      - Stock Certificate
      - Read Access
      summary: GET Stock Certificate (All)
      description: Retrieve the details of all stock certificates belonging to the
        specified stakeholder
      operationId: getStockCertificates
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 50. Maximum is
          250
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StockCertificateDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Stock Certificate
      - Write Access
      summary: POST Stock Certificate (Create)
      description: Create a stock certificate for the specified stakeholder
      operationId: createStockCertificate
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: true
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockCertificateCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockCertificateDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/stock-certificate/{stockCertificateId}:
    get:
      tags:
      - Stock Certificate
      - Read Access
      summary: GET Stock Certificate (Single)
      description: Retrieve the details of the specified stock certificates
      operationId: getStockCertificate
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stockCertificateId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockCertificateDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Stock Certificate
      - Write Access
      summary: PUT Stock Certificate (Update)
      description: Update the details of the specified stock certificate
      operationId: updateStockCertificate
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stockCertificateId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockCertificateCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockCertificateDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/stock-designation:
    post:
      tags:
      - Stock Filing
      - Write Access
      summary: POST Stock Filing Designation (Create)
      description: Create a new stock filing by adding one new stock designation to
        the most recent filing
      operationId: createStockFilingWithNewDesignation
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockFilingWithNewDesignationCreationRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockFilingDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/authorized-capital/stock-filing/latest:
    get:
      tags:
      - Stock Filing
      - Read Access
      summary: GET Stock Filing (Latest)
      description: Retrieve the details of the company's most recent stock filing
      operationId: getStockFilingLatestDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockFilingDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/vesting-schedule:
    get:
      tags:
      - Vesting Schedule
      - Read Access
      summary: GET Vesting Schedule (All)
      description: Retrieve the details of all vesting schedules for the specified
        company
      operationId: getAllVestingScheduleDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 50. Maximum is
          250
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Which page of the data set to fetch. Default is 1.
              style: simple
            Page-Size:
              description: Number of items to return per page. Default is 50. Maximum
                is 250
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VestingScheduleDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Vesting Schedule
      - Write Access
      summary: POST Vesting Schedule (Create)
      description: Create a vesting schedule for the specified company
      operationId: createVestingSchedule
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VestingScheduleCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VestingScheduleDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/vesting-schedule/manual:
    get:
      tags:
      - Vesting Schedule
      - Read Access
      summary: GET Manual Vesting Schedules (All)
      description: Retrieve the details of all manual vesting schedules for the specified
        company
      operationId: getAllManualVestingScheduleDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VestingScheduleDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/vesting-schedule/{vestingScheduleId}:
    get:
      tags:
      - Vesting Schedule
      - Read Access
      summary: GET Vesting Schedule (Single)
      description: Retrieve the details of the specified vesting schedule
      operationId: getVestingScheduleDetails
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: vestingScheduleId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VestingScheduleDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Vesting Schedule
      - Write Access
      summary: PUT Vesting Schedule (Update)
      description: Update the details of the specified vesting schedule
      operationId: updateVestingSchedule
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: vestingScheduleId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VestingScheduleCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VestingScheduleDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/board/appointment:
    post:
      tags:
      - Company Board
      - Write Access
      summary: POST Company Board Appointment (Create)
      description: Create a company board appointment to assign a stakeholder to the
        board
      operationId: createAppointment
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyBoardAppointmentCreateCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardAppointmentDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/board:
    get:
      tags:
      - Company Board
      - Read Access
      summary: GET Company Board
      description: Retrieve the details of the company board for officer/director
        tracking, including details of the company board appointments
      operationId: getCompanyBoard
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardDetailsWithAppointments'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Company Board
      - Write Access
      summary: PUT Company Board (Update)
      description: Update the details of the company board for officer/director tracking
      operationId: updateCompanyBoard
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyBoardCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Company Board
      - Write Access
      summary: POST Company Board (Create)
      description: Create the company board for officer/director tracking
      operationId: createCompanyBoard
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyBoardCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/board/appointment/{appointmentId}:
    get:
      tags:
      - Company Board
      - Read Access
      summary: GET Company Board Appointment
      description: Retrieve the details of the specified company board assignment
      operationId: getBoardAppointment
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: appointmentId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardAppointmentDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Company Board
      - Write Access
      summary: 'PUT Company Board Appointment (Update) '
      description: Update the details of the specified company board appointment
      operationId: updateAppointment
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: appointmentId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyBoardAppointmentUpdateCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyBoardAppointmentDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/{stakeholderId}/grant:
    get:
      tags:
      - Grant
      - Read Access
      summary: GET Grant (All)
      description: Retrieve the details of all grants belonging to the specified stakeholder
      operationId: getStakeholderGrants
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 50. Maximum is
          250
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StakeholderGrantDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Grant
      - Write Access
      summary: POST Grant (Create)
      description: Create a grant for the specified stakeholder
      operationId: createStakeholderGrant
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: true
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StakeholderGrantCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StakeholderGrantDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/grant/{grantId}:
    get:
      tags:
      - Grant
      - Read Access
      summary: GET Grant (Single)
      description: Retrieve the details of the specified grant
      operationId: getStakeholderGrant
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: grantId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StakeholderGrantDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Grant
      - Write Access
      summary: PUT Grant (Update)
      description: Update the details of the specified grant
      operationId: updateStakeholderGrant
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: grantId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StakeholderGrantCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StakeholderGrantDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/holdings:
    get:
      tags:
      - Holdings
      - Read Access
      summary: GET Holdings (All)
      description: Retrieve the calculated summary of the holding for all stakeholders
        in the company. This includes the calculated breakdown for all individual
        stock certificates and grants
      operationId: getAllStakeholderHoldings
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StakeholderHoldingsSummaryDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/holdings/{stakeholderId}:
    get:
      tags:
      - Holdings
      - Read Access
      summary: GET Holdings (Single)
      description: Retrieve the calculated summary of the holding for a single stakeholder.
        This includes the calculated breakdown for all individual stock certificates
        and grants
      operationId: getStakeholderHoldings
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StakeholderHoldingsSummaryDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/entity:
    get:
      tags:
      - Entity Stakeholder
      - Read Access
      summary: GET Entity Stakeholder (All)
      description: Retrieve the details for all entity stakeholders in the company
      operationId: getCompanyStakeholderEntities
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 100. Maximum is
          500
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EntityStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Entity Stakeholder
      - Write Access
      summary: 'POST Entity Stakeholder (Create) '
      description: Create an entity stakeholder for the specified company
      operationId: createEntityStakeholder
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: true
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityStakeholderCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityStakeholderDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/individual:
    get:
      tags:
      - Individual Stakeholder
      - Read Access
      summary: GET Individual Stakeholder (All)
      description: Retrieve the details of all individual stakeholders in the company
      operationId: getAllIndividualStakeholders
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 100. Maximum is
          500
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndividualStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    post:
      tags:
      - Individual Stakeholder
      - Write Access
      summary: POST Individual Stakeholder (Create)
      description: Create an individual stakeholder for the specified company
      operationId: createIndividualStakeholder
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: true
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndividualStakeholderCrudRequest'
      responses:
        '201':
          description: Created. An object is created and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualStakeholderDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/entity/{stakeholderId}:
    get:
      tags:
      - Entity Stakeholder
      - Read Access
      summary: GET Entity Stakeholder (Single)
      description: Retrieve the details of the specified entity stakeholder
      operationId: getEntityStakeholder
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Entity Stakeholder
      - Write Access
      summary: PUT Entity Stakeholder (Update)
      description: Update the details of the specified entity stakeholder
      operationId: updateEntityStakeholder
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityStakeholderCrudRequest'
      responses:
        '201':
          description: Updated. An object is updates and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/individual/{stakeholderId}:
    get:
      tags:
      - Individual Stakeholder
      - Read Access
      summary: GET Individual Stakeholder (Single)
      description: Retrieve the details of the specified individual stakeholder
      operationId: getIndividualStakeholder
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
    put:
      tags:
      - Individual Stakeholder
      - Write Access
      summary: PUT Individual Stakeholder (Update)
      description: Update the details of the specified individual stakeholder
      operationId: updateIndividualStakeholder
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: stakeholderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndividualStakeholderCrudRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualStakeholderDetails'
        '400':
          description: The request was unacceptable, often due to missing a required
            parameter, malformed query, or malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/entity/search:
    post:
      tags:
      - Entity Stakeholder
      - Read Access
      summary: POST Entity Search
      description: Create a search and retrieve a list of entity stakeholders matching
        the criteria
      operationId: createStakeholderSearchForEntities
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 100. Maximum is
          500
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityStakeholderSearchRequest'
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EntityStakeholderDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
  /v1/company/{companyId}/stakeholder/individual/search:
    post:
      tags:
      - Individual Stakeholder
      - Read Access
      summary: POST Individual Search
      description: Create a search and retrieve a list of individual stakeholders
        matching the criteria
      operationId: createStakeholderSearchForIndividuals
      parameters:
      - name: Shareworks-Request-Id
        in: header
        description: An identifier unique to this request.  If a connection is broken
          or a response does not come in a timely manner, submit the same request
          again with this same identifier. Shareworks ensures that duplicate requests
          with the same identifier will only be processed once and will all return
          the same response.
        required: false
        schema:
          type: string
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of items to return per page. Default is 100. Maximum is
          500
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: Which page of the data set to fetch. Default is 1.
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndividualStakeholderSearchRequest'
      responses:
        '200':
          description: OK
          headers:
            Page-Number:
              description: Identifies which page of the target data set is returned
                in this response (1 to n). (Only present when the response is paginated)
              style: simple
            Page-Size:
              description: The number of items per page used to paginate the target
                data set. (Only present when the response is paginated)
              style: simple
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndividualStakeholderDetails'
        '400':
          description: "The request was unacceptable, often due to missing a required\
            \ parameter, malformed query, or malformed request body.\n\nAlso occurs\
            \ when using Shareworks-Request-Id header if:  \n- A previous request\
            \ with the identifier has been submitted but is not yet complete  \n \
            \   - errors[] will include {code: 461, message: A request with the provided\
            \ Shareworks-Request-Id is currently in-progress}  \n- A previous, but\
            \ different, request was already processed with the same identifier  \n\
            \    - errors[] will include {code: 460, message: The provided Shareworks-Request-Id\
            \ header is not unique for this user}"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '401':
          description: You request was successful and valid but you do not have access
            to this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '403':
          description: When a request tries to access a resource that doesn't belong
            to them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '422':
          description: There was a validation error. Check the error message to see
            what values caused the error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
        '500':
          description: Servers are not working as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResponse'
              encoding:
                ? ''
                : contentType: application/json
components:
  schemas:
    CompanyContactCrudRequest:
      title: Company Contact Body
      required:
      - name
      - primaryEmailAddress
      - primaryPhone
      - title
      type: object
      properties:
        name:
          type: string
          description: Full name for the company contact
        title:
          type: string
          description: Title for the company contact (e.g. CEO)
        primaryEmailAddress:
          type: string
          description: Email address for the company contact
        primaryPhone:
          type: string
          description: Primary phone number for the company contact
        primaryPhoneExt:
          type: string
          description: Primary phone extension for the company contact, if applicable
      description: List of all company contacts
    PlanSummaryDetails:
      title: Plan Summary Response
      required:
      - approved
      - governingLaw
      - numberOfGrants
      - planApprovalDate
      - planId
      - planName
      - totalCancelledShares
      - totalExercisedShares
      - totalGrantedShares
      - totalOutstandingShares
      - totalRepurchasedShares
      - totalReservedShares
      - totalSharesRemainingForIssuance
      type: object
      properties:
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        planName:
          type: string
          description: Name for the company plan
        planApprovalDate:
          type: string
          description: Approval date for the plan
          format: date
        totalReservedShares:
          type: number
          description: Total number of shares reserved for the plan
          format: double
        totalGrantedShares:
          type: number
          description: Total number of shares granted to stakeholders under the plan
          format: double
        totalExercisedShares:
          type: number
          description: Total number of granted shares exercised by the stakeholders
          format: double
        totalRepurchasedShares:
          type: number
          description: Total number of exercised shares repurchased back
          format: double
        totalCancelledShares:
          type: number
          description: Total number of shares cancelled for the plan
          format: double
        totalOutstandingShares:
          type: number
          description: Total number of shares outstanding for the plan
          format: double
        totalSharesRemainingForIssuance:
          type: number
          description: Total number of shares for the plan that are remaining to be
            issued to stakeholders
          format: double
        governingLaw:
          type: string
          description: Governing law for the plan
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        approved:
          type: boolean
          description: Approval status of the plan
        numberOfGrants:
          type: integer
          description: The total number of grants issued under the plan
          format: int32
      description: List of summary information for all plans for the company
    WrappedDataCompanyBoardAppointmentDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/CompanyBoardAppointmentDetails'
    WrappedDataEntityStakeholderDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/EntityStakeholderDetails'
    SharePoolPlanDetails:
      title: Plan Response
      required:
      - planId
      - planName
      - sharePoolInitialAuthorizedQuantity
      - sharePoolIssueDate
      - sharePoolStockDesignationId
      type: object
      properties:
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        planName:
          type: string
          description: Name for the company plan
        sharePoolIssueDate:
          type: string
          description: Issue date of the share pool
          format: date
        sharePoolInitialAuthorizedQuantity:
          type: number
          description: Initial authorized quantity of the share pool
          format: double
        sharePoolStockDesignationId:
          type: integer
          description: Identifier for the stock designation attached to the share
            pool
          format: int32
    ManualVestingRowCrudRequest:
      title: Manual Vesting Row Body
      type: object
      properties:
        vestDate:
          type: string
          description: Date on which the vesting occurs for the row/tranche
          format: date
        vestQuantity:
          type: number
          description: Quantity of shares to vest for the row/tranche
          format: double
      description: List of all manual vesting rows for the grant, specified when using
        a manual vesting schedule
    WrappedDataVestingScheduleDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/VestingScheduleDetails'
    CompanyIntegrationRequest:
      title: Company Integration Body
      required:
      - integrationKey
      type: object
      properties:
        integrationKey:
          type: string
          description: Integration key for the company
    WrappedCollectionSecuritiesDesignationDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SecuritiesDesignationDetails'
    EntityStakeholderSearchRequest:
      title: Entity Stakeholder Search Body
      type: object
      properties:
        entityName:
          type: string
          description: Name for the entity stakeholder
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
    ErrorWithCode:
      title: Validation Error
      required:
      - code
      - message
      type: object
      properties:
        message:
          type: string
          description: Message describing the error
        code:
          type: integer
          description: Unique code for the validation error
          format: int32
    CompanyAddressCrudRequest:
      title: Company Address Body
      required:
      - addressLine1
      - addressType
      - city
      - country
      - postalCode
      type: object
      properties:
        addressLine1:
          type: string
          description: First address line
        addressLine2:
          type: string
          description: Second address line, if needed
        addressLine3:
          type: string
          description: Third address line, if needed
        city:
          type: string
          description: City or municipality of the address
        stateProvince:
          type: string
          description: State or province of the address
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        country:
          type: string
          description: Country of the address
          enum:
          - CA
          - US
          - GB
          - AU
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AQ
          - AR
          - AS
          - AT
          - AW
          - AX
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BV
          - BW
          - BY
          - BZ
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EA
          - EC
          - EE
          - EG
          - EH
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GS
          - GT
          - GU
          - GW
          - GY
          - HK
          - HM
          - HN
          - HR
          - HT
          - HU
          - IC
          - ID
          - IE
          - IL
          - IM
          - IN
          - IO
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TF
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - UM
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - XK
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        postalCode:
          type: string
          description: Postal code / ZIP code of the address
        addressType:
          type: string
          description: Whether the business address, mailing address, or address for
            funds delivery
          enum:
          - BUSINESS
          - MAIL
          - FUNDS_DELIVERY
      description: List of up to three company addresses
    StakeholderHoldingsDetails:
      title: Holdings Summary Response
      required:
      - grants
      - stockCertificates
      type: object
      properties:
        stockCertificates:
          type: array
          description: List of stock certificates held by the stakeholder
          items:
            $ref: '#/components/schemas/StockCertificateSummaryDetails'
        grants:
          type: array
          description: List of grants held by the stakeholder
          items:
            $ref: '#/components/schemas/StakeholderGrantSummaryDetails'
      description: List of all stakeholder holdings (excepting warrants and convertible
        promissory notes, as yet unsupported)
    WarrantsSummaryDetails:
      title: Warrant Details Response
      required:
      - numberOfWarrants
      - percentageFullyDiluted
      - totalCommonStockEquivalentShares
      type: object
      properties:
        numberOfWarrants:
          type: integer
          description: Total number of warrants
          format: int32
        totalCommonStockEquivalentShares:
          type: number
          description: Total Common Stock Equivalent shares represented by warrants
          format: double
        percentageFullyDiluted:
          type: number
          description: Percentage of fully diluted shares outstanding across all warrants
          format: double
      description: Summary information on warrants for the company
    AccessTokenWrapper:
      title: Token Wrapper
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
    FundDetails:
      title: Fund Details Response
      type: object
      properties:
        fundName:
          type: string
          description: Full name of the fund
        fmv:
          type: number
          description: Fair market value of the fund
          format: double
        effectiveDate:
          type: string
          description: The effective date of the fund
          format: date
        expirationDate:
          type: string
          description: The expiration date of the fund
          format: date
    AccessToken:
      title: Access Token Body
      required:
      - value
      type: object
      properties:
        value:
          type: string
          description: Access Token Value
      description: Token to accompany all API requests for authentication purposes
    CompanyAddressDetails:
      title: Company Address Response
      required:
      - addressLine1
      - addressType
      - city
      - companyAddressId
      - country
      type: object
      properties:
        companyAddressId:
          type: integer
          description: Identifier for the company address
          format: int32
        addressLine1:
          type: string
          description: First address line
        addressLine2:
          type: string
          description: Second address line, if needed
        addressLine3:
          type: string
          description: Third address line, if needed
        city:
          type: string
          description: City or municipality of the address
        stateProvince:
          type: string
          description: State or province of the address
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        country:
          type: string
          description: Country of the address
          enum:
          - CA
          - US
          - GB
          - AU
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AQ
          - AR
          - AS
          - AT
          - AW
          - AX
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BV
          - BW
          - BY
          - BZ
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EA
          - EC
          - EE
          - EG
          - EH
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GS
          - GT
          - GU
          - GW
          - GY
          - HK
          - HM
          - HN
          - HR
          - HT
          - HU
          - IC
          - ID
          - IE
          - IL
          - IM
          - IN
          - IO
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TF
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - UM
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - XK
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        postalCode:
          type: string
          description: Postal code / ZIP code of the address
        addressType:
          type: string
          description: Whether the business address, mailing address, or address for
            funds delivery
          enum:
          - BUSINESS
          - MAIL
          - FUNDS_DELIVERY
      description: List of up to three company addresses
    WrappedDataStockFilingDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/StockFilingDetails'
    ManualVestingScheduleDetails:
      title: Manual Vesting Schedule Response
      required:
      - vestingScheduleDescription
      - vestingScheduleId
      - vestingScheduleName
      type: object
      properties:
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingScheduleDescription:
          type: string
          description: Sentence(s) for describing the vesting schedule
    WrappedDataStakeholderGrantDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/StakeholderGrantDetails'
    WrappedDataStockCertificateDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/StockCertificateDetails'
    WrappedDataCompanyBoardDetailsWithAppointments:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/CompanyBoardDetailsWithAppointments'
    StockFilingDetails:
      title: Stock Filing Response
      required:
      - classesOfSecurities
      - companyId
      - filingDate
      - stockFilingId
      type: object
      properties:
        stockFilingId:
          type: integer
          description: Identifier for the stock filing
          format: int32
        companyId:
          type: integer
          description: Identifier for the company
          format: int32
        filingDate:
          type: string
          description: Date on which the stock filing occurred
          format: date
        classesOfSecurities:
          type: array
          description: List of all classes of securities for the stock filing
          items:
            $ref: '#/components/schemas/StockFilingClassDetails'
    StakeholderGrantCrudRequest:
      title: Grant Body
      required:
      - allowEarlyExercise
      - awardTypeId
      - expiryDate
      - grantCurrency
      - grantDate
      - grantPrice
      - grantedShares
      - planId
      - underRule701
      - vestingScheduleId
      type: object
      properties:
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        grantName:
          type: string
          description: Name for the grant, typically generated
        awardTypeId:
          type: integer
          description: Identifier for the company award type
          format: int32
        grantDate:
          type: string
          description: Date on which the shares are granted
          format: date
        expiryDate:
          type: string
          description: Expiry date for the grant
          format: date
        grantPrice:
          type: number
          description: Price at which the shares are granted
          format: double
        grantCurrency:
          type: string
          description: Currency for the grant price / market price at time of grant
          enum:
          - USD
          - CAD
          - GBP
          - EUR
          - JPY
          - AUD
          - KRW
          - DZD
          - AOA
          - ARS
          - AMD
          - AWG
          - BSD
          - BHD
          - BDT
          - BBD
          - BOB
          - BWP
          - BRL
          - BND
          - BGN
          - BZD
          - KYD
          - CLP
          - CNY
          - COP
          - CRC
          - HRK
          - CZK
          - DKK
          - DOP
          - XCD
          - EGP
          - ETB
          - FJD
          - XAF
          - GMD
          - GHS
          - GIP
          - GTQ
          - HNL
          - HKD
          - HUF
          - ISK
          - INR
          - IDR
          - IQD
          - ILS
          - JMD
          - JOD
          - KZT
          - KES
          - KWD
          - LSL
          - MOP
          - MWK
          - MYR
          - MUR
          - MXN
          - MAD
          - MZN
          - MMK
          - NAD
          - ANG
          - NZD
          - NGN
          - NOK
          - OMR
          - PKR
          - PAB
          - PGK
          - PYG
          - PEN
          - PHP
          - PLN
          - QAR
          - RON
          - RUB
          - SAR
          - RSD
          - SCR
          - SGD
          - ZAR
          - SDG
          - LKR
          - SZL
          - SEK
          - CHF
          - TWD
          - TZS
          - THB
          - TTD
          - TND
          - TRY
          - UGX
          - UAH
          - AED
          - UYU
          - UZS
          - VEF
          - VES
          - VND
          - XOF
          - ZWL
          - ZMW
        grantedShares:
          type: number
          description: Quantity of shares for the grant
          format: double
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        marketPriceAtTimeOfGrant:
          type: number
          description: The fair market value (or latest 409A valuation for private
            companies) at the time of grant (this is typically auto-populated from
            the most recent quote, but can also be specified if desired)
          format: double
        allowEarlyExercise:
          type: boolean
          description: Whether early exercises are allowed for the grant
        underRule701:
          type: boolean
          description: Whether rule 701 applies to the grant
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the grant, specified when
            using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowCrudRequest'
        vestingAcceleration:
          type: array
          description: (Optional) List of the vesting acceleration stipulations of
            the grant. May be empty. Include one stipulation per trigger that is applicable.
          items:
            $ref: '#/components/schemas/StakeholderGrantAcceleratedVestingCrudRequest'
    WrappedDataIndividualStakeholderDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/IndividualStakeholderDetails'
    AccessTokenResponse:
      title: Token Response
      required:
      - accessToken
      - expiresIn
      - issuedAt
      - issuer
      - tokenType
      type: object
      properties:
        accessToken:
          type: string
          description: Token to accompany all API requests for authentication purposes
        expiresIn:
          type: integer
          description: Token expiry period in seconds
          format: int32
        scope:
          type: string
          description: Access scope for the token
        issuedAt:
          type: integer
          description: Issued instant for the token (Unix epoch time)
          format: int64
        issuer:
          type: string
          description: Issuer of the token
        audience:
          type: string
          description: Audience for the token
        tokenType:
          type: string
          description: Type of the token
    StockFilingDesignationDetails:
      title: Stock Filing Designation Response
      required:
      - convertible
      - parValue
      - stockDesignationId
      - stockDesignationName
      - totalAuthorizedShares
      type: object
      properties:
        stockDesignationId:
          type: integer
          description: Identifier for the stock designation
          format: int32
        stockDesignationName:
          type: string
          description: Name for the stock designation
        fundingRound:
          type: integer
          description: Funding round number for the stock designation
          format: int64
        totalAuthorizedShares:
          type: number
          description: Total number of authorized shares for the stock designation
          format: double
        parValue:
          type: number
          description: Par value for the stock designation
          format: double
        pricePerShare:
          type: number
          description: Price per share for the stock designation
          format: double
        convertible:
          type: boolean
          description: Whether the stock designation is convertible
        convertsToStockDesignationId:
          type: integer
          description: Identifier for the stock designation which the stock designation
            converts to
          format: int32
        conversionRatioAntecedent:
          type: number
          description: The antecedent of the conversion ratio. E.g. 2 for a 2:1 conversion
            (2 converted shares for each original share)
          format: double
        conversionRatioConsequent:
          type: number
          description: The consequent of the conversion ratio. E.g. 1 for a 2:1 conversion
            (2 converted shares for each original share)
          format: double
        rounding:
          type: string
          description: Rounding type used when converting shares from the stock designation
          enum:
          - NORMAL
          - UP
          - DOWN
      description: List of all stock designations for the class of securities
    CompanyBoardDetailsWithAppointments:
      title: Company Board Detailed Response
      required:
      - appointments
      - boardId
      - maximumSize
      - minimumSize
      - setAtSize
      type: object
      properties:
        boardId:
          type: integer
          description: Identifier for the company board
          format: int32
        maximumSize:
          type: integer
          description: Maximum number of stakeholders that may be on the board at
            one time
          format: int64
        minimumSize:
          type: integer
          description: Minimum number of stakeholders that must be on the board at
            one time
          format: int64
        setAtSize:
          type: integer
          description: The default, general, or target value at which the board is
            set and from which vacancies are relatively calculated
          format: int64
        quorumSize:
          type: integer
          description: Minimum amount of members required to be present to have a
            quorum
          format: int64
        appointments:
          type: array
          description: List of all company board appointments
          items:
            $ref: '#/components/schemas/CompanyBoardAppointmentDetails'
    WrappedDataStakeholderHoldingsSummaryDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/StakeholderHoldingsSummaryDetails'
    VestingScheduleRowRequest:
      title: Vesting Schedule Row Body
      required:
      - amountDenominator
      - amountNumerator
      - vestingPeriodLength
      - vestingPeriodType
      type: object
      properties:
        amountNumerator:
          type: integer
          description: Numerator of the vesting amount for the row/tranche
          format: int64
        amountDenominator:
          type: integer
          description: Denominator of the vesting amount for the row/tranche
          format: int64
        vestingPeriodLength:
          type: integer
          description: Number of periods between the row/tranche and the previous
            row/tranche (or vesting start date)
          format: int32
        vestingPeriodType:
          type: string
          description: Type of vesting period for the row/tranche
          enum:
          - YEAR
          - MONTH
          - WEEK
          - DAY
      description: List of all rows/tranches for the vesting schedule
    SharePoolPlanCreationRequest:
      title: Plan Body
      required:
      - planName
      - sharePoolInitialAuthorizedQuantity
      - sharePoolIssueDate
      - sharePoolStockDesignationId
      type: object
      properties:
        planName:
          type: string
          description: Name for the company plan
        sharePoolIssueDate:
          type: string
          description: Issue date of the share pool
          format: date
        sharePoolInitialAuthorizedQuantity:
          type: integer
          description: Initial authorized quantity of the share pool
          format: int64
        sharePoolStockDesignationId:
          type: integer
          description: Identifier for the stock designation attached to the share
            pool
          format: int32
    AuthorizedCapitalDetails:
      title: Authorized Capital Response
      required:
      - certificatedShares
      - classesOfSecurities
      - companyId
      - percentageOfFullyDilutedAvailableShares
      - percentageOfFullyDilutedOutstandingShares
      - plans
      - totalAuthorizedShares
      - totalCommonStockEquivalentShares
      - totalOutstandingShares
      - warrants
      type: object
      properties:
        companyId:
          type: integer
          description: Identifier for the company
          format: int32
        totalAuthorizedShares:
          type: number
          description: Total shares authorized across all types of securities
          format: double
        totalOutstandingShares:
          type: number
          description: Total outstanding shares across all types of securities
          format: double
        totalCommonStockEquivalentShares:
          type: number
          description: Total common equivalent (a.k.a. fully diluted) shares across
            all types of securities
          format: double
        percentageOfFullyDilutedOutstandingShares:
          type: number
          description: Percentage of fully diluted outstanding shares across all types
            of securities
          format: double
        percentageOfFullyDilutedAvailableShares:
          type: number
          description: Percentage of fully diluted available shares across all types
            of securities
          format: double
        currentFMV:
          type: number
          description: The fair market value for the company per share (usually the
            latest 409A valuation for private companies)
          format: double
        classesOfSecurities:
          type: array
          description: List of summary information for all classes of securities for
            the company
          items:
            $ref: '#/components/schemas/ClassOfSecuritiesSummaryDetails'
        warrants:
          $ref: '#/components/schemas/WarrantsSummaryDetails'
        plans:
          type: array
          description: List of summary information for all plans for the company
          items:
            $ref: '#/components/schemas/PlanSummaryDetails'
        certificatedShares:
          type: boolean
          description: Whether the stock certificates are paper (value 'false' indicates
            they are digital)
    StockFilingClassDetails:
      title: Stock Filing Class Response
      required:
      - classOfSecurities
      - designations
      - totalAuthorizedShares
      type: object
      properties:
        classOfSecurities:
          type: string
          description: Whether the class is common or preferred stock
          enum:
          - COMMON
          - PREFERRED
          - COMMON_STOCK
          - PREFERRED_STOCK
        totalAuthorizedShares:
          type: number
          description: Total number of authorized shares for the class of securities
          format: double
        designations:
          type: array
          description: List of all stock designations for the class of securities
          items:
            $ref: '#/components/schemas/StockFilingDesignationDetails'
      description: List of all classes of securities for the stock filing
    RestApiErrorResponse:
      title: Error Response
      required:
      - code
      - errorId
      - message
      type: object
      properties:
        code:
          type: string
          description: Code representing the type of error
        message:
          type: string
          description: Message describing the error
        errors:
          type: array
          description: List of all further error details, usually due to validation
            checks
          items:
            $ref: '#/components/schemas/ErrorWithCode'
        errorId:
          type: string
          description: Identifier for the error
    CompanyContactDetails:
      title: Company Contact Response
      required:
      - contactId
      - name
      type: object
      properties:
        contactId:
          type: integer
          description: Identifier for the company contact
          format: int32
        name:
          type: string
          description: Full name for the company contact
        title:
          type: string
          description: Title for the company contact (e.g. CEO)
        primaryEmailAddress:
          type: string
          description: Email address for the company contact
        primaryPhone:
          type: string
          description: Primary phone number for the company contact
        primaryPhoneExt:
          type: string
          description: Primary phone extension for the company contact, if applicable
      description: List of all company contacts
    IndividualStakeholderSearchRequest:
      title: Individual Stakeholder Search Body
      type: object
      properties:
        firstName:
          type: string
          description: First name for the stakeholder
        lastName:
          type: string
          description: Last name for the stakeholder
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
    EntityStakeholderCrudRequest:
      title: Entity Stakeholder Body
      type: object
      properties:
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
        entityName:
          type: string
          description: Name for the entity stakeholder
    WrappedDataAuthorizedCapitalDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/AuthorizedCapitalDetails'
    StakeholderGrantSummaryDetails:
      title: Grant Summary Response
      required:
      - allowEarlyExercise
      - awardTypeId
      - awardTypeName
      - cancelledShares
      - exercisedShares
      - expiryDate
      - grantCurrency
      - grantDate
      - grantId
      - grantName
      - grantNumber
      - grantPrice
      - grantedShares
      - marketPriceAtTimeOfGrant
      - outstandingShares
      - planId
      - stakeholderId
      - underRule701
      - vestingScheduleId
      - vestingScheduleName
      - vestingStartDate
      type: object
      properties:
        grantId:
          type: integer
          description: Identifier for the grant
          format: int32
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        awardTypeId:
          type: integer
          description: Identifier for the company award type
          format: int32
        awardTypeName:
          type: string
          description: Name for the company award type
        grantName:
          type: string
          description: Name for the grant, typically generated
        grantNumber:
          type: string
          description: Number for the grant, typically generated
        grantPrice:
          type: number
          description: Price at which the shares are granted
          format: double
        marketPriceAtTimeOfGrant:
          type: number
          description: The fair market value (or latest 409A valuation for private
            companies) at the time of grant (this is typically auto-populated from
            the most recent quote, but can also be specified if desired)
          format: double
        grantCurrency:
          type: string
          description: Currency for the grant price / market price at time of grant
          enum:
          - USD
          - CAD
          - GBP
          - EUR
          - JPY
          - AUD
          - KRW
          - DZD
          - AOA
          - ARS
          - AMD
          - AWG
          - BSD
          - BHD
          - BDT
          - BBD
          - BOB
          - BWP
          - BRL
          - BND
          - BGN
          - BZD
          - KYD
          - CLP
          - CNY
          - COP
          - CRC
          - HRK
          - CZK
          - DKK
          - DOP
          - XCD
          - EGP
          - ETB
          - FJD
          - XAF
          - GMD
          - GHS
          - GIP
          - GTQ
          - HNL
          - HKD
          - HUF
          - ISK
          - INR
          - IDR
          - IQD
          - ILS
          - JMD
          - JOD
          - KZT
          - KES
          - KWD
          - LSL
          - MOP
          - MWK
          - MYR
          - MUR
          - MXN
          - MAD
          - MZN
          - MMK
          - NAD
          - ANG
          - NZD
          - NGN
          - NOK
          - OMR
          - PKR
          - PAB
          - PGK
          - PYG
          - PEN
          - PHP
          - PLN
          - QAR
          - RON
          - RUB
          - SAR
          - RSD
          - SCR
          - SGD
          - ZAR
          - SDG
          - LKR
          - SZL
          - SEK
          - CHF
          - TWD
          - TZS
          - THB
          - TTD
          - TND
          - TRY
          - UGX
          - UAH
          - AED
          - UYU
          - UZS
          - VEF
          - VES
          - VND
          - XOF
          - ZWL
          - ZMW
        grantDate:
          type: string
          description: Date on which the shares are granted
          format: date
        expiryDate:
          type: string
          description: Expiry date for the grant
          format: date
        allowEarlyExercise:
          type: boolean
          description: Whether early exercises are allowed for the grant
        underRule701:
          type: boolean
          description: Whether rule 701 applies to the grant
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the grant, specified when
            using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowDetails'
        grantedShares:
          type: number
          description: Quantity of shares for the grant
          format: double
        cancelledShares:
          type: number
          description: Number of shares cancelled for the grant
          format: double
        exercisedShares:
          type: number
          description: Number of shares exercised for the grant
          format: double
        outstandingShares:
          type: number
          description: Number of shares outstanding for the grant
          format: double
        vestingAcceleration:
          type: array
          description: List of the vesting acceleration stipulations of the grant.
            May be empty.
          items:
            $ref: '#/components/schemas/StakeholderGrantAcceleratedVestingDetails'
      description: List of grants held by the stakeholder
    PlanSummaryDetailsWithGrants:
      title: Plan Summary Detailed Response
      required:
      - approved
      - governingLaw
      - grants
      - numberOfGrants
      - planApprovalDate
      - planId
      - planName
      - totalCancelledShares
      - totalExercisedShares
      - totalGrantedShares
      - totalOutstandingShares
      - totalRepurchasedShares
      - totalReservedShares
      - totalSharesRemainingForIssuance
      type: object
      properties:
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        planName:
          type: string
          description: Name for the company plan
        planApprovalDate:
          type: string
          description: Approval date for the plan
          format: date
        totalReservedShares:
          type: number
          description: Total number of shares reserved for the plan
          format: double
        totalGrantedShares:
          type: number
          description: Total number of shares granted to stakeholders under the plan
          format: double
        totalExercisedShares:
          type: number
          description: Total number of granted shares exercised by the stakeholders
          format: double
        totalRepurchasedShares:
          type: number
          description: Total number of exercised shares repurchased back
          format: double
        totalCancelledShares:
          type: number
          description: Total number of shares cancelled for the plan
          format: double
        totalOutstandingShares:
          type: number
          description: Total number of shares outstanding for the plan
          format: double
        totalSharesRemainingForIssuance:
          type: number
          description: Total number of shares for the plan that are remaining to be
            issued to stakeholders
          format: double
        numberOfGrants:
          type: integer
          description: The total number of grants issued under the plan
          format: int32
        governingLaw:
          type: string
          description: Governing law for the plan
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        approved:
          type: boolean
          description: Approval status of the plan
        grants:
          type: array
          description: List of all grants under the plan
          items:
            $ref: '#/components/schemas/StakeholderGrantSummaryDetails'
    StakeholderGrantAcceleratedVestingDetails:
      title: Accelerated Vesting Response
      required:
      - accelerationPercent
      - accelerationPeriod
      - accelerationTrigger
      type: object
      properties:
        accelerationTrigger:
          type: string
          description: 'The name of the event that will trigger vesting acceleration:
            TERMINATION_WITHOUT_CAUSE, RESIGNATION_FOR_GOOD_REASON, or CHANGE_OF_CONTROL'
        accelerationPeriod:
          type: integer
          description: The number of months after the trigger event that vesting acceleration
            will occur (0 to 60). A value > 0 defines a double-trigger acceleration
          format: int32
        accelerationPercent:
          type: integer
          description: The percent of the unvested shares that will be accelerated
            (1 to 100)
          format: int32
      description: List of the vesting acceleration stipulations of the grant. May
        be empty.
    CompanyBoardAppointmentUpdateCrudRequest:
      title: Company Board Appointment Body
      required:
      - dateAppointed
      - isDirector
      - isIndependent
      - isOfficer
      - title
      type: object
      properties:
        title:
          type: string
          description: Title of the stakeholder position on the board (e.g. CFO)
        isIndependent:
          type: boolean
          description: Whether the company board appointment is an independent
        isDirector:
          type: boolean
          description: Whether the company board appointment is a director
        isOfficer:
          type: boolean
          description: Whether the company board appointment is an officer
        dateAppointed:
          type: string
          description: Date of appointment for the company board appointment
          format: date
        dateApproved:
          type: string
          description: Date of approval for the company board appointment
          format: date
        dateTerminated:
          type: string
          description: Date of termination for the company board appointment
          format: date
        note:
          type: string
          description: Notes for the company board appointment
    DesignatedSharesSummaryDetails:
      title: Class Designated Share Summary Response
      required:
      - totalAvailableShares
      - totalCommonStockEquivalentShares
      - totalOutstandingShares
      type: object
      properties:
        totalAvailableShares:
          type: number
          description: Total available shares across the stock designations for the
            class
          format: double
        totalOutstandingShares:
          type: number
          description: Total outstanding shares across the stock designations for
            the class
          format: double
        totalCommonStockEquivalentShares:
          type: number
          description: Total common equivalent (a.k.a. fully diluted) shares across
            the stock designations for the class
          format: double
      description: Summary of all shares across the stock designations for the class
    AwardTypeDetails:
      title: Award Type Response
      required:
      - awardTypeId
      - awardTypeName
      type: object
      properties:
        awardTypeId:
          type: integer
          description: Identifier for the company award type
          format: int32
        awardTypeName:
          type: string
          description: Name for the company award type
    IndividualStakeholderDetails:
      title: Individual Stakeholder Response
      required:
      - lastName
      - stakeholderId
      type: object
      properties:
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        firstName:
          type: string
          description: First name for the stakeholder
        middleName:
          type: string
          description: Middle name for the stakeholder
        lastName:
          type: string
          description: Last name for the stakeholder
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
    WrappedCollectionManualVestingScheduleDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ManualVestingScheduleDetails'
    WrappedDataCompanyDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/CompanyDetails'
    StockCertificateSummaryDetails:
      title: Stock Certificate Summary Response
      required:
      - effectiveDate
      - issuePrice
      - issueReason
      - quantity
      - stakeholderId
      - stockCertificateId
      - stockCertificateNumber
      - stockDesignationId
      - stockDesignationName
      - unvestedQuantity
      - vestedQuantity
      type: object
      properties:
        stockCertificateId:
          type: integer
          description: Identifier for the stock certificate
          format: int32
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        stockDesignationId:
          type: integer
          description: Identifier for the stock designation
          format: int32
        stockDesignationName:
          type: string
          description: Name for the stock designation
        stockCertificateNumber:
          type: string
          description: Number for the stock certificate
        quantity:
          type: number
          description: Quantity of shares for the stock certificate
          format: double
        issuePrice:
          type: number
          description: Issue price (a.k.a. strike price) for the stock certificate
          format: double
        issueReason:
          type: string
          description: Issue reason for the stock certificate
          enum:
          - ORIGINAL_ISSUANCE
          - ORIGINAL_ISSUANCE_WITH_VESTING
          - OTHER
        effectiveDate:
          type: string
          description: Effective date for the stock certificate
          format: date
        boardApprovalDate:
          type: string
          description: Board approval date for the stock certificate (if not supplied,
            the certificate will be created with an unapproved status)
          format: date
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the stock certificate,
            specified when using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowDetails'
        vestedQuantity:
          type: number
          description: Quantity of the total shares which are vested
          format: double
        unvestedQuantity:
          type: number
          description: Quantity of the total shares which are yet unvested, and are
            only held as the result of an early exercise
          format: double
      description: List of stock certificates held by the stakeholder
    VestingScheduleDetails:
      title: Vesting Schedule Response
      required:
      - vestingBasis
      - vestingScheduleDescription
      - vestingScheduleId
      - vestingScheduleName
      - vestingScheduleRows
      - wholeUnitVesting
      type: object
      properties:
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingScheduleDescription:
          type: string
          description: Sentence(s) for describing the vesting schedule
        vestingBasis:
          type: string
          description: Basis type to specify how the vesting start date is determined
          enum:
          - GRANT_DATE
          - GRANT_VESTING_START_DATE
          - SPECIFIED_DATE
          - OTHER
        vestingBasisSpecifiedDate:
          type: string
          description: Date to be used as vesting start date for all grants/certificates
            using the schedule, only set when vestingBasis is SPECIFIED_DATE
          format: date
        vestingScheduleAllocationType:
          type: string
          description: Strategy for determination allocation of uneven tranches
          enum:
          - CUMULATIVE_ROUNDING
          - CUMUL_ROUND_V2
          - CUMULATIVE_ROUND_DOWN
          - FRONT_LOADED
          - FRONT_LOADED_TO_SINGLE_TRANCHE
          - BACK_LOADED
          - BACK_LOADED_TO_SINGLE_TRANCHE
          - OTHER
        wholeUnitVesting:
          type: boolean
          description: Whether fractional vesting tranches are disallowed (value 'true'
            indicates the allocation strategy will be used)
        vestingScheduleRows:
          type: array
          description: List of all rows/tranches for the vesting schedule
          items:
            $ref: '#/components/schemas/VestingScheduleRowDetails'
    StakeholderGrantAcceleratedVestingCrudRequest:
      title: Vesting Acceleration Body
      required:
      - accelerationPercent
      - accelerationPeriod
      - accelerationTrigger
      type: object
      properties:
        accelerationTrigger:
          type: string
          description: 'The name of the event that will trigger vesting acceleration:
            TERMINATION_WITHOUT_CAUSE, RESIGNATION_FOR_GOOD_REASON, or CHANGE_OF_CONTROL'
        accelerationPeriod:
          type: integer
          description: The number of months after the trigger event that vesting acceleration
            will occur (0 to 60). A value > 0 defines a double-trigger acceleration
          format: int32
        accelerationPercent:
          type: integer
          description: The percent of the unvested shares that will be accelerated
            (1 to 100)
          format: int32
      description: (Optional) List of the vesting acceleration stipulations of the
        grant. May be empty. Include one stipulation per trigger that is applicable.
    ClassOfSecuritiesDetails:
      title: Authorized Capital Class Detailed Response
      required:
      - classOfSecurities
      - stockDesignations
      - totalAuthorizedShares
      - totalCommonStockEquivalentShares
      - totalDesignatedShares
      - totalOutstandingShares
      type: object
      properties:
        classOfSecurities:
          type: string
          description: Whether the class is common or preferred stock
          enum:
          - COMMON
          - PREFERRED
          - COMMON_STOCK
          - PREFERRED_STOCK
        parValue:
          type: number
          description: Par value for the class of securities
          format: double
        totalAuthorizedShares:
          type: number
          description: Total number of authorized shares for the class of securities
          format: double
        totalDesignatedShares:
          type: number
          description: Total shares designated to one or more stock designations for
            the class
          format: double
        totalOutstandingShares:
          type: number
          description: Total outstanding shares from all stock designations for the
            class
          format: double
        totalCommonStockEquivalentShares:
          type: number
          description: Total fully diluted shares from all stock designations for
            the class
          format: double
        stockDesignations:
          type: array
          description: List of all stock designations for the class of securities
          items:
            $ref: '#/components/schemas/SecuritiesDesignationDetails'
    CompanyIntegrationDetails:
      title: Company Integration Response
      required:
      - companyName
      type: object
      properties:
        companyId:
          type: integer
          description: Identifier for the company
          format: int32
        companyName:
          type: string
          description: Name for the company
    WrappedCollectionStakeholderHoldingsSummaryDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          type: array
          items:
            $ref: '#/components/schemas/StakeholderHoldingsSummaryDetails'
    WrappedDataClassOfSecuritiesDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/ClassOfSecuritiesDetails'
    StockCertificateDetails:
      title: Stock Certificate Response
      required:
      - effectiveDate
      - issuePrice
      - issueReason
      - quantity
      - stakeholderId
      - stockCertificateId
      - stockCertificateNumber
      - stockDesignationId
      - stockDesignationName
      type: object
      properties:
        stockCertificateId:
          type: integer
          description: Identifier for the stock certificate
          format: int32
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        stockDesignationId:
          type: integer
          description: Identifier for the stock designation
          format: int32
        stockDesignationName:
          type: string
          description: Name for the stock designation
        stockCertificateNumber:
          type: string
          description: Number for the stock certificate
        quantity:
          type: number
          description: Quantity of shares for the stock certificate
          format: double
        issuePrice:
          type: number
          description: Issue price (a.k.a. strike price) for the stock certificate
          format: double
        issueReason:
          type: string
          description: Issue reason for the stock certificate
          enum:
          - ORIGINAL_ISSUANCE
          - ORIGINAL_ISSUANCE_WITH_VESTING
          - OTHER
        effectiveDate:
          type: string
          description: Effective date for the stock certificate
          format: date
        boardApprovalDate:
          type: string
          description: Board approval date for the stock certificate (if not supplied,
            the certificate will be created with an unapproved status)
          format: date
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the stock certificate,
            specified when using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowDetails'
    StakeholderGrantDetails:
      title: Grant Response
      required:
      - allowEarlyExercise
      - awardTypeId
      - awardTypeName
      - expiryDate
      - grantCurrency
      - grantDate
      - grantId
      - grantName
      - grantNumber
      - grantPrice
      - grantedShares
      - marketPriceAtTimeOfGrant
      - planId
      - stakeholderId
      - underRule701
      - vestingScheduleId
      - vestingScheduleName
      - vestingStartDate
      type: object
      properties:
        grantId:
          type: integer
          description: Identifier for the grant
          format: int32
        planId:
          type: integer
          description: Identifier for the company plan
          format: int32
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        awardTypeId:
          type: integer
          description: Identifier for the company award type
          format: int32
        awardTypeName:
          type: string
          description: Name for the company award type
        grantName:
          type: string
          description: Name for the grant, typically generated
        grantNumber:
          type: string
          description: Number for the grant, typically generated
        grantPrice:
          type: number
          description: Price at which the shares are granted
          format: double
        marketPriceAtTimeOfGrant:
          type: number
          description: The fair market value (or latest 409A valuation for private
            companies) at the time of grant (this is typically auto-populated from
            the most recent quote, but can also be specified if desired)
          format: double
        grantCurrency:
          type: string
          description: Currency for the grant price / market price at time of grant
          enum:
          - USD
          - CAD
          - GBP
          - EUR
          - JPY
          - AUD
          - KRW
          - DZD
          - AOA
          - ARS
          - AMD
          - AWG
          - BSD
          - BHD
          - BDT
          - BBD
          - BOB
          - BWP
          - BRL
          - BND
          - BGN
          - BZD
          - KYD
          - CLP
          - CNY
          - COP
          - CRC
          - HRK
          - CZK
          - DKK
          - DOP
          - XCD
          - EGP
          - ETB
          - FJD
          - XAF
          - GMD
          - GHS
          - GIP
          - GTQ
          - HNL
          - HKD
          - HUF
          - ISK
          - INR
          - IDR
          - IQD
          - ILS
          - JMD
          - JOD
          - KZT
          - KES
          - KWD
          - LSL
          - MOP
          - MWK
          - MYR
          - MUR
          - MXN
          - MAD
          - MZN
          - MMK
          - NAD
          - ANG
          - NZD
          - NGN
          - NOK
          - OMR
          - PKR
          - PAB
          - PGK
          - PYG
          - PEN
          - PHP
          - PLN
          - QAR
          - RON
          - RUB
          - SAR
          - RSD
          - SCR
          - SGD
          - ZAR
          - SDG
          - LKR
          - SZL
          - SEK
          - CHF
          - TWD
          - TZS
          - THB
          - TTD
          - TND
          - TRY
          - UGX
          - UAH
          - AED
          - UYU
          - UZS
          - VEF
          - VES
          - VND
          - XOF
          - ZWL
          - ZMW
        grantDate:
          type: string
          description: Date on which the shares are granted
          format: date
        expiryDate:
          type: string
          description: Expiry date for the grant
          format: date
        grantedShares:
          type: number
          description: Quantity of shares for the grant
          format: double
        allowEarlyExercise:
          type: boolean
          description: Whether early exercises are allowed for the grant
        underRule701:
          type: boolean
          description: Whether rule 701 applies to the grant
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the grant, specified when
            using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowDetails'
        vestingAcceleration:
          type: array
          description: List of the vesting acceleration stipulations of the grant.
            May be empty.
          items:
            $ref: '#/components/schemas/StakeholderGrantAcceleratedVestingDetails'
    AccessTokenRequest:
      title: Access Token Body
      required:
      - accessToken
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessToken'
    CompanyCrudRequest:
      title: Company Body
      required:
      - companyName
      type: object
      properties:
        companyName:
          type: string
          description: Name for the company
        phone:
          type: string
          description: Primary phone number for the company
        fiscalYearEnd:
          type: string
          description: Fiscal year end for the company
          format: date
        initialNumberOfAuthorizedShares:
          type: number
          description: Number of shares used when creating the initial stock filing
            during company setup (if not provided, placeholder quantity of zero is
            used)
          format: double
        numberOfSharesWithVestingAllocatedToFounders:
          type: number
          description: Number of shares from the initial authorized shares that are
            allocated to the default vesting plan
          format: double
        parValue:
          type: number
          description: Par value used when creating the initial stock filing during
            company setup (if not provided, default value of 0.001 is used)
          format: double
        stateOfIncorporation:
          type: string
          description: The state of incorporation for the company, if it is U.S.-based
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        dateOfIncorporation:
          type: string
          description: The date of incorporation for the company
          format: date
        entityType:
          type: string
          description: Entity type for the company (e.g. LLC)
          enum:
          - C_CORP
          - S_CORP
          - LLC
          - SOLE_PROPRIETORSHIP
          - PARTNERSHIP
          - UNINCORPORATED_GROUP
          - ASSOCIATION
          - UNKNOWN
        contacts:
          type: array
          description: List of all company contacts
          items:
            $ref: '#/components/schemas/CompanyContactCrudRequest'
        companyAddresses:
          type: array
          description: List of up to three company addresses
          items:
            $ref: '#/components/schemas/CompanyAddressCrudRequest'
        enforceOneToOneDesignationToFund:
          type: boolean
          description: Require unique Fund for each Designation
    StockCertificateCrudRequest:
      title: Stock Certificate Body
      required:
      - effectiveDate
      - issuePrice
      - quantity
      - stockCertificateNumber
      - stockDesignationId
      type: object
      properties:
        stockDesignationId:
          type: integer
          description: Identifier for the stock designation
          format: int32
        effectiveDate:
          type: string
          description: Effective date for the stock certificate
          format: date
        quantity:
          type: number
          description: Quantity of shares for the stock certificate
          format: double
        issuePrice:
          type: number
          description: Issue price (a.k.a. strike price) for the stock certificate
          format: double
        boardApprovalDate:
          type: string
          description: Board approval date for the stock certificate (if not supplied,
            the certificate will be created with an unapproved status)
          format: date
        stockCertificateNumber:
          type: string
          description: Number for the stock certificate
        vestingScheduleId:
          type: integer
          description: Identifier for the vesting schedule
          format: int32
        vestingStartDate:
          type: string
          description: Vesting base or commencement date for the vesting schedule
          format: date
        manualVestingRows:
          type: array
          description: List of all manual vesting rows for the stock certificate,
            specified when using a manual vesting schedule
          items:
            $ref: '#/components/schemas/ManualVestingRowCrudRequest'
    CompanyBoardDetails:
      title: Company Board Response
      required:
      - boardId
      - maximumSize
      - minimumSize
      - setAtSize
      type: object
      properties:
        boardId:
          type: integer
          description: Identifier for the company board
          format: int32
        minimumSize:
          type: integer
          description: Minimum number of stakeholders that must be on the board at
            one time
          format: int64
        maximumSize:
          type: integer
          description: Maximum number of stakeholders that may be on the board at
            one time
          format: int64
        setAtSize:
          type: integer
          description: The default, general, or target value at which the board is
            set and from which vacancies are relatively calculated
          format: int64
        quorumSize:
          type: integer
          description: Minimum amount of members required to be present to have a
            quorum
          format: int64
    WrappedCollectionAwardTypeDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AwardTypeDetails'
    StockFilingWithNewDesignationCreationRequest:
      title: Stock Filing Designation Body
      required:
      - classOfSecurities
      - convertible
      - filingDate
      - initialNumberOfAuthorizedShares
      - parValue
      - stockDesignationName
      type: object
      properties:
        filingDate:
          type: string
          description: Date on which the stock filing occurred
          format: date
        stockDesignationName:
          type: string
          description: Name for the stock designation
        classOfSecurities:
          type: string
          description: Whether the class is common or preferred stock
          enum:
          - COMMON
          - PREFERRED
          - COMMON_STOCK
          - PREFERRED_STOCK
        fundingRound:
          type: integer
          description: Funding round number for the stock designation
          format: int32
        initialNumberOfAuthorizedShares:
          type: number
          description: Total number of authorized shares for the stock designation
          format: double
        parValue:
          type: number
          description: Par value for the stock designation
          format: double
        pricePerShare:
          type: number
          description: Price per share for the stock designation
          format: double
        convertible:
          type: boolean
          description: Whether the stock designation is convertible
        convertsToStockDesignationId:
          type: integer
          description: Identifier for the stock designation which the stock designation
            converts to
          format: int32
        conversionRatioAntecedent:
          type: number
          description: The antecedent of the conversion ratio. E.g. 2 for a 2:1 conversion
            (2 converted shares for each original share)
          format: double
        conversionRatioConsequent:
          type: number
          description: The consequent of the conversion ratio. E.g. 1 for a 2:1 conversion
            (2 converted shares for each original share)
          format: double
        rounding:
          type: string
          description: Rounding type used when converting shares from the stock designation
          enum:
          - NORMAL
          - UP
          - DOWN
    CompanyBoardAppointmentCreateCrudRequest:
      title: Company Board Appointment Body
      required:
      - dateAppointed
      - isDirector
      - isIndependent
      - isOfficer
      - stakeholderId
      - title
      type: object
      properties:
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        title:
          type: string
          description: Title of the stakeholder position on the board (e.g. CFO)
        isIndependent:
          type: boolean
          description: Whether the company board appointment is an independent
        isDirector:
          type: boolean
          description: Whether the company board appointment is a director
        isOfficer:
          type: boolean
          description: Whether the company board appointment is an officer
        dateAppointed:
          type: string
          description: Date of appointment for the company board appointment
          format: date
        dateApproved:
          type: string
          description: Date of approval for the company board appointment
          format: date
        dateTerminated:
          type: string
          description: Date of termination for the company board appointment
          format: date
        note:
          type: string
          description: Notes for the company board appointment
    ManualVestingRowDetails:
      title: Manual Vesting Row Response
      required:
      - vestQuantity
      type: object
      properties:
        vestDate:
          type: string
          description: Date on which the vesting occurs for the row/tranche
          format: date
        vestQuantity:
          type: number
          description: Quantity of shares to vest for the row/tranche
          format: double
      description: List of all manual vesting rows for the grant, specified when using
        a manual vesting schedule
    WrappedCollectionFundDetails:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          type: array
          items:
            $ref: '#/components/schemas/FundDetails'
    ClassOfSecuritiesSummaryDetails:
      title: Class Summary Response
      required:
      - classOfSecurities
      - designationSummary
      - totalAuthorizedShares
      - totalAvailableToDesignate
      type: object
      properties:
        classOfSecurities:
          type: string
          description: Whether the class is common or preferred stock
          enum:
          - COMMON
          - PREFERRED
          - COMMON_STOCK
          - PREFERRED_STOCK
        parValue:
          type: number
          description: Par value for the class of securities
          format: double
        totalAuthorizedShares:
          type: number
          description: Total number of authorized shares for the class of securities
          format: double
        totalAvailableToDesignate:
          type: number
          description: Total shares remaining to designate to stock designations for
            the class
          format: double
        designationSummary:
          $ref: '#/components/schemas/DesignatedSharesSummaryDetails'
      description: List of summary information for all classes of securities for the
        company
    CompanyBoardAppointmentDetails:
      title: Company Board Appointment Response
      required:
      - appointmentId
      - dateAppointed
      - email
      - isDeleted
      - isDirector
      - isIndependent
      - isOfficer
      - name
      - stakeholderId
      - title
      type: object
      properties:
        appointmentId:
          type: integer
          description: Identifier for the company board appointment
          format: int32
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        name:
          type: string
          description: Formatted full name for the stakeholder
        email:
          type: string
          description: Personal email address for the stakeholder
        title:
          type: string
          description: Title of the stakeholder position on the board (e.g. CFO)
        isIndependent:
          type: boolean
          description: Whether the company board appointment is an independent
        isDirector:
          type: boolean
          description: Whether the company board appointment is a director
        isOfficer:
          type: boolean
          description: Whether the company board appointment is an officer
        isDeleted:
          type: boolean
          description: Whether the company board appointment has been removed
        dateAppointed:
          type: string
          description: Date of appointment for the company board appointment
          format: date
        dateApproved:
          type: string
          description: Date of approval for the company board appointment
          format: date
        dateTerminated:
          type: string
          description: Date of termination for the company board appointment
          format: date
        note:
          type: string
          description: Notes for the company board appointment
    SecuritiesDesignationDetails:
      title: Designation Summary Response
      required:
      - amountRaisedCurrency
      - dollarAmountRaised
      - numberOfCertificates
      - parValue
      - percentDiluted
      - percentOutstanding
      - percentOwnership
      - stockDesignationId
      - stockDesignationName
      - totalAuthorizedShares
      - totalAvailableShares
      - totalCommonStockEquivalentShares
      - totalOutstandingShares
      type: object
      properties:
        stockDesignationId:
          type: integer
          description: Identifier for the stock designation
          format: int32
        stockDesignationName:
          type: string
          description: Name for the stock designation
        numberOfCertificates:
          type: integer
          description: The number of certificates associated to a specific stock designation
          format: int32
        dollarAmountRaised:
          type: number
          description: The stock designation total dollar amount raised derived from
            the number of certificates issued multiplied by the price of each certificate.
          format: double
        amountRaisedCurrency:
          type: string
          description: The three letter currency code of the currency used in the
            calculation of the amount raised
        parValue:
          type: number
          description: Par value for the stock designation
          format: double
        pricePerShare:
          type: number
          description: Price per share for the stock designation
          format: double
        pricePerShareCurrency:
          type: string
          description: The three letter currency code of the price per share currency
        filingDate:
          type: string
          description: The date of the stock filing
          format: date
        conversionRatio:
          type: string
          description: When the stock designation is convertible, this ratio represents
            number of converted shares to each original share
        rounding:
          type: string
          description: Rounding type used when converting shares from the stock designation
          enum:
          - NORMAL
          - UP
          - DOWN
        convertsToStockDesignationName:
          type: string
          description: Name for the stock designation which the stock designation
            converts to
        convertsToStockDesignationId:
          type: integer
          description: Identifier for the stock designation which the stock designation
            converts to
          format: int32
        totalAuthorizedShares:
          type: number
          description: Total number of authorized shares for the stock designation
          format: double
        totalAvailableShares:
          type: number
          description: Total available shares across the stock designations for the
            class
          format: double
        totalOutstandingShares:
          type: number
          description: Total outstanding shares across the stock designations for
            the class
          format: double
        totalCommonStockEquivalentShares:
          type: number
          description: Total common equivalent (a.k.a. fully diluted) shares across
            the stock designations for the class
          format: double
        percentOwnership:
          type: number
          description: Percentage representing the fraction of total common equivalent
            (a.k.a. fully diluted) shares for the stock designation
          format: double
        percentDiluted:
          type: number
          description: Percentage representing the fraction of total common equivalent
            (a.k.a fully diluted) and available shares for the stock designation
          format: double
        percentOutstanding:
          type: number
          description: Percentage of fully diluted outstanding shares across all types
            of securities
          format: double
    StakeholderHoldingsSummaryDetails:
      title: Stakeholder Holdings Response
      required:
      - designationsParticipated
      - holdings
      - percentOwnershipTotalCommonStockEquivalent
      - percentOwnershipTotalOutstanding
      - stakeholderId
      - stakeholderName
      - totalCommonStockEquivalentShares
      - totalOutstandingShares
      type: object
      properties:
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        stakeholderName:
          type: string
          description: Formatted full name for the stakeholder
        totalOutstandingShares:
          type: number
          description: Total outstanding shares across all holdings for the stakeholder
          format: double
        totalCommonStockEquivalentShares:
          type: number
          description: Total common equivalent (a.k.a. fully diluted) shares across
            all holdings for the stakeholder
          format: double
        percentOwnershipTotalOutstanding:
          type: number
          description: Percentage representing the fraction of total outstanding shares
            across all holdings for the stakeholder
          format: double
        percentOwnershipTotalCommonStockEquivalent:
          type: number
          description: Percentage representing the fraction of total common equivalent
            (a.k.a. fully diluted) shares across all holdings for the stakeholder
          format: double
        designationsParticipated:
          type: array
          description: List of all the designations a stakeholder has participated
            in
          items:
            type: string
            description: List of all the designations a stakeholder has participated
              in
        holdings:
          $ref: '#/components/schemas/StakeholderHoldingsDetails'
    CompanyDetails:
      title: Company Response
      required:
      - companyName
      type: object
      properties:
        companyId:
          type: integer
          description: Identifier for the company
          format: int32
        companyName:
          type: string
          description: Name for the company
        enforceOneToOneDesignationToFund:
          type: boolean
          description: Require unique Fund for each Designation
        phone:
          type: string
          description: Primary phone number for the company
        fiscalYearEnd:
          type: string
          description: Fiscal year end for the company
          format: date
        stateOfIncorporation:
          type: string
          description: The state of incorporation for the company, if it is U.S.-based
          enum:
          - CA_AB
          - CA_BC
          - CA_MB
          - CA_NB
          - CA_NL
          - CA_NS
          - CA_NT
          - CA_NU
          - CA_ON
          - CA_PE
          - CA_QC
          - CA_SK
          - CA_YT
          - US_AK
          - US_AL
          - US_AR
          - US_AZ
          - US_CA
          - US_CO
          - US_CT
          - US_DC
          - US_DE
          - US_FL
          - US_GA
          - US_HI
          - US_IA
          - US_ID
          - US_IL
          - US_IN
          - US_KS
          - US_KY
          - US_LA
          - US_MA
          - US_MD
          - US_ME
          - US_MI
          - US_MN
          - US_MO
          - US_MS
          - US_MT
          - US_NC
          - US_ND
          - US_NE
          - US_NH
          - US_NJ
          - US_NM
          - US_NV
          - US_NY
          - US_OH
          - US_OK
          - US_OR
          - US_PA
          - US_RI
          - US_SC
          - US_SD
          - US_TN
          - US_TX
          - US_UT
          - US_VA
          - US_VT
          - US_WA
          - US_WI
          - US_WV
          - US_WY
          - US_AA
          - US_AE
          - US_AP
          - AS
          - GU
          - MP
          - PR
          - VI
          - AU_ACT
          - AU_NSW
          - AU_NT
          - AU_QLD
          - AU_SA
          - AU_TAS
          - AU_VIC
          - AU_WA
          - DE_BW
          - DE_BY
          - DE_BE
          - DE_BB
          - DE_HB
          - DE_HH
          - DE_HE
          - DE_MV
          - DE_NI
          - DE_NW
          - DE_RP
          - DE_SL
          - DE_SN
          - DE_ST
          - DE_SH
          - DE_TH
          - CH_ZH
          - CH_BE
          - CH_LU
          - CH_UR
          - CH_SZ
          - CH_OW
          - CH_NW
          - CH_GL
          - CH_ZG
          - CH_FR
          - CH_SO
          - CH_BS
          - CH_BL
          - CH_SH
          - CH_AR
          - CH_AI
          - CH_SG
          - CH_GR
          - CH_AG
          - CH_TG
          - CH_TI
          - CH_VD
          - CH_VS
          - CH_NE
          - CH_GE
          - CH_JU
          - IT_21
          - IT_23
          - IT_25
          - IT_32
          - IT_34
          - IT_36
          - IT_42
          - IT_45
          - IT_52
          - IT_55
          - IT_57
          - IT_62
          - IT_65
          - IT_67
          - IT_72
          - IT_75
          - IT_77
          - IT_78
          - IT_82
          - IT_88
        dateOfIncorporation:
          type: string
          description: The date of incorporation for the company
          format: date
        entityType:
          type: string
          description: Entity type for the company (e.g. LLC)
          enum:
          - C_CORP
          - S_CORP
          - LLC
          - SOLE_PROPRIETORSHIP
          - PARTNERSHIP
          - UNINCORPORATED_GROUP
          - ASSOCIATION
          - UNKNOWN
        companyAddresses:
          type: array
          description: List of up to three company addresses
          items:
            $ref: '#/components/schemas/CompanyAddressDetails'
        contacts:
          type: array
          description: List of all company contacts
          items:
            $ref: '#/components/schemas/CompanyContactDetails'
    VestingScheduleRowDetails:
      title: Vesting Schedule Row Response
      required:
      - amountDenominator
      - amountNumerator
      - vestingScheduleRowId
      type: object
      properties:
        vestingScheduleRowId:
          type: integer
          description: Identifier for the vesting row
          format: int32
        amountNumerator:
          type: integer
          description: Numerator of the vesting amount for the row/tranche
          format: int64
        amountDenominator:
          type: integer
          description: Denominator of the vesting amount for the row/tranche
          format: int64
        vestingPeriodLength:
          type: integer
          description: Number of periods between the row/tranche and the previous
            row/tranche (or vesting start date)
          format: int32
        vestingPeriodType:
          type: string
          description: Type of vesting period for the row/tranche
          enum:
          - YEAR
          - MONTH
          - WEEK
          - DAY
      description: List of all rows/tranches for the vesting schedule
    CompanyBoardCrudRequest:
      title: Company Board Body
      required:
      - maximumSize
      - minimumSize
      - setAtSize
      type: object
      properties:
        maximumSize:
          type: integer
          description: Maximum number of stakeholders that may be on the board at
            one time
          format: int64
        minimumSize:
          type: integer
          description: Minimum number of stakeholders that must be on the board at
            one time
          format: int64
        setAtSize:
          type: integer
          description: The default, general, or target value at which the board is
            set and from which vacancies are relatively calculated
          format: int64
        quorumSize:
          type: integer
          description: Minimum amount of members required to be present to have a
            quorum
          format: int64
    EntityStakeholderDetails:
      title: Entity Stakeholder Response
      required:
      - entityName
      - stakeholderId
      type: object
      properties:
        stakeholderId:
          type: integer
          description: Identifier for the stakeholder
          format: int32
        entityName:
          type: string
          description: Name for the entity stakeholder
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
    VestingScheduleCrudRequest:
      title: Vesting Schedule Body
      required:
      - vestingBasis
      - vestingScheduleDescription
      - vestingScheduleName
      - vestingScheduleRows
      - wholeUnitVesting
      type: object
      properties:
        vestingScheduleName:
          type: string
          description: Name for the vesting schedule
        vestingScheduleDescription:
          type: string
          description: Sentence(s) for describing the vesting schedule
        vestingBasis:
          type: string
          description: Basis type to specify how the vesting start date is determined
          enum:
          - GRANT_DATE
          - GRANT_VESTING_START_DATE
          - SPECIFIED_DATE
          - OTHER
        vestingBasisSpecifiedDate:
          type: string
          description: Date to be used as vesting start date for all grants/certificates
            using the schedule, only set when vestingBasis is SPECIFIED_DATE
          format: date
        vestingScheduleAllocationType:
          type: string
          description: Strategy for determination allocation of uneven tranches
          enum:
          - CUMULATIVE_ROUNDING
          - CUMUL_ROUND_V2
          - CUMULATIVE_ROUND_DOWN
          - FRONT_LOADED
          - FRONT_LOADED_TO_SINGLE_TRANCHE
          - BACK_LOADED
          - BACK_LOADED_TO_SINGLE_TRANCHE
          - OTHER
        wholeUnitVesting:
          type: boolean
          description: Whether fractional vesting tranches are disallowed (value 'true'
            indicates the allocation strategy will be used)
        vestingScheduleRows:
          type: array
          description: List of all rows/tranches for the vesting schedule
          items:
            $ref: '#/components/schemas/VestingScheduleRowRequest'
    IndividualStakeholderCrudRequest:
      title: Individual Stakeholder Body
      required:
      - firstName
      - lastName
      type: object
      properties:
        firstName:
          type: string
          description: First name for the stakeholder
        middleName:
          type: string
          description: Middle name for the stakeholder
        lastName:
          type: string
          description: Last name for the stakeholder
        stakeholderNumber:
          type: string
          description: Number for the stakeholder, typically generated
    WrappedDataPlanSummaryDetailsWithGrants:
      type: object
      properties:
        accessToken:
          $ref: '#/components/schemas/AccessTokenResponse'
        data:
          $ref: '#/components/schemas/PlanSummaryDetailsWithGrants'
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT