openapi: 3.1.0
info:
  version: '3.0'
  title: MeasureOne API
  termsOfService: https://www.measureone.com/terms-of-service
  description: >

    The MeasureOne API enables secure, consumer-permissioned data integration
    into your applications and workflows. Our platform facilitates the entire
    data-sharing process, from consent management to data delivery, while
    maintaining the highest standards of privacy and security.



    \

    At its core, our API streamlines the complex process of permissioned data
    sharing. When users grant consent to share their information, they either
    **upload their documents** or **provide credentials**  through the
    MeasureOne LINK widget to access their data sources. Our platform then
    securely connects to these sources, acquires the authorized data, and
    delivers it through standardized APIs. This process ensures both data
    integrity and user privacy, with built-in safeguards that enforce consent
    boundaries and prevent unauthorized access.


    \

    The platform offers comprehensive features including secure consent
    management, safe credential handling, automated data acquisition, and
    standardized delivery - all while guaranteeing data authenticity and
    tamper-proof delivery. By abstracting these complex workflows into
    straightforward APIs, we enable you to focus on your application while we
    handle the intricacies of secure data access and privacy compliance.
  contact:
    email: support@measureone.com
  x-logo:
    url: >-
      https://www.measureone.com/hubfs/assets/images/logos/measure-one-logo-on-light@2x.png
    backgroundColor: rgba(0,0,0,0)
    altText: MeasureOne logo
tags:
  - name: API Keys and Access
    description: >-
      MeasureOne authenticates your API requests using access tokens. If you do
      not include the `access_token` when making a request, MeasureOne returns
      an authentication error. 


      To gain access to the MeasureOne API, reach out to us on
      sales@measureone.com. Once you’ve completed the signup process, we’ll
      provide a live `client_id` & `secret` for use in our API.


      You can access our APIs using Access Tokens Or Public Tokens. The Public
      Tokens are short lived with limited scope while Access Tokens are long
      lived. 


      You can access our purge APIs using Purge Tokens. 


      ## Access Tokens

      Access Tokens are long-lived tokens that give you access to the MeasureOne
      infrastructure for your account. 


      **Access tokens should be used only from your own server side
      applications.**


      ## Purge Tokens

      Purge Tokens are long-lived credentials intended solely for accessing
      Compliance APIs. They cannot be used with any other API endpoints. A purge
      token is valid for a single use only and becomes invalid immediately after
      it has been used.


      **Purge Tokens should be used only from your own server side
      applications.**



      ## Public Tokens


      Public tokens are short-lived tokens with defined `scope` and `policy`. 

      The scope indicates the resources and endpoints you can access using these
      tokens while policy indicates the data you can access using the APIs.


      MeasureOne APIs will return a 401 error if the public token is used for
      scope or policy that is different from the token's scope and policy.


      **For example**, if you create a public token for policy having
      **individual_id** `idv_293241AAjy2EZt3R` and if you try to invoke
      /individuals/get_by_id for another individual, it will return a 401 error.


      The table below defines the currently supported scope.


      |API Endpoint|WIDGET|GLOBAL|ENTERPRISE_WIDGET

      |--- |--- |--- |--- |

      |/individuals/new|YES|YES|YES

      |/individuals/get_by_id  |YES|YES|YES

      |/individuals/get_items|YES|YES|NO

      |/datarequests/new|YES|YES|YES

      |/datarequests/update|YES|YES|YES

      |/datarequests/get|YES|YES|YES

      |/datarequests/get_by_id|YES|YES|YES

      |/datarequests/generate_invitation_link|YES|YES|YES

      |/datarequests/notify_user|YES|YES|YES

      |/datarequests/get_invitation_link|YES|YES|YES

      |/datarequests/expire_invitation_link|YES|YES|NO

      |/datarequests/refresh_now|YES|YES|NO

      |/datarequests/enable_refresh|YES|YES|NO

      |/datarequests/disable_refresh|YES|YES|NO

      |/datasources/get|YES|YES|YES

      |/items/new|YES|YES|YES

      |/items/upload|YES|YES|YES

      |/items/get_by_id|YES|YES|YES

      |/items/get_files|YES|YES|NO

      |/items/get_pdf|YES|YES|NO

      |/services/get_academic_summary|NO|YES|YES

      |/services/get_enrollment_status|NO|YES|YES

      |/services/gradscore|NO|YES|NO

      |/services/meritscore|NO|YES|NO

      |/services/get_digest_by_id|NO|YES|NO

      |/services/get_employment_summary|NO|YES|YES

      |/services/get_income_summary|NO|YES|YES

      |/services/get_income_employment_details|NO|YES|YES

      |/services/get_insurance_details|NO|YES|YES

      |/services/get_realized_gains|NO|YES|YES
  - name: Versioning
    description: >
      The current major version of the MeasureOne API is 3.0, and is passed in
      the API path as a `/v3` prefix.   The current 3.0 API version is
      `20210117` and is passed as a request header while calling the API. If no
      version number is specified in the request header, the API will default to
      the version that was live when you first signed up for MeasureOne API
      keys. 


      We periodically release changes to our APIs. While we try to remain
      backward compatible, changes in our API may result in changes to the data
      or schema structures exposed in the current version.
  - name: API Host and Protocols
    description: >-
      #### API protocols & headers 


      Unless specified otherwise, the MeasureOne API uses POST requests to
      communicate and HTTP [response codes](#status-codes) to indicate status
      and errors. Unless explicitly specified, all responses come in standard
      JSON, and all requests must include a Content-Type of `application/json`
      with a valid JSON body.


      |Header Parameters|Values|

      |--- |--- |

      |Authorization|bearer <YOUR_API_KEY>|

      |Content-Type|application/json|

      |version|




      #### Environments 

      MeasureOne provides two API environments:


      |Environment|URL|

      |--- |--- |

      |Staging|https://api-stg.measureone.com/v3/|

      |Production|https://api.measureone.com/v3/|   
  - name: Status Codes
    description: >
      #### 2xx Success


      A 2xx status code indicates the request was received and processed
      successfully.


      |Status code|Description|

      |--- |--- |

      |200|OK - The request is successful|

      |201|ACCEPTED - The request is successful and has been accepted for
      further processing. You will receive a    notification once the request
      has completed.|


      #### 4xx Client Errors


      A 4xx status code indicates that the request failed due to a client error.
      The response body generally includes more details about the failure.


      |Status code|Description|

      |--- |--- |

      |400|**Bad Request** - The request failed. This will usually occur when
      validations fail. E.g Missing required fields or invalid JSON|


      #### 5xx Server Errors


      A 5xx status codes is returned if something goes wrong on MeasureOne's end


      |Status code|Description|

      |--- |--- |

      |500|Internal Server Error - Something has gone wrong on MeasureOne's end
      while attempting to process the request. Our engineering team has been
      notified of the issue.|
  - name: Endpoints
    description: >

      This section gives you the list of all endpoints exposed by MeasureOne to
      integrate into your application workflow. For complete details, please see
      the full documentation. Unless specified otherwise, all the endpoints
      require `access_token` in the header for authorization. 


      |Resource|Endpoint|Description|

      |--- |--- |--- |

      |Authentication|/auth/generate_access_token|Generates an access token|

      |Authentication|/auth/generate_purge_token|Generates a purge token|

      |Authentication|/auth/invalidate|Invalidates an access token|

      |Authentication|/auth/generate_public_token|Generates a public token|

      |Individuals|/individuals/new|Create a new individual|

      |Individuals|/individuals/get_by_id|Get details of an Individual|        

      |Individuals|/individuals/get_items|Get list of items created for an
      Individual|

      |Data Requests|/datarequests/new|Create a new Data Request

      |Data Requests|/datarequests/update|Update Data Request

      |Data Requests|/datarequests/get|Get or search Data Requests

      |Data Requests|/datarequests/get_by_id|Get details of a Data Request

      |Data Requests|/datarequests/generate_invitation_link|Generate an
      invitation link for Data Request

      |Data Requests|/datarequests/notify_user|Send invitation to the user to
      complete the Data Request

      |Data Requests|/datarequests/get_invitation_link|Get details of an
      invitation link generated for the Data Request 

      |Data Requests|/datarequests/expire_invitation_link|Expire the invitation
      link for Data Request

      |Data Requests|/datarequests/refresh_now|Refresh data on demand for Data
      Requests

      |Data Requests|/datarequests/enable_refresh|Enable data refresh for Data
      Requests

      |Data Requests|/datarequests/disable_refresh|Disable data refresh for Data
      Requests

      |Data Sources|/datasources/get| Get or search Data Sources

      |Items|/items/new|Create a new item|

      |Items|/items/upload|Upload item document|

      |Items|/items/get_by_id|Upload item document|

      |Items|/items/get_files|Download the items uploaded via `/items/upload`
      API|

      |Items|/items/get_pdf|Download the items as PDF document|

      |Compliances|/compliances/purge_individual|Purge an Individual|

      |Services|/services/get_academic_summary|Get the academic summary for an
      Individual|

      |Services|/services/get_enrollment_status|Get the enrollment status for an
      Individual|

      |Services|/services/gradscore|Get the Gradscore for a transcript|

      |Services|/services/meritscore|Get the MeritScore for a transcript|

      |Services|/services/get_digest_by_id|Get the Digest for a transcript|

      |Services|/services/get_employment_summary|Get the employment summary for
      an Individual|

      |Services|/services/get_income_summary|Get the income summary for an
      Individual|

      |Services|/services/get_income_employment_details|Get the income
      employment details (VOIE) for an Individual|

      |Services|/services/get_insurance_details|Get the insurance details for an
      Individual|

      |Services|/services/get_realized_gains|Get the realized gains for a
      brokerage account|
  - name: AsynchronousCommunication
    x-displayName: Asynchronous Communication
    description: >-
      Many of MeasureOne APIs are asynchronous in nature. Client applications
      integrating MeasureOne API are required to expose endpoints for MeasureOne
      to send the [Webhook Notifications](#tag/webhooks).

      The diagram below depicts how the asynchronous communication will work. 
      APIs having Asynchronous communication may also send a synchronous
      response if the response is readily available.


      ![AsynchronousProcessing](/images/asynch_processing.png)


      The table below depicts the APIs that require clients to provision
      endpoints for asynchronous communication.


      |Resource|Endpoint|Asynchronous|

      |--- |--- |--- |

      |Authentication|/auth/generate_access_token|No|

      |Authentication|/auth/generate_purge_token|No|

      |Authentication|/auth/invalidate|No|

      |Authentication|/auth/generate_public_token|No|

      |Individuals|/individuals/new|No|

      |Individuals|/individuals/get_by_id|No|

      |Individuals|/individuals/get_items|No|

      |Data Requests|/datarequests/new|No|

      |Data Requests|/datarequests/update|No|

      |Data Requests|/datarequests/get|No|

      |Data Requests|/datarequests/get_by_id|No|

      |Data Requests|/datarequests/generate_invitation_link|No|

      |Data Requests|/datarequests/notify_user|No|

      |Data Requests|/datarequests/get_invitation_link|No|

      |Data Requests|/datarequests/expire_invitation_link|No|

      |Data Requests|/datarequests/refresh_now|No|

      |Data Requests|/datarequests/enable_refresh|No|

      |Data Requests|/datarequests/disable_refresh|No|

      |Data Sources|/datasources/get|No|

      |Items|/items/new|No|

      |Items|/items/upload|No|

      |Items|/items/get_by_id|Yes|

      |Items|/items/get_files|No|

      |Items|/items/get_pdf|No|

      |Compliances|/compliances/purge_individual|Yes|

      |Services|/services/get_academic_summary|Yes|

      |Services|/services/get_enrollment_status|Yes|

      |Services|/services/gradscore|Yes|

      |Services|/services/meritscore|Yes|

      |Services|/services/get_digest_by_id|Yes|

      |Services|/services/get_employment_summary|Yes|

      |Services|/services/get_income_summary|Yes|

      |Services|/services/get_income_employment_details|Yes|

      |Services|/services/get_insurance_details|Yes|

      |Services|/services/get_realized_gains|Yes|
  - name: CheckSignalsIntroduction
    x-displayName: Check Signals
    description: >
      Data integrity is of primary importance to MeasureOne and we employ many
      techniques to ensure it. Check signals are signals raised by a collection
      of checks that are applied to the information that flows through the
      MeasureOne platform. Check signals provide information that helps you
      detect potential anomalies in the data processing workflow that may
      indicate fraudulent information or activity in the workflow.


      Check signals checks are performed throughout the workflow with specific
      focus on Items, Connections & Services. The check signal checks can be
      broadly grouped into the following categories.   
         - **Connections**: Detect anomalies related to account connections.  
         - **Document Metadata**: Identify inconsistencies in document metadata.  
         - **Visual**: Flag formatting and visual discrepancies in documents.  
         - **Data**: Highlight inconsistencies in data.  

      We are continuously monitoring and updating the collection of checks to
      ensure the highest level of data integrity through our platform.


      The following is a list of all currently supported check signals raised,
      along with the conditions that cause them to be raised:
             
               
       
       ###### **Document Metadata Signals**
       | Signal Name           | Condition  | Comments|
       |----------------------|-------------|-------------------|
       | METADATA_MISMATCH  | Identifies anomalies in document metadata by comparing it against expected standards, detecting discrepancies or irregularities | Structured PDFs only |

       ###### **Visual Signals**
       | Signal Name          | Condition  | Comments|
       |---------------------|-------------|---------------|
       | FONT_MISMATCH     | Discrepancies in font usage, indicating possible text alterations | Structured PDFs only |       

       ###### **Data Signals**
       | Signal Name                           | Condition  | Comments|
       |-------------------------------------|-------------|----------------|
       | EMPLOYEE_ID_MISMATCH              | Inconsistencies in Employee ID extracted from documents data.|  |  
       | NAME_MISMATCH                     | Inconsistencies in name extracted from documents data. |  | 
       | SSN_MISMATCH                      | Inconsistencies in SSN extracted from documents data.|  |       
       | GROSS_PAY_CALC_MISMATCH           | Discrepancies in gross pay calculations |  |
       | NET_PAY_GREATER_THAN_GROSS        | When the net pay greater than gross pay, indicating a possible error or manipulation | |
       | W2_SOCIAL_SECURITY_WAGE_OVERLIMIT | When the reported Social Security wages exceeds the legal limit | |
       | W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD | When Social Security tax withholding amounts is incorrect | |
       | W2_INVALID_MEDICARE_TAX_WITHHELD     | When Medicare tax withholding amount is incorrect | |
       | W2_WAGES_GREATER_THAN_MEDICARE_WAGES     | When the reported wages exceeds the Medicare wages, indicating a possible error or manipulation | |

      To enable check signals for your account, reach out to us at
      support@measureone.com.
  - name: Individuals
    description: >-
      The Individual is a core resource that represents your user.   At the
      start of the workflow an Individual representing the user must be created.
      Retrieved Items are associated with the Individual.    Almost all Service
      APIs take the Individual ID as a reference.
  - name: Datasources
    x-displayName: Data Sources
    description: >
      Data Sources are online locations of Items.   Individuals (your users)
      connect Data Sources and provide MeasureOne with their credentials and
      consent so that MeasureOne may retrieve Items (their data) from the Data
      Source to be subsequently shared with you in a strictly permissioned
      way.    


      Data Sources may be universities, financial institutions, payroll systems,
      government records.    MeasureOne curates the list of Data Sources to
      ensure the provenance of the retrieved documents.   Since not all Data
      Sources may be relevant to your application, the API allows you to
      configure and select the list of Data Sources that are displayed to your
      user.
  - name: Items
    description: |2
       Items are the resource representing data shared by Individuals with MeasureOne.   The underlying document of an Item is called *source data*  These can be college transcripts, pay stubs, real estate titles, etc.   Items are stored and information from them can be retrieved through the Service API calls.   The information in an Item is shared through the Service APIs according to the consumer permission.   Importantly, note that unless permissioned by the Individual, the Item data may not be shared directly with you.
  - name: Document Processing Introduction
    x-displayName: Introduction
    description: >
      MeasureOne provides a robust document processing infrastructure for items
      acquired through consumer-permissions.  To process a document you need
      create an item using `/items/new` endpoint. Once an item is created, you
      can call the `/items/get_by_id` to get the digital version of the
      document. Below are the data types for each source data type supported by
      MeasureOne
  - name: ExperiencesV3
    x-displayName: Experiences
    description: >-
      Experiences stores the different resources required by the widget,
      hostedportal, etc.
  - name: ComplianceV3
    x-displayName: Compliances
    description: >-
      Compliance is a resource that represents endpoints required from a
      compliance perspective, such as purging an individual and their associated
      data.
  - name: Data Requests
    x-displayName: Data Requests
    description: >2-
       A consumer-permissioned data workflow is initiated and defined by the Data Request resource.   A Data Request specifies or bind together the various elements of a consumer-permissioned data workflow, in particular: the Individual, the set of actions - writing or acquiring data - to be performed, optional reports to be generated, the Link experience, optional schedule to auto-refresh data, optional Individual communication and messaging.   

      MeasureOne supports pre-configured types of data requests catering to
      different use cases, as well as  **CUSTOM** data requests that allow you
      to request custom data.   All services accept `datarequest_id` as a
      reference.  


      The following table specifies the supported Data Request types.   Based on
      the Data Request type, MeasureOne tailors the consumer-permissioned

      workflow to satisfy the indicated request for data.


      | Data Request Type |
      Description                                             | 

      |-------------------|---------------------------------------------------------

      | ACADEMIC_SUMMARY  | Request the education summary of the Individual

      | ENROLLMENT_STATUS | Request the enrollment status of the Individual

      | EMPLOYMENT_SUMMARY| Request the employment summary of the Individual

      | INCOME_SUMMARY    | Request the income summary for the Individual

      | INCOME_EMPLOYMENT_DETAILS | Request the VOIE details of the Individual

      | HOME_INSURANCE_DETAILS | Request the Home insurance details of the
      individuals

      | AUTO_INSURANCE_DETAILS | Request the Auto insurance details of the
      individuals

      | REALIZED_GAINS    | Request 1099-B information from the Individual's
      brokerage account

      | CUSTOM | Request custom data from an Individual that is not covered by
      the above types.
  - name: Invitations
    description: >2-
       <div class="alert alert-warning" role="alert">
      The Invitations resource is deprecated. Use
      <strong>/datarequests/</strong> resource to generate a link and
      /datarequests/notify_user to send the communication to the Individual


      </div>


      MeasureOne offers a framework for initiating the consumer-permissioned
      data exchange using automatically generated invitations.    These
      invitations contain unique links that refer the user back to the
      MeasureOne hosted portal in a personalized manner to initiate and complete
      the consumer-permissioned data exchange.     These API endpoints provide a
      programmatic interface to this framework.   Note that a zero code
      alternative to a programmatic implementation is to use the MeasureOne
      Customer Dashboard to interface with the Invitations framework.
  - name: webhooks
    x-displayName: Webhook Events
    description: >-
      MeasureOne uses webhooks to notify client applications of certain events.
      Whenever a notification event occurs we'll submit a POST to your
      designated webhook URL with information about the event. The webhook URL
      is configured as part of the onboarding process. You can also provide the
      webhook details while creating a Data Request
  - name: responding_to_webhooks
    x-displayName: Responding to Webhooks
    description: >-
      To acknowledge receipt of a webhook, your endpoint should return a 2xx
      HTTP status code. Any other information returned in the response headers
      or response body is ignored.
        
  - name: webhook_security
    x-displayName: Webhook Security
    description: >
      MeasureOne's webhook supports JWT and Basic method authorization.  The API
      key configured during the setup of the webhook in the customer onboarding
      process, will be present in the `Authorization` header.
  - name: migrationGuide
    x-displayName: Migrating to 3.0
    description: >+
      ## Overview

      Version 3.0 of the MeasureOne API introduced many new features and
      capabilities.   Unfortunately, it is not backward compatible with v2.0.  
      This guide will walk you through the backward incompatible changes that
      you need to be aware of while migrating to 3.0



      ### Endpoint Migration

      The changes in URL will be applicable if you are using the following
      endpoints


      |V2.0|V3.0|

      |----------|----------|

      | /individual/get_academic_summary |/services/get_academic_summary

      | /individual/get_enrollment_status |/services/get_enrollment_status

      | /transcripts/new |/items/new

      | /schools/get |/data_sources/get

      | /transcripts/new | /items/new

      | /transcripts/get_by_id | /items/get_by_id

      | /transcripts/get_files | /items/get_files

      | /analytics/meritscore | /services/meritscore

      | /analytics/gradscore | /services/gradscore



      ### Payload Changes

      This section depicts the changes you may have to do in your 

      #### Get Academic Summary


      `individual.data_source_id` has now changed to `individual.data_sources`.
      You can now pass multiple data_source_ids to get the academic_summary


      ```json


      {
          "individual": {
          "individual_id": "idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R",
          "data_sources": ["sch_CaIGVqBRRpETI6fkCyUSpNHbHFo", "sch_CaIGVqBRRpETI6fkCyUS233fbHFo"] // changes in 3.0
          }   
      }


      ```


      #### Get Enrollment Status


      `individual.data_source_id` has now changed to `individual.data_sources`.
      You can now pass multiple data_source_ids to get the academic_summary


      ```json


      {
          "individual": {
          "individual_id": "idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R",
          "data_sources": ["sch_CaIGVqBRRpETI6fkCyUSpNHbHFo", "sch_CaIGVqBRRpETI6fkCyUS233fbHFo"] // changes in 3.0
          }   
      }


      ```

      #### Creating a new item


      `source_data_type` has should now be at the top of the payload.


      ```json


      {
        "external_id": "ABCDECD",
        "individual_id": "idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R",
        "source_data_type": "M1_DIGEST", // changes in 3.0
        "source_data": [
          {
            "referrer": "USER",
            "source_data_value": {
              "degree_type": "BACHELORS",
              "years_in_school": 2,
              "min_grade": "D",
              "cgpa": 3.3,
              "last_term_gpa": 3.5,
              "credits_earned": 65
            }
          }
        ]
      }


      ```

      <br>


      ### Migrating to Data Requests

      A consumer-permissioned data workflow is initiated and defined by the Data
      Request resource. A Data Request specifies or binds together the various
      elements of a consumer-permissioned data workflow, in particular: the
      Individual, the type of data requested, the reports to be generated, the
      Link experience, optional Individual communication, and messaging.

      Migrating to Data Request is an important step required to leverage all
      the features of MeasureOne

      If you are using v3 of MeasureOne, and not using Data Requests, the
      following are the steps you should take.

      - After <a
      href="#tag/Individuals/paths/~1v3~1individuals~1new/post">creating the
      Individual</a>, create a new Data Request using this <a
      href="#tag/Data-Requests/paths/~1v3~1datarequests~1new/post">endpoint</a>

      - Once the Data Request is created, pass the `datarequest_id` in the <a
      href="#tag/Configuration">Link Configuration</a> in the Widget

      - Subscribe to webhooks - <a
      href="#tag/webhooks/paths/datarequest.updates_available/post">datarequest.updates_available</a>
      and <a
      href="#tag/webhooks/paths/datarequest.acquisition_complete/post">datarequest.acquisition_complete</a>
      to receive updates

      - On receiving the webhooks, you can now call our <a
      href="http://localhost:8080/#tag/Education/paths/~1v3~1services~1get_academic_summary/post">Service
      APIs</a> as you do in the existing integration.

      - You can also pass `datarequest_id` in the service call to get data
      pertaining to the data request.

  - name: M1_ACADEMIC_RECORD
    x-displayName: M1_ACADEMIC_RECORD
    description: >
      ---

      title: M1_ACADEMIC_RECORD 

      description: A standardized academic transcript format based on the EDI
      (Electronic Data Interchange) 130 standard. This schema represents a
      comprehensive student academic record/transcript that includes course
      information, grades, academic achievements, and other educational data
      exchanged between academic institutions.

      ---


      A standardized academic transcript format based on the EDI (Electronic
      Data Interchange) 130 standard. This schema represents a comprehensive
      student academic record/transcript that includes course information,
      grades, academic achievements, and other educational data exchanged
      between academic institutions. The format supports both high school and
      college/university transcripts.


      {% json-schema
              schema={
                 "summary": "M1_TRANSCRIPT SCHEMA",
          "description": "Represents an academic record of an Individual. In other words, M1_ACADEMIC_RECORD is an equivalent of a transcript comprising one or more degrees from the same educational institution. You can use the `items/get_by_id` endpoint to parse a transcript",
          "tags": [
            "M1_TRANSCRIPT"
          ],
          "type": "object",
          "properties": {
            "transcript_date": {
              "type": "string",
              "format": "MM/DD/YYYY",
              "description": "Date on which the transcript was issued. `transcript_date` should not be a future date"
            },
            "student_id": {
              "type": "string",
              "description": "Unique, school-provided Student ID"
            },
            "other_attributes": {
              "type": "object",
              "description": "Any other Attributes which are not defined in M1 TRANSCRIPT"
            },
            "student": {
              "type": "object",
              "description": "Object with information about the Individual, as provided on the transcript",
              "properties": {
                "first_name": {
                  "type": "string",
                  "description": "First name of the student"
                },
                "last_name": {
                  "type": "string",
                  "description": "Last name of the student"
                },
                "middle_name": {
                  "type": "string",
                  "description": "Middle name of the student"
                },
                "prefix": {
                  "type": "string",
                  "description": "Prefix to the name"
                },
                "suffix": {
                  "type": "string",
                  "description": "Suffix to the name"
                },
                "full_name": {
                  "type": "string",
                  "description": "Full name of the student"
                },
                "former_first_name": {
                  "type": "string",
                  "description": "Former first name"
                },
                "former_middle_name": {
                  "type": "string",
                  "description": "Former middle name"
                },
                "former_last_name": {
                  "type": "string",
                  "description": "Former last name"
                },
                "former_full_name": {
                  "type": "string",
                  "description": "Former full name"
                },
                "former_suffix": {
                  "type": "string",
                  "description": "Suffix to the former name"
                },
                "former_prefix": {
                  "type": "string",
                  "description": "Prefix to the former name"
                },
                "date_of_birth": {
                  "type": "string",
                  "description": "Birthdate of the student"
                },
                "ssn": {
                  "type": "string",
                  "description": "SSN of the student"
                },
                "email": {
                  "type": "string",
                  "description": "Email address of the student, as provided on the transcript"
                },
                "address": {
                  "type": "object",
                  "description": "Student's Address information as provided on the transcript",
                  "properties": {
                    "addr1": {
                      "type": "string",
                      "description": "Address line 1"
                    },
                    "addr2": {
                      "type": "string",
                      "description": "Address line 2. Should be populated only if `addr1` is populated"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "zipcode": {
                      "type": "string",
                      "description": "Zipcode for the address"
                    },
                    "country": {
                      "type": "object",
                      "description": "Country information",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the country"
                        },
                        "a2_code": {
                          "type": "string",
                          "description": "Alpha-2 code for the country from ISO 3166"
                        }
                      }
                    }
                  }
                }
              }
            },
            "pgc": {
              "type": "array",
              "description": "List of parent/guardian/counselor information on the transcript",
              "items": {
                "properties": {
                  "individual_type": {
                    "type": "string",
                    "description": "Type of Individual. Enum `PARENT_GUARDIAN`, `COUNSELOR`"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "First name of the Individual"
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Last name of the Individual"
                  },
                  "middle_name": {
                    "type": "string",
                    "description": "Middle name of the Individual"
                  },
                  "prefix": {
                    "type": "string",
                    "description": "Prefix to the name"
                  },
                  "suffix": {
                    "type": "string",
                    "description": "Suffix to the name"
                  },
                  "full_name": {
                    "type": "string",
                    "description": "Full name of the Individual"
                  },
                  "former_first_name": {
                    "type": "string",
                    "description": "Former first name"
                  },
                  "former_middle_name": {
                    "type": "string",
                    "description": "Former middle name"
                  },
                  "former_last_name": {
                    "type": "string",
                    "description": "Former last name"
                  },
                  "former_full_name": {
                    "type": "string",
                    "description": "Former full name"
                  },
                  "former_suffix": {
                    "type": "string",
                    "description": "Suffix to the former name"
                  },
                  "former_prefix": {
                    "type": "string",
                    "description": "Prefix to the former name"
                  },
                  "date_of_birth": {
                    "type": "string",
                    "description": "Birthdate of the Individual"
                  },
                  "ssn": {
                    "type": "string",
                    "description": "SSN of the Individual"
                  },
                  "email": {
                    "type": "string",
                    "description": "Email address of the Individual, as provided on the transcript"
                  },
                  "address": {
                    "type": "object",
                    "description": "Individual's Address information as provided on the transcript",
                    "properties": {
                      "addr1": {
                        "type": "string",
                        "description": "Address line 1"
                      },
                      "addr2": {
                        "type": "string",
                        "description": "Address line 2. Should be populated only if `addr1` is populated"
                      },
                      "city": {
                        "type": "string",
                        "description": "City"
                      },
                      "state": {
                        "type": "string",
                        "description": "State"
                      },
                      "zipcode": {
                        "type": "string",
                        "description": "Zipcode for the address"
                      },
                      "country": {
                        "type": "object",
                        "description": "Country information",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the country"
                          },
                          "a2_code": {
                            "type": "string",
                            "description": "Alpha-2 code for the country from ISO 3166"
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "immunizations": {
              "type": "array",
              "description": "List of immunization provided on the transcript",
              "items": {
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Code identifying the type of immunization"
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the immunization"
                  },
                  "date": {
                    "type": "string",
                    "description": "Immunization date"
                  },
                  "status_code": {
                    "type": "string",
                    "description": "Code identifying the status of immunization conducted on student"
                  },
                  "report_type_code": {
                    "type": "string",
                    "description": "Code identifying the record used to verify immunization of student"
                  }
                }
              }
            },
            "test_records": {
              "type": "array",
              "description": "List of national, regional, state, or local test records provided on the transcript",
              "items": {
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of the test"
                  },
                  "date": {
                    "type": "string",
                    "description": "Test date"
                  },
                  "code": {
                    "type": "string",
                    "description": "Code identifying the type of test"
                  },
                  "subsets": {
                    "type": "array",
                    "description": "List of subsets provided on the transcript",
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the subset"
                        },
                        "score": {
                          "type": "string",
                          "description": "Test score"
                        },
                        "score_qualifier": {
                          "type": "string",
                          "description": "Code indicating the manner in which the test score result is reported"
                        }
                      }
                    }
                  }
                }
              }
            },
            "previous_academic_record": {
              "type": "array",
              "description": "List of previous academic records provided on the transcript",
              "items": {
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of the institution"
                  },
                  "id_type": {
                    "type": "string",
                    "description": "ID Type of the institutionEnum `IPEDS`, `CEEB`"
                  },
                  "id": {
                    "type": "string",
                    "description": "Unique identifier of the institution"
                  },
                  "start_date": {
                    "type": "string",
                    "description": "Start date of the program"
                  },
                  "end_date": {
                    "type": "string",
                    "description": "End date of the program"
                  },
                  "address": {
                    "type": "object",
                    "description": "Student's Address information as provided for previous academic record",
                    "properties": {
                      "addr1": {
                        "type": "string",
                        "description": "Address line 1"
                      },
                      "addr2": {
                        "type": "string",
                        "description": "Address line 2. Should be populated only if `addr1` is populated"
                      },
                      "city": {
                        "type": "string",
                        "description": "City"
                      },
                      "state": {
                        "type": "string",
                        "description": "State"
                      },
                      "zipcode": {
                        "type": "string",
                        "description": "Zipcode for the address"
                      },
                      "country": {
                        "type": "object",
                        "description": "Country information",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the country"
                          },
                          "a2_code": {
                            "type": "string",
                            "description": "Alpha-2 code for the country from ISO 3166"
                          }
                        }
                      }
                    }
                  },
                  "degrees": {
                    "type": "array",
                    "description": "List of degrees found in this academic record",
                    "items": {
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "Level of the degree. Enum `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`"
                        },
                        "description": {
                          "type": "string",
                          "description": "Name of the degree"
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the degree. Enum `AWARDED`, `ENROLLED`, `WITHDRAWN`, `TERMINATED`, `UNKNOWN`"
                        },
                        "awarded_date": {
                          "type": "string",
                          "description": "Degree awarded date (applicable to graduates only)"
                        },
                        "years_of_study": {
                          "type": "number",
                          "description": "Number of years of study for the given degree"
                        },
                        "other_attributes": {
                          "type": "object"
                        },
                        "academic_summary": {
                          "type": "array",
                          "description": "Summary information about the degree",
                          "items": {
                            "properties": {
                              "credit_type": {
                                "type": "string",
                                "description": "Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`, `OTHER`"
                              },
                              "level": {
                                "type": "string",
                                "description": "The level of the academic summary. Enum `INSTITUTION`, `TRANSFER`, `TOTAL`"
                              },
                              "cumulative": {
                                "type": "boolean",
                                "description": "Boolean indicating whether the summary is cumulative"
                              },
                              "gpa_credits": {
                                "type": "number",
                                "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                              },
                              "attempted": {
                                "type": "number",
                                "description": "Credits attempted. Should be a non negative number, if available"
                              },
                              "earned": {
                                "type": "number",
                                "description": "Credits earned. Should be a non negative number, if available"
                              },
                              "gpa_range": {
                                "type": "object",
                                "description": "GPA range for School/University",
                                "properties": {
                                  "minimum": {
                                    "type": "number",
                                    "description": "minimum value for GPA"
                                  },
                                  "maximum": {
                                    "type": "number",
                                    "description": "maximum value for GPA"
                                  }
                                }
                              },
                              "gpa": {
                                "type": "number",
                                "description": "Grade Point Average. Should be a non negative number, if available"
                              },
                              "quality_points": {
                                "type": "number",
                                "description": "Quality points for grade, used in GPA calculation. Should be a non negative number, if available"
                              },
                              "student_rank": {
                                "type": "number",
                                "description": "Student rank"
                              },
                              "class_size": {
                                "type": "number",
                                "description": "Number of students in the class"
                              },
                              "rank_date": {
                                "type": "string",
                                "description": "Class rank date"
                              },
                              "days_attended": {
                                "type": "string",
                                "description": "Days student attended class"
                              },
                              "days_absent": {
                                "type": "string",
                                "description": "Days student absent in class"
                              }
                            }
                          }
                        },
                        "field_of_study": {
                          "type": "array",
                          "description": "List of objects with information about the field of study",
                          "items": {
                            "properties": {
                              "type": {
                                "type": "string",
                                "description": "Type of study. Enum `MAJOR`,`MINOR`,`CONCENTRATION`"
                              },
                              "description": {
                                "type": "string",
                                "description": "Name of the field of study"
                              },
                              "code_type": {
                                "type": "string",
                                "description": "Type of the code used for identifying the field of study E.g. CIP, HEGIS, OTHER"
                              },
                              "code": {
                                "type": "number",
                                "description": "Specifies the code for the field of study associated with the academic record."
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "transcript_institution": {
              "deprecated": true,
              "type": "object",
              "description": "Object with information about the institution for which the transcript was issued",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the institution"
                },
                "id_type": {
                  "type": "string",
                  "description": "Type of ID used to identify given institution Enum `IPEDS`,`CEEB`"
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the institute"
                },
                "address": {
                  "type": "object",
                  "description": "Student's Address information as provided for previous academic record",
                  "properties": {
                    "addr1": {
                      "type": "string",
                      "description": "Address line 1"
                    },
                    "addr2": {
                      "type": "string",
                      "description": "Address line 2. Should be populated only if `addr1` is populated"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "zipcode": {
                      "type": "string",
                      "description": "Zipcode for the address"
                    },
                    "country": {
                      "type": "object",
                      "description": "Country information",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the country"
                        },
                        "a2_code": {
                          "type": "string",
                          "description": "Alpha-2 code for the country from ISO 3166"
                        }
                      }
                    }
                  }
                },
                "other_attributes": {
                  "type": "object"
                }
              }
            },
            "teaching_institution": {
              "type": "object",
              "description": "Object with information about the teaching institution for which the transcript was issued",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the institution"
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the institute"
                },
                "id_type": {
                  "type": "string",
                  "description": "Type of ID used to identify given institution Enum `IPEDS`,`CEEB`"
                },
                "address": {
                  "type": "object",
                  "description": "Student's Address information as provided for previous academic record",
                  "properties": {
                    "addr1": {
                      "type": "string",
                      "description": "Address line 1"
                    },
                    "addr2": {
                      "type": "string",
                      "description": "Address line 2. Should be populated only if `addr1` is populated"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "zipcode": {
                      "type": "string",
                      "description": "Zipcode for the address"
                    },
                    "country": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the country"
                        },
                        "a2_code": {
                          "type": "string",
                          "description": "Alpha-2 code for the country from ISO 3166"
                        }
                      }
                    }
                  }
                }
              }
            },
            "degree_awarding_institution": {
              "type": "object",
              "description": "Object with information about the degree awarding institution for which the transcript was issued",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the institution"
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the institute"
                },
                "id_type": {
                  "type": "string",
                  "description": "Type of ID used to identify given institution Enum `IPEDS`,`CEEB`"
                },
                "address": {
                  "type": "object",
                  "description": "Student's Address information as provided for previous academic record",
                  "properties": {
                    "addr1": {
                      "type": "string",
                      "description": "Address line 1"
                    },
                    "addr2": {
                      "type": "string",
                      "description": "Address line 2. Should be populated only if `addr1` is populated"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "zipcode": {
                      "type": "string",
                      "description": "Zipcode for the address"
                    },
                    "country": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the country"
                        },
                        "a2_code": {
                          "type": "string",
                          "description": "Alpha-2 code for the country from ISO 3166"
                        }
                      }
                    }
                  }
                }
              }
            },
            "academic_summary": {
              "type": "array",
              "description": "Summary information about the degree",
              "items": {
                "properties": {
                  "credit_type": {
                    "type": "string",
                    "description": "Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`, `OTHER`"
                  },
                  "level": {
                    "type": "string",
                    "description": "The level of the academic summary. Enum `INSTITUTION`, `TRANSFER`, `TOTAL`"
                  },
                  "cumulative": {
                    "type": "boolean",
                    "description": "Boolean indicating whether the summary is cumulative"
                  },
                  "gpa_credits": {
                    "type": "number",
                    "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                  },
                  "attempted": {
                    "type": "number",
                    "description": "Credits attempted. Should be a non negative number, if available"
                  },
                  "earned": {
                    "type": "number",
                    "description": "Credits earned. Should be a non negative number, if available"
                  },
                  "gpa_range": {
                    "type": "object",
                    "description": "GPA scale for School/University",
                    "properties": {
                      "minimum": {
                        "type": "number",
                        "description": "minimum range for GPA"
                      },
                      "maximum": {
                        "type": "number",
                        "description": "maximum range for GPA"
                      }
                    }
                  },
                  "gpa": {
                    "type": "number",
                    "description": "Grade Point Average. Should be a non negative number, if available"
                  },
                  "quality_points": {
                    "type": "number",
                    "description": "Quality points for grade, used in GPA calculation. Should be a non negative number, if available"
                  },
                  "student_rank": {
                    "type": "number",
                    "description": "Student rank"
                  },
                  "class_size": {
                    "type": "number",
                    "description": "Number of students in the class"
                  },
                  "rank_date": {
                    "type": "string",
                    "description": "Class rank date"
                  },
                  "days_attended": {
                    "type": "string",
                    "description": "Days student attended class"
                  },
                  "days_absent": {
                    "type": "string",
                    "description": "Days student absent in class"
                  }
                }
              }
            },
            "academic_sessions": {
              "type": "array",
              "description": "List of academic sessions provided on the transcript",
              "items": {
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of session E.g. SEMESTER, TRIMESTER, QUARTER, FULL_YEAR, MINI_TERM, SUMMER_SESSION, UNKNOWN"
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the session E.g. Fall 2012"
                  },
                  "start_date": {
                    "type": "string",
                    "description": "Start Date of the session"
                  },
                  "end_date": {
                    "type": "string",
                    "description": "End Date of the session"
                  },
                  "in_progress": {
                    "type": "boolean",
                    "description": "Boolean indicating whether the session is in-progress at the time of transcript_date"
                  },
                  "level": {
                    "type": "string",
                    "description": "Grade Level or Academic Level of the Individual for the session"
                  },
                  "honors": {
                    "type": "array",
                    "description": "Academic honors or awards for the session E.g.  Cum Laude, Summa Cum Laude, Magna Cum Laude",
                    "items": {
                      "type": "string"
                    }
                  },
                  "curriculum_code_type": {
                    "type": "string",
                    "description": "Type of the code used for identifying curriculum E.g. CIP, HEGIS, OTHER"
                  },
                  "curriculum_code": {
                    "type": "string",
                    "description": "Code identifying the program in which the Individual is enrolled for this session"
                  },
                  "curriculum_name": {
                    "type": "string",
                    "description": "Name of the program in which the Individual is enrolled for this session"
                  },
                  "academic_summary": {
                    "type": "array",
                    "description": "Summary information about the degree",
                    "items": {
                      "properties": {
                        "credit_type": {
                          "type": "string",
                          "description": "Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`, `OTHER`"
                        },
                        "level": {
                          "type": "string",
                          "description": "The level of the academic summary. Enum `INSTITUTION`, `TRANSFER`, `TOTAL`"
                        },
                        "cumulative": {
                          "type": "boolean",
                          "description": "Boolean indicating whether the summary is cumulative"
                        },
                        "gpa_credits": {
                          "type": "number",
                          "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                        },
                        "attempted": {
                          "type": "number",
                          "description": "Credits attempted. Should be a non negative number, if available"
                        },
                        "earned": {
                          "type": "number",
                          "description": "Credits earned. Should be a non negative number, if available"
                        },
                        "gpa_range": {
                          "type": "object",
                          "description": "GPA range for School/University",
                          "properties": {
                            "minimum": {
                              "type": "number",
                              "description": "minimum value for GPA"
                            },
                            "maximum": {
                              "type": "number",
                              "description": "maximum value for GPA"
                            }
                          }
                        },
                        "gpa": {
                          "type": "number",
                          "description": "Grade Point Average. Should be a non negative number, if available"
                        },
                        "quality_points": {
                          "type": "number",
                          "description": "Quality points for grade, used in GPA calculation. Should be a non negative number, if available"
                        },
                        "student_rank": {
                          "type": "number",
                          "description": "Student rank"
                        },
                        "class_size": {
                          "type": "number",
                          "description": "Number of students in the class"
                        },
                        "rank_date": {
                          "type": "string",
                          "description": "Class rank date"
                        },
                        "days_attended": {
                          "type": "string",
                          "description": "Days student attended class"
                        },
                        "days_absent": {
                          "type": "string",
                          "description": "Days student absent in class"
                        }
                      }
                    }
                  },
                  "courses": {
                    "type": "array",
                    "description": "List of courses taken in this academic session. At least one of the academic sessions should have courses object",
                    "items": {
                      "properties": {
                        "credit_basis": {
                          "type": "string",
                          "description": "Indicates the method of credits earned for the course. Enum `REGULAR_ENROLLMENT` `TRANSFER` `ADVANCED_PLACEMENT`"
                        },
                        "honors_course": {
                          "type": "boolean",
                          "description": "Indicates if it is honors course or not"
                        },
                        "repeated": {
                          "type": "boolean",
                          "description": "If the course was repeated by the Individual"
                        },
                        "count_in_gpa": {
                          "type": "boolean",
                          "description": "If the course performance is counted in gpa calculation or not"
                        },
                        "code_type": {
                          "type": "string",
                          "description": "Code designating the system/method of code structure used for Identification Code used to describe the content of the course. Enum `CIP`, `HEGIS`, `OTHER`, `UNKNOWN`"
                        },
                        "code": {
                          "type": "string",
                          "description": "Course code information as presented on the transcript"
                        },
                        "id": {
                          "type": "string",
                          "description": "Course ID as presented on the transcript"
                        },
                        "name": {
                          "type": "string",
                          "description": "Free-form name to describe the content of the course"
                        },
                        "instructional_setting": {
                          "type": "string",
                          "description": "Type of instructional setting in which a program is provided"
                        },
                        "start_date": {
                          "type": "string",
                          "description": "Course start date"
                        },
                        "end_date": {
                          "type": "string",
                          "description": "Course end date"
                        },
                        "other_attributes": {
                          "type": "object"
                        },
                        "credits": {
                          "type": "object",
                          "description": "Object with information related to credits for the course",
                          "properties": {
                            "credit_type": {
                              "type": "string",
                              "description": "Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`, `OTHER`. For a valid credits object, credit_type is mandatory"
                            },
                            "gpa_credits": {
                              "type": "number",
                              "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                            },
                            "attempted": {
                              "type": "number",
                              "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                            },
                            "earned": {
                              "type": "number",
                              "description": "Credits earned. Should be a non negative number, if available"
                            },
                            "quality_points": {
                              "type": "number",
                              "description": "Quality points for grade, used in GPA calculation. Should be a non negative number, if available"
                            },
                            "grade_qualifier": {
                              "type": "string",
                              "description": "The grading scale used by an academic institution for the course."
                            },
                            "grade": {
                              "type": "string",
                              "description": "Indicates the grade that an Individual received for participation in the course."
                            }
                          }
                        },
                        "marks_awarded": {
                          "type": "array",
                          "description": "Indicates the series of marks that an Individual received for participation in the course.",
                          "items": {
                            "properties": {
                              "grade": {
                                "type": "string",
                                "description": "Indicates the grade that an Individual received for participation in the course."
                              },
                              "grade_qualifier": {
                                "type": "string",
                                "description": "The grading scale used by an academic institution for the course."
                              },
                              "period": {
                                "type": "string",
                                "description": "Indicates the period for which mark awarded"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "degrees": {
                    "type": "array",
                    "description": "List of degrees found in this academic record",
                    "items": {
                      "properties": {
                        "description": {
                          "type": "string",
                          "description": "Name of the degree"
                        },
                        "type": {
                          "type": "string",
                          "description": "Level of the degree. Enum  `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`"
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the degree. Enum `AWARDED`, `ENROLLED`, `WITHDRAWN`, `TERMINATED`, `UNKNOWN`"
                        },
                        "awarded_date": {
                          "type": "string",
                          "description": "Degree awarded date (applicable to graduates only)"
                        },
                        "years_of_study": {
                          "type": "number",
                          "description": "Number of years of study for the given degree"
                        },
                        "other_attributes": {
                          "type": "object"
                        },
                        "academic_summary": {
                          "type": "array",
                          "description": "Summary information about the degree",
                          "items": {
                            "properties": {
                              "credit_type": {
                                "type": "string",
                                "description": "Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`, `OTHER`"
                              },
                              "level": {
                                "type": "string",
                                "description": "The level of the academic summary. Enum `INSTITUTION`, `TRANSFER`, `TOTAL`"
                              },
                              "cumulative": {
                                "type": "boolean",
                                "description": "Boolean indicating whether the summary is cumulative"
                              },
                              "gpa_credits": {
                                "type": "number",
                                "description": "Credits attempted on courses that are included in the GPA calculation. Should be a non negative number, if available"
                              },
                              "attempted": {
                                "type": "number",
                                "description": "Credits attempted. Should be a non negative number, if available"
                              },
                              "earned": {
                                "type": "number",
                                "description": "Credits earned. Should be a non negative number, if available"
                              },
                              "gpa_range": {
                                "type": "object",
                                "description": "GPA range for School/University",
                                "properties": {
                                  "minimum": {
                                    "type": "number",
                                    "description": "minimum value for GPA"
                                  },
                                  "maximum": {
                                    "type": "number",
                                    "description": "maximum value for GPA"
                                  }
                                }
                              },
                              "gpa": {
                                "type": "number",
                                "description": "Grade Point Average. Should be a non negative number, if available"
                              },
                              "quality_points": {
                                "type": "number",
                                "description": "Quality points for grade, used in GPA calculation. Should be a non negative number, if available"
                              },
                              "student_rank": {
                                "type": "number",
                                "description": "Student rank"
                              },
                              "class_size": {
                                "type": "number",
                                "description": "Number of students in the class"
                              },
                              "rank_date": {
                                "type": "string",
                                "description": "Class rank date"
                              },
                              "days_attended": {
                                "type": "string",
                                "description": "Days student attended class"
                              },
                              "days_absent": {
                                "type": "string",
                                "description": "Days student absent in class"
                              }
                            }
                          }
                        },
                        "field_of_study": {
                          "type": "array",
                          "description": "List of objects with information about the field of study",
                          "items": {
                            "properties": {
                              "type": {
                                "type": "string",
                                "description": "Type of study. Enum `MAJOR`,`MINOR`,`CONCENTRATION`"
                              },
                              "description": {
                                "type": "string",
                                "description": "Name of the field of study"
                              },
                              "code_type": {
                                "type": "string",
                                "description": "Type of the code used for identifying the field of study E.g. CIP, HEGIS, OTHER"
                              },
                              "code": {
                                "type": "string",
                                "description": "Specifies the code for the field of study associated with the academic record."
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "other_attributes": {
                    "type": "object"
                  }
                }
              }
            }
          }
              }
      /%}
  - name: M1_DIGEST
    x-displayName: M1_DIGEST
    description: >
      ---

      title: M1_DIGEST

      description: A standardized academic transcript format based on the EDI
      (Electronic Data Interchange) 130 standard. This schema represents a
      comprehensive student academic record/transcript that includes course
      information, grades, academic achievements, and other educational data
      exchanged between academic institutions.

      ---

      A summary object computed based on the academic record of the student.

      {% json-schema
              schema={
                    "title": "M1_DIGEST Schema",
                    "type": "object",
                    "required": [
                      "degree_type",
                      "years_in_school",
                      "min_grade",
                      "cgpa",
                      "last_term_gpa",
                      "credits_earned"
                    ],
                    "properties": {
                      "degree_type": {
                        "type": "string",
                        "description": "Granular level of study. Enum `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`, `UNDERGRADUATE`"
                      },
                      "years_in_school": {
                        "type": "number",
                        "format": "double",
                        "description": "Number of years that the Individual has been enrolled, including any breaks between enrollments. Non-zero, non-negative, rounded to two decimals"
                      },
                      "min_grade": {
                        "type": "string",
                        "description": "Lowest grade earned on a course taken"
                      },
                      "cgpa": {
                        "type": "number",
                        "format": "double",
                        "description": "Weighted CGPA, in the 0 to 4 scale, for the combination of courses attended at the transcript-issuing school"
                      },
                      "last_term_gpa": {
                        "type": "number",
                        "format": "double",
                        "description": "GPA, in the 0 to 4 scale, for the last term of attendance"
                      },
                      "credits_earned": {
                        "type": "number",
                        "format": "double",
                        "description": "Total credits earned including transferred credits, converted to a standard semester credit hour system"
                      }
                    },
                    "example": {
                      "degree_type": "BACHELORS",
                      "years_in_school": 4,
                      "min_grade": "D",
                      "cgpa": 3,
                      "last_term_gpa": 2,
                      "credits_earned": 65
                    },
                    "$schema": "http://json-schema.org/draft-07/schema#"
                  }
      /%}
  - name: M1_INCOME_EMPLOYMENT_RECORD
    x-displayName: M1_INCOME_EMPLOYMENT_RECORD
    description: >
      ---

      title: M1_INCOME_EMPLOYMENT_RECORD 

      description: This schema represents a comprehensive record of an
      individual's income sources, employment details, and financial status. It
      includes information such as employer details, job title, salary,
      employment type, and work history. 

      ---

      This schema represents a comprehensive record of an individual's income
      sources, employment details, and financial status. It includes information
      such as employer details, job title, salary, employment type, and work
      history. 


      {% json-schema
              schema={
          "title": "M1_INCOME_EMPLOYMENT_RECORD Schema",
          "type": "object",
          "description": "Representation of the Income Employment record for an individual\n",
          "properties": {
              "record_date": {
                  "type": "string",
                  "description": "Date on which the record was generated",
                  "format": "MM/DD/YYYY"
              },
              "pay_date": {
                  "type": "string",
                  "description": "Payment date",
                  "format": "MM/DD/YYYY"
              },
              "interval": {
                  "type": "object",
                  "description": "Interval for which the income employment details is denoted",
                  "properties": {
                      "start_date": {
                          "type": "string",
                          "description": "start date of the interval",
                          "format": "MM/DD/YYYY"
                      },
                      "end_date": {
                          "type": "string",
                          "description": "end date of the interval",
                          "format": "MM/DD/YYYY"
                      }
                  }
              },
              "employee": {
                  "type": "object",
                  "description": "Details about the employee",
                  "properties": {
                      "service_details": {
                          "type": "object",
                          "description": "Service details of the employee",
                          "properties": {
                              "employee_id": {
                                  "type": "string",
                                  "description": "employee_id provided by the employer"
                              },
                              "hire_date": {
                                  "type": "string",
                                  "description": "Hire date of the employee",
                                  "format": "MM/DD/YYYY"
                              },
                              "status": {
                                  "type": "string",
                                  "description": "Status of employee with the employer",
                                  "enum": [
                                      "ACTIVE",
                                      "INACTIVE",
                                      "TERMINATED",
                                      "UNKNOWN"
                                  ]
                              },
                              "salary": {
                                  "type": "number",
                                  "description": "Salary of the employee"
                              },
                              "salary_basis": {
                                  "type": "string",
                                  "description": "Basis of salary",
                                  "enum": [
                                      "HOURLY",
                                      "MONTHLY",
                                      "SEMI_MONTHLY",
                                      "WEEKLY",
                                      "BI_WEEKLY",
                                      "ANNUAL",
                                      "OTHER"
                                  ]
                              },
                              "termination_date": {
                                  "type": "string",
                                  "description": "Termination date of the employee",
                                  "format": "MM/DD/YYYY"
                              },
                              "termination_reason": {
                                  "type": "string",
                                  "description": "Termination reason"
                              }
                          }
                      },
                      "first_name": {
                          "type": "string",
                          "description": "First name of the employee",
                          "maxLength": 45
                      },
                      "middle_name": {
                          "type": "string",
                          "description": "Middle name of the employee",
                          "maxLength": 45
                      },
                      "last_name": {
                          "type": "string",
                          "description": "Last Name of the employee",
                          "maxLength": 45
                      },
                      "email": {
                          "type": "string",
                          "description": "Email address of the employee"
                      },
                      "prefix": {
                          "type": "string",
                          "description": "Name prefix",
                          "maxLength": 5
                      },
                      "suffix": {
                          "type": "string",
                          "description": "Name suffix",
                          "maxLength": 5
                      },
                      "gender": {
                          "type": "string",
                          "description": "Gender of the employee",
                          "maxLength": 1
                      },
                      "date_of_birth": {
                          "type": "string",
                          "description": "Date of Birth of the employee in MM/DD/YYYY format.",
                          "format": "MM/DD/YYYY",
                          "pattern": "/(0[1-9]|1[012])[- \\/.](0[1-9]|[12][0-9]|3[01])[- \\/.](19|20)\\d\\d/'"
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the employee"
                      },
                      "ssn": {
                          "type": "string",
                          "description": "SSN of the employee"
                      },
                      "address": {
                          "type": "object",
                          "description": "Address of the employee",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode for the address"
                              },
                              "country": {
                                  "type": "object",
                                  "description": "Country information",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code for the country"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "employer": {
                  "type": "object",
                  "description": "Details about the employer",
                  "properties": {
                      "name": {
                          "type": "string",
                          "description": "Name of the employer"
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the employer"
                      },
                      "address": {
                          "type": "object",
                          "description": "Address of the employer",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode for the address"
                              },
                              "country": {
                                  "type": "object",
                                  "description": "Country information",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code for the country"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "roles": {
                  "type": "array",
                  "description": "Array of objects representing roles of an Individual during their employment",
                  "items": {
                      "properties": {
                          "position": {
                              "type": "object",
                              "description": "Position details of an Individual",
                              "properties": {
                                  "name": {
                                      "type": "string",
                                      "description": "Name of the position"
                                  },
                                  "title": {
                                      "type": "string",
                                      "description": "Title of the position"
                                  }
                              }
                          },
                          "type": {
                              "type": "string",
                              "description": "Type of position",
                              "enum": [
                                  "FULL_TIME",
                                  "PART_TIME",
                                  "CONTRACT",
                                  "OTHER"
                              ]
                          },
                          "supervisor": {
                              "type": "string",
                              "description": "Name of supervisor"
                          },
                          "interval": {
                              "type": "object",
                              "description": "Interval details for the role",
                              "properties": {
                                  "start_date": {
                                      "type": "string",
                                      "description": "start date of the interval",
                                      "format": "MM/DD/YYYY"
                                  },
                                  "end_date": {
                                      "type": "string",
                                      "description": "end date of the interval",
                                      "format": "MM/DD/YYYY"
                                  }
                              }
                          },
                          "location": {
                              "type": "object",
                              "description": "Location details for the role",
                              "properties": {
                                  "name": {
                                      "type": "string",
                                      "description": "Name of location"
                                  },
                                  "address": {
                                      "type": "object",
                                      "description": "Address of the location",
                                      "properties": {
                                          "addr1": {
                                              "type": "string",
                                              "description": "Address Line 1"
                                          },
                                          "addr2": {
                                              "type": "string",
                                              "description": "Address Line 2"
                                          },
                                          "city": {
                                              "type": "string",
                                              "description": "City"
                                          },
                                          "state": {
                                              "type": "string",
                                              "description": "State"
                                          },
                                          "zipcode": {
                                              "type": "string",
                                              "description": "Zipcode for the address"
                                          },
                                          "country": {
                                              "type": "object",
                                              "description": "Country information",
                                              "properties": {
                                                  "name": {
                                                      "type": "string",
                                                      "description": "Name of the country"
                                                  },
                                                  "a2_code": {
                                                      "type": "string",
                                                      "description": "Alpha-2 code for the country"
                                                  }
                                              }
                                          }
                                      }
                                  },
                                  "department": {
                                      "type": "string",
                                      "description": "Department during the deployment"
                                  }
                              }
                          }
                      }
                  }
              },
              "earnings": {
                  "type": "array",
                  "description": "Array of objects representing earnings",
                  "items": {
                      "properties": {
                          "type": {
                              "type": "string",
                              "description": "Type of the earnings",
                              "enum": [
                                  "SALARY",
                                  "WAGE",
                                  "INVESTMENT",
                                  "RENTAL",
                                  "COMMISSION",
                                  "INTEREST",
                                  "GIFTS",
                                  "ALLOWANCE",
                                  "GOVERNMENT_PAYMENT",
                                  "DIVIDENDS",
                                  "RETIREMENT_PENSION",
                                  "TAX_REFUND",
                                  "UNEMPLOYMENT",
                                  "TRANSFER_IN",
                                  "OTHER_DEPOSITS",
                                  "OTHER"
                              ]
                          },
                          "basis": {
                              "type": "string",
                              "description": "Basis unit of the payment",
                              "enum": [
                                  "HOURLY",
                                  "MONTHLY",
                                  "SEMI_MONTHLY",
                                  "WEEKLY",
                                  "ANNUAL",
                                  "BI_WEEKLY",
                                  "OTHER"
                              ]
                          },
                          "interval": {
                              "type": "object",
                              "description": "Interval for which the earnings is denoted",
                              "properties": {
                                  "start_date": {
                                      "type": "string",
                                      "description": "start date of the interval",
                                      "format": "MM/DD/YYYY"
                                  },
                                  "end_date": {
                                      "type": "string",
                                      "description": "end date of the interval",
                                      "format": "MM/DD/YYYY"
                                  }
                              }
                          },
                          "amounts": {
                              "type": "array",
                              "description": "Array of objects representing earning amounts",
                              "items": {
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "description": "Currency of the payment",
                                          "enum": [
                                              "USD",
                                              "OTHER"
                                          ]
                                      },
                                      "type": {
                                          "type": "string",
                                          "description": "Type of earning",
                                          "enum": [
                                              "GROSS",
                                              "NET",
                                              "REGULAR",
                                              "OVERTIME",
                                              "BONUS",
                                              "COMMISSION",
                                              "OTHER"
                                          ]
                                      },
                                      "ytd_flag": {
                                          "type": "boolean",
                                          "description": "Indicates if the amount given is year to date"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Value of earning amount"
                                      },
                                      "description": {
                                          "type": "string",
                                          "description": "Description of amount"
                                      },
                                      "rate": {
                                          "type": "number",
                                          "description": "Pay rate of the employee"
                                      },
                                      "hours": {
                                          "type": "string",
                                          "description": "Number of hours worked"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "deductions": {
                  "type": "array",
                  "description": "Deductions of the employee",
                  "items": {
                      "properties": {
                          "type": {
                              "type": "string",
                              "description": "Type of deduction",
                              "enum": [
                                  "OTHER"
                              ]
                          },
                          "interval": {
                              "type": "object",
                              "description": "Interval for which the deduction is denoted",
                              "properties": {
                                  "start_date": {
                                      "type": "string",
                                      "description": "start date of the interval",
                                      "format": "MM/DD/YYYY"
                                  },
                                  "end_date": {
                                      "type": "string",
                                      "description": "end date of the interval",
                                      "format": "MM/DD/YYYY"
                                  }
                              }
                          },
                          "amounts": {
                              "type": "array",
                              "description": "Array of objects representing deduction amounts",
                              "items": {
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "description": "Currency of the deduction",
                                          "enum": [
                                              "USD",
                                              "OTHER"
                                          ]
                                      },
                                      "type": {
                                          "type": "string",
                                          "description": "Type of deduction",
                                          "enum": [
                                              "OTHER"
                                          ]
                                      },
                                      "ytd_flag": {
                                          "type": "boolean",
                                          "description": "Indicates if the amount given is year to date"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Value of deduction amount"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "deposits": {
                  "type": "array",
                  "description": "Employee Deposits",
                  "items": {
                      "type": "object",
                      "properties": {
                          "method": {
                              "type": "string",
                              "description": "Type of Deposit",
                              "enum": [
                                  "DIRECT_DEPOSIT",
                                  "OTHER"
                              ]
                          },
                          "account_name": {
                              "type": "string",
                              "description": "Name of account"
                          },
                          "account_number": {
                              "type": "string",
                              "description": "Bank account number"
                          },
                          "transit_number": {
                              "type": "string",
                              "description": "Transit number of the bank"
                          },
                          "account_type": {
                              "type": "string",
                              "description": "Type of account",
                              "enum": [
                                  "CHECKING",
                                  "SAVING",
                                  "OTHER"
                              ]
                          },
                          "amount": {
                              "type": "object",
                              "description": "Amount of the deposits",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Value of deposited amount"
                                  }
                              }
                          }
                      }
                  }
              },
              "benefits": {
                  "type": "array",
                  "description": "Benefits for the employee",
                  "items": {
                      "properties": {
                          "type": {
                              "type": "string",
                              "description": "Type of benefit",
                              "enum": [
                                  "OTHER"
                              ]
                          },
                          "interval": {
                              "type": "object",
                              "description": "Interval for which the benefit is denoted",
                              "properties": {
                                  "start_date": {
                                      "type": "string",
                                      "description": "start date of the interval",
                                      "format": "MM/DD/YYYY"
                                  },
                                  "end_date": {
                                      "type": "string",
                                      "description": "end date of the interval",
                                      "format": "MM/DD/YYYY"
                                  }
                              }
                          },
                          "amounts": {
                              "type": "array",
                              "description": "Array of objects representing benefit amounts",
                              "items": {
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "description": "Currency of the benefit",
                                          "enum": [
                                              "USD",
                                              "OTHER"
                                          ]
                                      },
                                      "type": {
                                          "type": "string",
                                          "description": "Type of benefit",
                                          "enum": [
                                              "OTHER"
                                          ]
                                      },
                                      "ytd_flag": {
                                          "type": "boolean",
                                          "description": "Indicates if the amount given is year to date"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Value of benefit amount"
                                      }
                                  }
                              }
                          }
                      }
                  }
              }
          }
      }

      /%}
  - name: M1_INSURANCE_RECORD
    x-displayName: M1_INSURANCE_RECORD
    description: >-
      ---

      title: M1_INSURANCE_RECORD 

      description: This schema represents a comprehensive record of an
      individual's insurance policies, including policy type, coverage details,
      premium amounts, beneficiaries, claims history, and insurer information. 

      ---

      This schema represents a comprehensive record of an individual's insurance
      policies, including policy type, coverage details, premium amounts,
      beneficiaries, claims history, and insurer information. 


      {% json-schema
              schema={
        "title": "M1_INSURANCE_RECORD Schema",
        "summary": "M1_INSURANCE_RECORD SCHEMA",
        "type": "object",
        "properties": {
          "record_date": {
            "type": "string",
            "description": "Date on which the record was generated"
          },
          "cancelled_date": {
            "type": "string",
            "description": "Date on which the insurance was cancelled"
          },
          "pending_cancel_date": {
            "type": "string",
            "description": "Date on which the insurance will be cancelled"
          },
          "policy_number": {
            "type": "string",
            "description": "Policy number"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "EXPIRED",
              "PENDING_ACTIVATION",
              "PENDING_CANCELLATION",
              "PENDING_EXPIRATION",
              "CANCELLED",
              "UNVERIFIED",
              "RESCINDED",
              "NOT_AVAILABLE"
            ],
            "description": "Policy status"
          },
          "policy_types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "AUTO",
                "HOME",
                "RENTERS",
                "PERSONAL_UMBRELLA"
              ]
            },
            "description": "Type of Policy"
          },
          "premium_amount": {
            "type": "object",
            "description": "Premium amount of policy",
            "properties": {
              "currency": {
                "type": "string",
                "description": "Currency of premium amount. e.g. `USD`, `CAD`"
              },
              "amount": {
                "type": "number",
                "description": "Premium amount"
              }
            }
          },
          "payment_frequency": {
            "type": "string",
            "description": "Frequency of payment.",
            "enum": [
              "ANNUAL",
              "SEMI_ANNUAL",
              "QUARTERLY",
              "MONTHLY",
              "SEMI_MONTHLY",
              "OTHER"
            ]
          },
          "coverage_period": {
            "type": "object",
            "description": "Insurance coverage period",
            "properties": {
              "start_date": {
                "type": "string",
                "description": "Start date timestamp of policy coverage"
              },
              "end_date": {
                "type": "string",
                "description": "End date timestamp of policy coverage"
              }
            }
          },
          "policy_holders": {
            "type": "array",
            "description": "List of policy holders",
            "items": {
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the policy holder"
                },
                "phone_number": {
                  "type": "string",
                  "description": "Phone number of the policy holder"
                },
                "address": {
                  "type": "object",
                  "description": "Address of the policy holder",
                  "properties": {
                    "addr1": {
                      "type": "string",
                      "description": "Address Line 1"
                    },
                    "addr2": {
                      "type": "string",
                      "description": "Address Line 2"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "zipcode": {
                      "type": "string",
                      "description": "Zipcode"
                    },
                    "country": {
                      "type": "object",
                      "description": "Country details",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Country name"
                        },
                        "a2_code": {
                          "type": "string",
                          "description": "Alpha-2 code of country"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "insurance_provider": {
            "type": "object",
            "description": "Details of insurance provider",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the insurance provider"
              },
              "phone_number": {
                "type": "string",
                "description": "Phone number of the insurance provider"
              },
              "address": {
                "type": "object",
                "description": "Address of the insurance provider",
                "properties": {
                  "addr1": {
                    "type": "string",
                    "description": "Address Line 1"
                  },
                  "addr2": {
                    "type": "string",
                    "description": "Address Line 2"
                  },
                  "city": {
                    "type": "string",
                    "description": "City"
                  },
                  "state": {
                    "type": "string",
                    "description": "State"
                  },
                  "zipcode": {
                    "type": "string",
                    "description": "Zipcode"
                  },
                  "country": {
                    "type": "object",
                    "description": "Country details",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Country name"
                      },
                      "a2_code": {
                        "type": "string",
                        "description": "Alpha-2 code of country"
                      }
                    }
                  }
                }
              }
            }
          },
          "remit_to": {
            "type": "object",
            "description": "Details of entity to whom premium is remitted",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the entity to whom premium is remitted"
              },
              "phone_number": {
                "type": "string",
                "description": "Phone number of the entity to whom premium is remitted"
              },
              "address": {
                "type": "object",
                "description": "Address of the entity to whom premium is remitted",
                "properties": {
                  "addr1": {
                    "type": "string",
                    "description": "Address Line 1"
                  },
                  "addr2": {
                    "type": "string",
                    "description": "Address Line 2"
                  },
                  "city": {
                    "type": "string",
                    "description": "City"
                  },
                  "state": {
                    "type": "string",
                    "description": "State"
                  },
                  "zipcode": {
                    "type": "string",
                    "description": "Zipcode"
                  },
                  "country": {
                    "type": "object",
                    "description": "Country details",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Country name"
                      },
                      "a2_code": {
                        "type": "string",
                        "description": "Alpha-2 code of country"
                      }
                    }
                  }
                }
              }
            }
          },
          "insurance_agent": {
            "type": "object",
            "description": "Details of insurance agent",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the insurance agent"
              },
              "phone_number": {
                "type": "string",
                "description": "Phone number of the insurance agent"
              },
              "address": {
                "type": "object",
                "description": "Address of the insurance agent",
                "properties": {
                  "addr1": {
                    "type": "string",
                    "description": "Address Line 1"
                  },
                  "addr2": {
                    "type": "string",
                    "description": "Address Line 2"
                  },
                  "city": {
                    "type": "string",
                    "description": "City"
                  },
                  "state": {
                    "type": "string",
                    "description": "State"
                  },
                  "zipcode": {
                    "type": "string",
                    "description": "Zipcode"
                  },
                  "country": {
                    "type": "object",
                    "description": "Country details",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Country name"
                      },
                      "a2_code": {
                        "type": "string",
                        "description": "Alpha-2 code of country"
                      }
                    }
                  }
                }
              }
            }
          },
          "coverages": {
            "type": "array",
            "description": "List of policy coverages",
            "items": {
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Type of coverage.",
                  "enum": [
                    "AUTO",
                    "HOME",
                    "RENTERS",
                    "PERSONAL_UMBRELLA"
                  ]
                },
                "premium_amount": {
                  "type": "object",
                  "description": "Premium amount for coverage",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "description": "Currency of premium amount. e.g. `USD`, `CAD`"
                    },
                    "amount": {
                      "type": "number",
                      "description": "Premium amount"
                    }
                  }
                },
                "details": {
                  "oneOf": [
                    {
                      "title": "Auto",
                      "type": "object",
                      "description": "Auto coverage details",
                      "properties": {
                        "vehicle_info": {
                          "type": "object",
                          "description": "Details of the insured vehicle",
                          "properties": {
                            "vin": {
                              "type": "string",
                              "description": "Vehicle identification number"
                            },
                            "model": {
                              "type": "string",
                              "description": "Model of the vehicle"
                            },
                            "make": {
                              "type": "string",
                              "description": "Make of the vehicle"
                            },
                            "year": {
                              "type": "number",
                              "description": "Year when the vehicle was manufactured"
                            },
                            "brand": {
                              "type": "string",
                              "description": "Brand name of the vehicle"
                            },
                            "garaging_address": {
                              "type": "object",
                              "description": "Garaging location",
                              "properties": {
                                "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                                },
                                "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                                },
                                "city": {
                                  "type": "string",
                                  "description": "City"
                                },
                                "state": {
                                  "type": "string",
                                  "description": "State"
                                },
                                "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode"
                                },
                                "country": {
                                  "type": "object",
                                  "description": "Country details",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "Country name"
                                    },
                                    "a2_code": {
                                      "type": "string",
                                      "description": "Alpha-2 code of country"
                                    }
                                  }
                                }
                              }
                            },
                            "current_mileage": {
                              "oneOf": [
                                {
                                  "title": "Range",
                                  "type": "object",
                                  "description": "Auto yearly mileage as range",
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of mileage.",
                                      "enum": [
                                        "RANGE",
                                        "VALUE"
                                      ]
                                    },
                                    "details": {
                                      "type": "object",
                                      "description": "Details of mileage",
                                      "properties": {
                                        "range": {
                                          "type": "string",
                                          "description": "Mileage in a range"
                                        },
                                        "unit": {
                                          "type": "string",
                                          "description": "Unit of mileage.",
                                          "enum": [
                                            "MI",
                                            "KM"
                                          ]
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "title": "Value",
                                  "type": "object",
                                  "description": "Auto yearly mileage given as exact value",
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of mileage.",
                                      "enum": [
                                        "RANGE",
                                        "VALUE"
                                      ]
                                    },
                                    "details": {
                                      "type": "object",
                                      "description": "Details of mileage",
                                      "properties": {
                                        "value": {
                                          "type": "number",
                                          "description": "Value of mileage"
                                        },
                                        "unit": {
                                          "type": "string",
                                          "description": "Unit of mileage.",
                                          "enum": [
                                            "MI",
                                            "KM"
                                          ]
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "yearly_mileage": {
                              "oneOf": [
                                {
                                  "title": "Range",
                                  "type": "object",
                                  "description": "Auto yearly mileage as range",
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of mileage.",
                                      "enum": [
                                        "RANGE",
                                        "VALUE"
                                      ]
                                    },
                                    "details": {
                                      "type": "object",
                                      "description": "Details of mileage",
                                      "properties": {
                                        "range": {
                                          "type": "string",
                                          "description": "Mileage in a range"
                                        },
                                        "unit": {
                                          "type": "string",
                                          "description": "Unit of mileage.",
                                          "enum": [
                                            "MI",
                                            "KM"
                                          ]
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "title": "Value",
                                  "type": "object",
                                  "description": "Auto yearly mileage given as exact value",
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of mileage.",
                                      "enum": [
                                        "RANGE",
                                        "VALUE"
                                      ]
                                    },
                                    "details": {
                                      "type": "object",
                                      "description": "Details of mileage",
                                      "properties": {
                                        "value": {
                                          "type": "number",
                                          "description": "Value of mileage"
                                        },
                                        "unit": {
                                          "type": "string",
                                          "description": "Unit of mileage.",
                                          "enum": [
                                            "MI",
                                            "KM"
                                          ]
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "fuel_type": {
                              "type": "string",
                              "description": "Fuel type of the vehicle"
                            },
                            "transmission_type": {
                              "type": "string",
                              "description": "Transmission type of the vehicle"
                            },
                            "usage_type": {
                              "type": "string",
                              "description": "Usage type of vehicle.",
                              "enum": [
                                "PERSONAL",
                                "BUSINESS",
                                "OTHER"
                              ]
                            },
                            "usage_sub_type": {
                              "type": "string",
                              "description": "Usage sub type of vehicle.",
                              "enum": [
                                "PERSONAL",
                                "BUSINESS",
                                "PLEASURE",
                                "COMMUTE",
                                "WORK",
                                "SCHOOL",
                                "FARM",
                                "OTHER"
                              ]
                            },
                            "purchase_date": {
                              "type": "string",
                              "description": "Date when the vehicle was purchased."
                            },
                            "ownership_type": {
                              "type": "string",
                              "enum": [
                                "SELF_OR_SPOUSE",
                                "CO_OWNED",
                                "FINANCED",
                                "LEASED"
                              ],
                              "description": "Ownership status of the vehicle."
                            },
                            "is_removed": {
                              "type": "boolean",
                              "description": "Indicates whether the vehicle has been removed from the policy."
                            },
                            "interested_parties": {
                              "type": "array",
                              "description": "List of interested parties in the property",
                              "items": {
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the interested party"
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "Type of the interested party.",
                                    "enum": [
                                      "LIEN_HOLDER",
                                      "SERVICING_AGENT",
                                      "LOSS_PAYEE",
                                      "CONTRACTOR",
                                      "NAMED_ADDITIONAL_INSURED",
                                      "LESSOR",
                                      "OTHER"
                                    ]
                                  },
                                  "address": {
                                    "type": "object",
                                    "description": "Address of the interested party",
                                    "properties": {
                                      "addr1": {
                                        "type": "string",
                                        "description": "Address Line 1"
                                      },
                                      "addr2": {
                                        "type": "string",
                                        "description": "Address Line 2"
                                      },
                                      "city": {
                                        "type": "string",
                                        "description": "City"
                                      },
                                      "state": {
                                        "type": "string",
                                        "description": "State"
                                      },
                                      "zipcode": {
                                        "type": "string",
                                        "description": "Zipcode"
                                      },
                                      "country": {
                                        "type": "object",
                                        "description": "Country details",
                                        "properties": {
                                          "name": {
                                            "type": "string",
                                            "description": "Country name"
                                          },
                                          "a2_code": {
                                            "type": "string",
                                            "description": "Alpha-2 code of country"
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "phone_number": {
                                    "type": "string",
                                    "description": "Phone number of the interested party"
                                  },
                                  "loan_number": {
                                    "type": "string",
                                    "description": "Loan number"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "drivers": {
                          "type": "array",
                          "description": "List of drivers",
                          "items": {
                            "properties": {
                              "first_name": {
                                "type": "string",
                                "description": "First name of the driver"
                              },
                              "middle_name": {
                                "type": "string",
                                "description": "Middle name of the driver"
                              },
                              "last_name": {
                                "type": "string",
                                "description": "Last name of the driver"
                              },
                              "full_name": {
                                "type": "string",
                                "description": "Full name of the driver"
                              },
                              "prefix": {
                                "type": "string",
                                "description": "Name prefix"
                              },
                              "suffix": {
                                "type": "string",
                                "description": "Name suffix"
                              },
                              "address": {
                                "type": "object",
                                "description": "Address of the driver",
                                "properties": {
                                  "addr1": {
                                    "type": "string",
                                    "description": "Address Line 1"
                                  },
                                  "addr2": {
                                    "type": "string",
                                    "description": "Address Line 2"
                                  },
                                  "city": {
                                    "type": "string",
                                    "description": "City"
                                  },
                                  "state": {
                                    "type": "string",
                                    "description": "State"
                                  },
                                  "zipcode": {
                                    "type": "string",
                                    "description": "Zipcode"
                                  },
                                  "country": {
                                    "type": "object",
                                    "description": "Country details",
                                    "properties": {
                                      "name": {
                                        "type": "string",
                                        "description": "Country name"
                                      },
                                      "a2_code": {
                                        "type": "string",
                                        "description": "Alpha-2 code of country"
                                      }
                                    }
                                  }
                                }
                              },
                              "phone_number": {
                                "type": "string",
                                "description": "Phone number of the driver"
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address of the driver"
                              },
                              "gender": {
                                "type": "string",
                                "description": "Gender of the driver"
                              },
                              "nationality": {
                                "type": "string",
                                "description": "Nationality of the driver"
                              },
                              "ssn": {
                                "type": "string",
                                "description": "SSN of the driver"
                              },
                              "date_of_birth": {
                                "type": "string",
                                "description": "Date of birth of the driver"
                              },
                              "marital_status": {
                                "type": "string",
                                "description": "Marital status of the driver"
                              },
                              "driving_license": {
                                "type": "string",
                                "description": "Driving license details of the driver"
                              },
                              "date_licensed": {
                                "type": "string",
                                "description": "Driving license date"
                              },
                              "license_state": {
                                "type": "string",
                                "description": "State in which the driver's license was issued."
                              },
                              "relationship_to_insured": {
                                "type": "string",
                                "enum": [
                                  "SELF",
                                  "SPOUSE",
                                  "CHILD",
                                  "PARENT",
                                  "SIBLING",
                                  "OTHER"
                                ],
                                "description": "Relationship of the driver to the primary insured."
                              },
                              "age": {
                                "type": "number",
                                "description": "Age of the driver."
                              },
                              "age_on_date": {
                                "type": "string",
                                "description": "Driver's age on a specific date."
                              },
                              "education": {
                                "type": "string",
                                "enum": [
                                  "LESS-THAN-HIGH-SCHOOL",
                                  "HIGH-SCHOOL-DIPLOMA",
                                  "ASSOCIATE",
                                  "BACHELORS",
                                  "MASTERS",
                                  "MASTERS-RESEARCH",
                                  "DOCTORAL",
                                  "CERTIFICATE",
                                  "DIPLOMA",
                                  "NON-DEGREE",
                                  "PROFESSIONAL",
                                  "UNDERGRADUATE"
                                ],
                                "description": "Highest level of education completed by the driver."
                              },
                              "occupation": {
                                "type": "string",
                                "description": "Occupation or professional role of the driver."
                              },
                              "age_licensed": {
                                "type": "integer",
                                "description": "Age at which the driver was issued a license."
                              },
                              "is_excluded": {
                                "type": "boolean",
                                "description": "Indicates whether this driver is excluded from the insurance policy."
                              }
                            }
                          }
                        },
                        "coverage_items": {
                          "type": "array",
                          "description": "List of coverage items",
                          "items": {
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Name of the coverage item"
                              },
                              "type": {
                                "type": "string",
                                "description": "Type of the coverage items.",
                                "enum": [
                                  "BODILY_INJURY",
                                  "PROPERTY_DAMAGE",
                                  "UNINSURED_MOTORIST_BODILY_INJURY",
                                  "UNINSURED_MOTORIST_PROPERTY_DAMAGE",
                                  "UNDERINSURED_MOTORIST_BODILY_INJURY",
                                  "UNDERINSURED_MOTORIST_PROPERTY_DAMAGE",
                                  "UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY",
                                  "UNINSURED_UNDERINSURED_MOTORIST_PROPERTY_DAMAGE",
                                  "UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE",
                                  "MEDICAL_PAYMENTS",
                                  "PERSONAL_INJURY_PROTECTION",
                                  "COMPREHENSIVE_COVERAGE",
                                  "COLLISION_COVERAGE",
                                  "AUTOMOBILE_DEATH_INDEMNITY",
                                  "EMERGENCY_TRANSPORTATION",
                                  "MECHANICAL_BREAKDOWN",
                                  "ROADSIDE_ASSISTANCE",
                                  "COMBINED_ADDITIONAL_COVERAGES",
                                  "FUNERAL_EXPENSE_BENEFITS",
                                  "WITNESS_EXPENSE",
                                  "REWARD_COVERAGE",
                                  "PROOF_OF_LOSS",
                                  "LOSS_OF_USE",
                                  "CUSTOM_PARTS_EQUIPMENTS",
                                  "TOWING_AND_LABOR",
                                  "RENTAL_REIMBURSEMENT",
                                  "WORK_LOSS_BENEFITS",
                                  "PERSONAL_UMBRELLA",
                                  "COMBINED_SINGLE_LIMIT",
                                  "OPTIONAL_BODILY_INJURY_OTHERS",
                                  "OPTIONAL_BASIC_ECONOMIC_LOSS",
                                  "ADDITIONAL_PERSONAL_INJURY_PROTECTION",
                                  "ESSENTIAL_SERVICES",
                                  "DEATH_BENEFITS",
                                  "SURVIVOR_BENEFITS",
                                  "REPLACEMENT_SERVICES",
                                  "ATTENDANT_CARE",
                                  "OTHER"
                                ]
                              },
                              "x12_info": {
                                "type": "object",
                                "description": "X12 standard details of coverage item",
                                "properties": {
                                  "code": {
                                    "type": "string",
                                    "description": "X12 standard code of the coverage item.",
                                    "enum": [
                                      "BI",
                                      "PD",
                                      "FEB",
                                      "UMISG",
                                      "UMIPD",
                                      "COMP",
                                      "COLL",
                                      "LUSE",
                                      "TL",
                                      "RREIM",
                                      "WLB",
                                      "PLC",
                                      "PIP",
                                      "UNDSG",
                                      "UNDPD",
                                      "ADDA",
                                      "CSL",
                                      "OBI",
                                      "OBEL",
                                      "APIP"
                                    ]
                                  },
                                  "desc": {
                                    "type": "string",
                                    "description": "X12 standard description of coverage item"
                                  }
                                }
                              },
                              "premium_amount": {
                                "type": "object",
                                "description": "Premium amount for the coverage item",
                                "properties": {
                                  "currency": {
                                    "type": "string",
                                    "description": "Currency of premium amount. e.g. `USD`, `CAD`"
                                  },
                                  "amount": {
                                    "type": "number",
                                    "description": "Premium amount"
                                  }
                                }
                              },
                              "limits": {
                                "type": "array",
                                "description": "Details of limits applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of limit.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Limit detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the limit"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Limit description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              },
                              "deductibles": {
                                "type": "array",
                                "description": "Details of deductibles applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of Deductible.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Deductible detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the deductible"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Deductible description"
                                        }
                                      ]
                                    },
                                    "is_waiver": {
                                      "description": "Specifies if the deductible is waived.",
                                      "type": "boolean"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Home",
                      "type": "object",
                      "description": "Home coverage details",
                      "properties": {
                        "property_info": {
                          "type": "object",
                          "description": "Details of the insured property",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "Name of the property"
                            },
                            "address": {
                              "type": "object",
                              "description": "Address of the property",
                              "properties": {
                                "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                                },
                                "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                                },
                                "city": {
                                  "type": "string",
                                  "description": "City"
                                },
                                "state": {
                                  "type": "string",
                                  "description": "State"
                                },
                                "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode"
                                },
                                "country": {
                                  "type": "object",
                                  "description": "Country details",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "Country name"
                                    },
                                    "a2_code": {
                                      "type": "string",
                                      "description": "Alpha-2 code of country"
                                    }
                                  }
                                }
                              }
                            },
                            "interested_parties": {
                              "type": "array",
                              "description": "List of interested parties in the property",
                              "items": {
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the interested party"
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "Type of the interested party.",
                                    "enum": [
                                      "FIRST_MORTGAGEE",
                                      "SECOND_MORTGAGEE",
                                      "THIRD_MORTGAGEE",
                                      "SERVICING_AGENT",
                                      "LIEN_HOLDER",
                                      "LOSS_PAYEE",
                                      "CONTRACTOR",
                                      "HOMEOWNERS_ASSOCIATION",
                                      "NAMED_ADDITIONAL_INSURED",
                                      "LESSOR",
                                      "OTHER"
                                    ]
                                  },
                                  "address": {
                                    "type": "object",
                                    "description": "Address of the interested party",
                                    "properties": {
                                      "addr1": {
                                        "type": "string",
                                        "description": "Address Line 1"
                                      },
                                      "addr2": {
                                        "type": "string",
                                        "description": "Address Line 2"
                                      },
                                      "city": {
                                        "type": "string",
                                        "description": "City"
                                      },
                                      "state": {
                                        "type": "string",
                                        "description": "State"
                                      },
                                      "zipcode": {
                                        "type": "string",
                                        "description": "Zipcode"
                                      },
                                      "country": {
                                        "type": "object",
                                        "description": "Country details",
                                        "properties": {
                                          "name": {
                                            "type": "string",
                                            "description": "Country name"
                                          },
                                          "a2_code": {
                                            "type": "string",
                                            "description": "Alpha-2 code of country"
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "phone_number": {
                                    "type": "string",
                                    "description": "Phone number of the interested party"
                                  },
                                  "loan_number": {
                                    "type": "string",
                                    "description": "Loan number"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "coverage_items": {
                          "type": "array",
                          "description": "List of coverage items",
                          "items": {
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Name of the coverage item"
                              },
                              "type": {
                                "type": "string",
                                "description": "Type of the coverage items.",
                                "enum": [
                                  "DWELLING",
                                  "PERSONAL_PROPERTY",
                                  "BUILDING_ADDITIONS_ALTERATIONS",
                                  "BUILDING_ORDINANCE",
                                  "LOSS_ASSESSMENT",
                                  "PERSONAL_LIABILITY",
                                  "ADDITIONAL_PREMISES_LIABILITY_EXTENSION",
                                  "MEDICAL_PAYMENTS",
                                  "WORKERS_COMPENSATION",
                                  "REPLACEMENT_COST_CONTENTS",
                                  "HOME_COMPUTERS",
                                  "SEWER_DRAINS",
                                  "JEWELRY",
                                  "EARTHQUAKE",
                                  "BUSINESS_PROPERTY",
                                  "LOSS_OF_USE",
                                  "ALL_PERILS",
                                  "NAMED_PERILS",
                                  "ALL_OTHER_PERILS",
                                  "OTHER"
                                ]
                              },
                              "x12_info": {
                                "type": "object",
                                "description": "X12 standard details of coverage item",
                                "properties": {
                                  "code": {
                                    "type": "string",
                                    "description": "X12 standard code of the coverage item.",
                                    "enum": [
                                      "Dwell",
                                      "PP",
                                      "BAA",
                                      "BOLAW",
                                      "LAC",
                                      "PPTC",
                                      "ADDRL",
                                      "MEDPM",
                                      "WCFIN",
                                      "RCC",
                                      "PC",
                                      "SEWER",
                                      "UNJWP",
                                      "ERQK",
                                      "BUSPR",
                                      "LUSE"
                                    ]
                                  },
                                  "desc": {
                                    "type": "string",
                                    "description": "X12 standard description of coverage item"
                                  }
                                }
                              },
                              "perils": {
                                "type": "array",
                                "description": "Named perils present on the policy",
                                "properties": {
                                  "items": {
                                    "description": "Named perils present on the policy",
                                    "type": "string",
                                    "enum": [
                                      "FIRE",
                                      "LIGHTNING",
                                      "EXPLOSION",
                                      "WINDSTORM",
                                      "HAIL",
                                      "SMOKE",
                                      "AIRCRAFT",
                                      "VEHICLES",
                                      "RIOT",
                                      "CIVIL_COMMOTION",
                                      "VANDALISM",
                                      "SPRINKLER_LEAKAGE",
                                      "SINKHOLE_COLLAPSE",
                                      "VOLCANIC_ACTIVITY",
                                      "BURGLARY_BREAK_IN",
                                      "FALLING_OBJECTS",
                                      "WEIGHT_OF_ICE",
                                      "SNOW",
                                      "SLEET",
                                      "WATER_DAMAGE",
                                      "COLLAPSE",
                                      "ORDINANCE_OF_LAW",
                                      "EARTHQUAKE",
                                      "FLOOD",
                                      "POWER_FAILURE",
                                      "NEGLECT",
                                      "WAR",
                                      "NUCLEAR_HAZARD",
                                      "INTENTIONAL_ACTS"
                                    ]
                                  }
                                }
                              },
                              "premium_amount": {
                                "type": "object",
                                "description": "Premium amount for the coverage item",
                                "properties": {
                                  "currency": {
                                    "type": "string",
                                    "description": "Currency of premium amount. e.g. `USD`, `CAD`"
                                  },
                                  "amount": {
                                    "type": "number",
                                    "description": "Premium amount"
                                  }
                                }
                              },
                              "limits": {
                                "type": "array",
                                "description": "Details of limits applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of limit.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Limit detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the limit"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Limit description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              },
                              "deductibles": {
                                "type": "array",
                                "description": "Details of deductibles applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of Deductible.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Deductible detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the deductible"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Deductible description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Renters",
                      "type": "object",
                      "description": "Rent coverage details",
                      "properties": {
                        "property_info": {
                          "type": "object",
                          "description": "Details of the insured property",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "Name of the property"
                            },
                            "address": {
                              "type": "object",
                              "description": "Address of the property",
                              "properties": {
                                "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                                },
                                "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                                },
                                "city": {
                                  "type": "string",
                                  "description": "City"
                                },
                                "state": {
                                  "type": "string",
                                  "description": "State"
                                },
                                "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode"
                                },
                                "country": {
                                  "type": "object",
                                  "description": "Country details",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "Country name"
                                    },
                                    "a2_code": {
                                      "type": "string",
                                      "description": "Alpha-2 code of country"
                                    }
                                  }
                                }
                              }
                            },
                            "interested_parties": {
                              "type": "array",
                              "description": "List of interested parties in the property",
                              "items": {
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the interested party"
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "Type of the interested party.",
                                    "enum": [
                                      "FIRST_MORTGAGEE",
                                      "SECOND_MORTGAGEE",
                                      "THIRD_MORTGAGEE",
                                      "SERVICING_AGENT",
                                      "LIEN_HOLDER",
                                      "LOSS_PAYEE",
                                      "CONTRACTOR",
                                      "HOMEOWNERS_ASSOCIATION",
                                      "NAMED_ADDITIONAL_INSURED",
                                      "LESSOR",
                                      "OTHER"
                                    ]
                                  },
                                  "address": {
                                    "type": "object",
                                    "description": "Address of the interested party",
                                    "properties": {
                                      "addr1": {
                                        "type": "string",
                                        "description": "Address Line 1"
                                      },
                                      "addr2": {
                                        "type": "string",
                                        "description": "Address Line 2"
                                      },
                                      "city": {
                                        "type": "string",
                                        "description": "City"
                                      },
                                      "state": {
                                        "type": "string",
                                        "description": "State"
                                      },
                                      "zipcode": {
                                        "type": "string",
                                        "description": "Zipcode"
                                      },
                                      "country": {
                                        "type": "object",
                                        "description": "Country details",
                                        "properties": {
                                          "name": {
                                            "type": "string",
                                            "description": "Country name"
                                          },
                                          "a2_code": {
                                            "type": "string",
                                            "description": "Alpha-2 code of country"
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "phone_number": {
                                    "type": "string",
                                    "description": "Phone number of the interested party"
                                  },
                                  "loan_number": {
                                    "type": "string",
                                    "description": "Loan number"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "coverage_items": {
                          "type": "array",
                          "description": "List of coverage items",
                          "items": {
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Name of the coverage item"
                              },
                              "type": {
                                "type": "string",
                                "description": "Type of the coverage items.",
                                "enum": [
                                  "DWELLING",
                                  "PERSONAL_PROPERTY",
                                  "BUILDING_ADDITIONS_ALTERATIONS",
                                  "BUILDING_ORDINANCE",
                                  "LOSS_ASSESSMENT",
                                  "PERSONAL_LIABILITY",
                                  "ADDITIONAL_PREMISES_LIABILITY_EXTENSION",
                                  "MEDICAL_PAYMENTS",
                                  "WORKERS_COMPENSATION",
                                  "REPLACEMENT_COST_CONTENTS",
                                  "HOME_COMPUTERS",
                                  "SEWER_DRAINS",
                                  "JEWELRY",
                                  "EARTHQUAKE",
                                  "BUSINESS_PROPERTY",
                                  "LOSS_OF_USE",
                                  "ALL_PERILS",
                                  "NAMED_PERILS",
                                  "ALL_OTHER_PERILS",
                                  "OTHER"
                                ]
                              },
                              "x12_info": {
                                "type": "object",
                                "description": "X12 standard details of coverage item",
                                "properties": {
                                  "code": {
                                    "type": "string",
                                    "description": "X12 standard code of the coverage item.",
                                    "enum": [
                                      "Dwell",
                                      "PP",
                                      "BAA",
                                      "BOLAW",
                                      "LAC",
                                      "PPTC",
                                      "ADDRL",
                                      "MEDPM",
                                      "WCFIN",
                                      "RCC",
                                      "PC",
                                      "SEWER",
                                      "UNJWP",
                                      "ERQK",
                                      "BUSPR",
                                      "LUSE"
                                    ]
                                  },
                                  "desc": {
                                    "type": "string",
                                    "description": "X12 standard description of coverage item"
                                  }
                                }
                              },
                              "perils": {
                                "type": "array",
                                "description": "Named perils present in the policy",
                                "items": {
                                  "type": "string",
                                  "enum": [
                                    "FIRE",
                                    "LIGHTNING",
                                    "EXPLOSION",
                                    "WINDSTORM",
                                    "HAIL",
                                    "SMOKE",
                                    "AIRCRAFT",
                                    "VEHICLES",
                                    "RIOT",
                                    "CIVIL_COMMOTION",
                                    "VANDALISM",
                                    "SPRINKLER_LEAKAGE",
                                    "SINKHOLE_COLLAPSE",
                                    "VOLCANIC_ACTIVITY",
                                    "BURGLARY_BREAK_IN",
                                    "FALLING_OBJECTS",
                                    "WEIGHT_OF_ICE",
                                    "SNOW",
                                    "SLEET",
                                    "WATER_DAMAGE",
                                    "COLLAPSE",
                                    "ORDINANCE_OF_LAW",
                                    "EARTHQUAKE",
                                    "FLOOD",
                                    "POWER_FAILURE",
                                    "NEGLECT",
                                    "WAR",
                                    "NUCLEAR_HAZARD",
                                    "INTENTIONAL_ACTS"
                                  ]
                                }
                              },
                              "premium_amount": {
                                "type": "object",
                                "description": "Premium amount for the coverage item",
                                "properties": {
                                  "currency": {
                                    "type": "string",
                                    "description": "Currency of premium amount. e.g. `USD`, `CAD`"
                                  },
                                  "amount": {
                                    "type": "number",
                                    "description": "Premium amount"
                                  }
                                }
                              },
                              "limits": {
                                "type": "array",
                                "description": "Details of limits applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of limit.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Limit detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the limit"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Limit description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              },
                              "deductibles": {
                                "type": "array",
                                "description": "Details of deductibles applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of Deductible.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Deductible detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the deductible"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Deductible description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Personal Umbrella",
                      "type": "object",
                      "description": "Personal umbrella coverage details",
                      "properties": {
                        "coverage_items": {
                          "type": "array",
                          "description": "List of coverage items",
                          "items": {
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Name of the coverage item."
                              },
                              "type": {
                                "type": "string",
                                "description": "Type of the coverage items. e.g. `PERSONAL_UMBRELLA`"
                              },
                              "x12_info": {
                                "type": "object",
                                "description": "X12 standard details of coverage item",
                                "properties": {
                                  "code": {
                                    "type": "string",
                                    "description": "X12 standard code of the coverage item. e.g. `PLC`"
                                  },
                                  "desc": {
                                    "type": "string",
                                    "description": "X12 standard description of coverage item"
                                  }
                                }
                              },
                              "premium_amount": {
                                "type": "object",
                                "description": "Premium amount for coverage",
                                "properties": {
                                  "currency": {
                                    "type": "string",
                                    "description": "Currency of premium amount. e.g. `USD`, `CAD`"
                                  },
                                  "amount": {
                                    "type": "number",
                                    "description": "Premium amount"
                                  }
                                }
                              },
                              "limits": {
                                "type": "array",
                                "description": "Details of limits applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of limit.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Limit detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the limit"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Limit description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              },
                              "deductibles": {
                                "type": "array",
                                "description": "Details of deductibles applies to the coverage item",
                                "items": {
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "Type of Deductible.",
                                      "enum": [
                                        "TEXT",
                                        "AMOUNT",
                                        "PER_PERSON",
                                        "PER_ENDORSEMENT",
                                        "PER_POLICY",
                                        "PER_ACCIDENT",
                                        "PER_DAY",
                                        "MAXIMUM",
                                        "REASONABLE_EXPENSE",
                                        "PER_OCCURRENCE",
                                        "PER_DISABLEMENT",
                                        "AGGREGATE"
                                      ]
                                    },
                                    "value": {
                                      "description": "Deductible detail",
                                      "oneOf": [
                                        {
                                          "title": "Amount",
                                          "type": "object",
                                          "properties": {
                                            "amount": {
                                              "type": "number",
                                              "description": "Amount of the deductible"
                                            },
                                            "currency": {
                                              "type": "string",
                                              "description": "Currency of the amount. e.g. `USD`, `CAD`"
                                            }
                                          }
                                        },
                                        {
                                          "title": "Descriptive",
                                          "type": "string",
                                          "description": "Deductible description"
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }

      /%}
  - name: M1_AUTO_INSURANCE_CLAIM_RECORD
    x-displayName: M1_AUTO_INSURANCE_CLAIM_RECORD
    description: >-
      ---

      title: M1_AUTO_INSURANCE_CLAIM_RECORD 

      description: This schema represents an individual's auto insurance claim
      record, including claim details, policy information, vehicle data,
      involved parties, and payment breakdowns.

      ---

      This schema represents an individual's auto insurance claim record,
      including claim details, policy information, vehicle data, involved
      parties, and payment breakdowns.


      {% json-schema
              schema={
               "title": "M1_AUTO_INSURANCE_CLAIM_RECORD Schema",
          "type": "object",
          "description": "Representation of the Auto Insurance claim record for an individual\n",
          "properties": {
            "as_of_date": {
              "type": "string",
              "description": "Date on which the record was generated"
            },
            "auto_insurance_claims": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "claim_date": {
                    "type": "string",
                    "description": "The date when the insurance claim was made."
                  },
                  "claim_number": {
                    "type": "string",
                    "description": "Unique identifier for the insurance claim."
                  },
                  "policy_number": {
                    "type": "string",
                    "description": "Policy number"
                  },
                  "vehicle_info": {
                    "type": "object",
                    "properties": {
                      "vin": {
                        "type": "string",
                        "description": "Vehicle Identification Number (VIN) of the insured vehicle."
                      },
                      "model": {
                        "type": "string",
                        "description": "The model of the insured vehicle."
                      },
                      "make": {
                        "type": "string",
                        "description": "The make or manufacturer of the insured vehicle."
                      },
                      "year": {
                        "type": "number",
                        "description": "The year of manufacture of the insured vehicle."
                      }
                    },
                    "description": "Information about the insured vehicle."
                  },
                  "policy_holders": {
                    "type": "array",
                    "description": "List of policy holders associated with the claim."
                  },
                  "insurance_provider": {
                    "type": "object",
                    "description": "Details of insurance provider",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Name of the insurance provider"
                      },
                      "phone_number": {
                        "type": "string",
                        "description": "Phone number of the insurance provider"
                      },
                      "address": {
                        "type": "object",
                        "description": "Address of the insurance provider",
                        "properties": {
                          "addr1": {
                            "type": "string",
                            "description": "Address Line 1"
                          },
                          "addr2": {
                            "type": "string",
                            "description": "Address Line 2"
                          },
                          "city": {
                            "type": "string",
                            "description": "City"
                          },
                          "state": {
                            "type": "string",
                            "description": "State"
                          },
                          "zipcode": {
                            "type": "string",
                            "description": "Zipcode"
                          },
                          "country": {
                            "type": "object",
                            "description": "Country details",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Country name"
                              },
                              "a2_code": {
                                "type": "string",
                                "description": "Alpha-2 code of country"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "adjuster": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Name of the adjuster handling the insurance claim"
                      },
                      "phone_number": {
                        "type": "string",
                        "description": "Phone number of the adjuster"
                      },
                      "email": {
                        "type": "string",
                        "description": "Email address of the adjuster"
                      },
                      "address": {
                        "type": "object",
                        "properties": {
                          "addr1": {
                            "type": "string",
                            "description": "Address Line 1"
                          },
                          "addr2": {
                            "type": "string",
                            "description": "Address Line 2"
                          },
                          "city": {
                            "type": "string",
                            "description": "City"
                          },
                          "state": {
                            "type": "string",
                            "description": "State"
                          },
                          "zipcode": {
                            "type": "string",
                            "description": "Zipcode"
                          },
                          "country": {
                            "type": "object",
                            "description": "Country details",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Country name"
                              },
                              "a2_code": {
                                "type": "string",
                                "description": "Alpha-2 code of country"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "incident_location": {
                    "type": "object",
                    "description": "Location where the incident leading to the insurance claim occurred.",
                    "properties": {
                      "addr1": {
                        "type": "string",
                        "description": "Address Line 1"
                      },
                      "addr2": {
                        "type": "string",
                        "description": "Address Line 2"
                      },
                      "city": {
                        "type": "string",
                        "description": "City"
                      },
                      "state": {
                        "type": "string",
                        "description": "State"
                      },
                      "zipcode": {
                        "type": "string",
                        "description": "Zipcode"
                      },
                      "country": {
                        "type": "object",
                        "description": "Country details",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Country name"
                          },
                          "a2_code": {
                            "type": "string",
                            "description": "Alpha-2 code of country"
                          }
                        }
                      }
                    }
                  },
                  "claim_description": {
                    "type": "string",
                    "description": "Description of the insurance claim"
                  },
                  "claim_disposition": {
                    "type": "string",
                    "description": "The status or disposition of the insurance claim. Enum `OPEN`,`CLOSED`"
                  },
                  "vehicle_operator": {
                    "type": "object",
                    "properties": {
                      "first_name": {
                        "type": "string",
                        "description": "First name of the vehicle operator"
                      },
                      "middle_name": {
                        "type": "string",
                        "description": "Middle name of the vehicle operator"
                      },
                      "last_name": {
                        "type": "string",
                        "description": "Last name of the vehicle operator"
                      },
                      "full_name": {
                        "type": "string",
                        "description": "Full name of the vehicle operator"
                      },
                      "prefix": {
                        "type": "string",
                        "description": "Prefix of the vehicle operator's name"
                      },
                      "suffix": {
                        "type": "string",
                        "description": "Suffix of the vehicle operator's name"
                      },
                      "address": {
                        "type": "object",
                        "description": "Address information of the vehicle operator",
                        "properties": {
                          "addr1": {
                            "type": "string",
                            "description": "Address Line 1"
                          },
                          "addr2": {
                            "type": "string",
                            "description": "Address Line 2"
                          },
                          "city": {
                            "type": "string",
                            "description": "City"
                          },
                          "state": {
                            "type": "string",
                            "description": "State"
                          },
                          "zipcode": {
                            "type": "string",
                            "description": "Zipcode"
                          },
                          "country": {
                            "type": "object",
                            "description": "Country details",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "Country name"
                              },
                              "a2_code": {
                                "type": "string",
                                "description": "Alpha-2 code of country"
                              }
                            }
                          }
                        }
                      },
                      "phone_number": {
                        "type": "string",
                        "description": "Phone number of the vehicle operator"
                      },
                      "email": {
                        "type": "string",
                        "description": "Email address of the vehicle operator"
                      },
                      "gender": {
                        "type": "string",
                        "description": "Gender of the vehicle operator"
                      },
                      "nationality": {
                        "type": "string",
                        "description": "Nationality of the vehicle operator"
                      },
                      "ssn": {
                        "type": "string",
                        "description": "Social Security Number (SSN) of the vehicle operator"
                      },
                      "date_of_birth": {
                        "type": "string",
                        "description": "Date of birth of the vehicle operator"
                      },
                      "marital_status": {
                        "type": "string",
                        "description": "Marital status of the vehicle operator"
                      },
                      "driving_license": {
                        "type": "string",
                        "description": "Driving license details of the vehicle operator"
                      },
                      "date_licensed": {
                        "type": "string",
                        "description": "Date at which driving license"
                      }
                    }
                  },
                  "total_claim_paid": {
                    "type": "object",
                    "description": "Total claim paid",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "description": "Currency of claim amount. e.g. `USD`, `CAD`"
                      },
                      "amount": {
                        "type": "number",
                        "description": "Claim amount"
                      }
                    }
                  },
                  "claim_breakup": {
                    "type": "array",
                    "description": "Information about the amount claimed for the insurance claim",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Name of the claimant or insured individual"
                        },
                        "type": {
                          "type": "string",
                          "description": "Type of insurance claim.  Enum `BODILY_INJURY`, `PROPERTY_DAMAGE`, `COLLISION`, `COMPREHENSIVE`,` MEDICAL_PAYMENTS`,`UIM`, `UM`, `PERSONAL_INJURY_PROTECTION`"
                        },
                        "x12_info": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "type": "string",
                              "description": "X12 standard code of the coverage item. e.g. `BI`, `MEDPM`, `UMISG`"
                            },
                            "desc": {
                              "type": "string",
                              "description": "Description associated with the X12 information."
                            }
                          },
                          "description": "X12 standard description of coverage item"
                        },
                        "amount_claimed": {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": "string",
                              "description": "Currency of claim amount. e.g. `USD`, `CAD`"
                            },
                            "amount": {
                              "type": "number",
                              "description": "Claim amount"
                            }
                          }
                        },
                        "deductible": {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": "string",
                              "description": "Currency in which the deductible amount is stated."
                            },
                            "amount": {
                              "type": "number",
                              "description": "Deductible amount for the insurance claim."
                            }
                          },
                          "description": "Information about the deductible for the insurance claim"
                        },
                        "amount_paid": {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": "string",
                              "description": "Currency in which the amount paid is stated"
                            },
                            "amount": {
                              "type": "number",
                              "description": "Total amount paid for the insurance claim"
                            }
                          },
                          "description": "Information about the amount paid for the insurance claim"
                        },
                        "date_paid": {
                          "type": "string",
                          "description": "Date when the insurance claim was paid"
                        },
                        "paid_to": {
                          "type": "string",
                          "description": "Recipient or payee of the insurance claim payment"
                        },
                        "disposition": {
                          "type": "string",
                          "description": "Disposition or status of the insurance claim. Enum `OPEN`, `CLOSED`"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
              }
      /%}
  - name: M1_STUDENT_ID_RECORD
    x-displayName: M1_STUDENT_ID_RECORD
    description: >-
      ---

      title: M1_STUDENT_ID_RECORD 

      description: This schema represents the student's identification record,
      containing personal details, academic background, and teaching institution
      information.


      ---

      This schema represents the student's identification record, containing
      personal details, academic background, and teaching institution
      information.


      {% json-schema
              schema={
          "title": "M1_STUDENT_ID_RECORD Schema",
          "summary": "M1_STUDENT_ID_RECORD SCHEMA",
          "type": "object",
          "properties": {
              "valid_from": {
                  "type": "string",
                  "description": "Student ID valid from"
              },
              "valid_upto": {
                  "type": "string",
                  "description": "Student ID valid upto"
              },
              "student": {
                  "type": "object",
                  "description": "Object with information about the Student, as provided on Student ID",
                  "properties": {
                      "student_id": {
                          "type": "string",
                          "description": "Unique, school-provided Student ID"
                      },
                      "first_name": {
                          "type": "string",
                          "description": "First name of the student"
                      },
                      "last_name": {
                          "type": "string",
                          "description": "Last name of the student"
                      },
                      "middle_name": {
                          "type": "string",
                          "description": "Middle name of the student"
                      },
                      "prefix": {
                          "type": "string",
                          "description": "Prefix to the name"
                      },
                      "suffix": {
                          "type": "string",
                          "description": "Suffix to the name"
                      },
                      "full_name": {
                          "type": "string",
                          "description": "Full name of the student"
                      },
                      "former_first_name": {
                          "type": "string",
                          "description": "Former first name"
                      },
                      "former_middle_name": {
                          "type": "string",
                          "description": "Former middle name"
                      },
                      "former_last_name": {
                          "type": "string",
                          "description": "Former last name"
                      },
                      "former_full_name": {
                          "type": "string",
                          "description": "Former full name"
                      },
                      "former_suffix": {
                          "type": "string",
                          "description": "Suffix to the former name"
                      },
                      "former_prefix": {
                          "type": "string",
                          "description": "Prefix to the former name"
                      },
                      "date_of_birth": {
                          "type": "string",
                          "description": "Birthdate of the student"
                      },
                      "govt_id": {
                          "type": "object",
                          "description": "Government id of the student",
                          "properties": {
                              "id": {
                                  "type": "string"
                              },
                              "type": {
                                  "type": "string"
                              }
                          }
                      },
                      "email": {
                          "type": "string",
                          "description": "Email address of the student, as provided on the Student ID"
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the student, as provided on the Student ID"
                      },
                      "address": {
                          "type": "object",
                          "description": "Student's Address information as provided on the Student ID",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address line 2. Should be populated only if `addr1` is populated"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode for the address"
                              },
                              "country": {
                                  "type": "object",
                                  "description": "Country information",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code for the country from ISO 3166"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "teaching_institution": {
                  "type": "object",
                  "description": "Object with information about the teaching institution",
                  "properties": {
                      "name": {
                          "type": "string",
                          "description": "Name of the institution"
                      },
                      "id": {
                          "type": "string",
                          "description": "Unique identifier of the institute"
                      },
                      "id_type": {
                          "type": "string",
                          "description": "Type of ID used to identify given institution Enum `AISHE`"
                      },
                      "address": {
                          "type": "object",
                          "description": "Student's Address information as provided for previous academic record",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address line 2. Should be populated only if `addr1` is populated"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode for the address"
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code for the country from ISO 3166"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "degree_awarding_institution": {
                  "type": "object",
                  "description": "Object with information about the degree awarding institution",
                  "properties": {
                      "name": {
                          "type": "string",
                          "description": "Name of the institution"
                      },
                      "id": {
                          "type": "string",
                          "description": "Unique identifier of the institute"
                      },
                      "id_type": {
                          "type": "string",
                          "description": "Type of ID used to identify given institution Enum `IPEDS`,`CEEB`"
                      },
                      "address": {
                          "type": "object",
                          "description": "Student's Address information as provided for previous academic record",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address line 2. Should be populated only if `addr1` is populated"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode for the address"
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code for the country from ISO 3166"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "degrees": {
                  "type": "array",
                  "description": "List of degrees found in Student ID",
                  "items": {
                      "type": "object",
                      "properties": {
                          "description": {
                              "type": "string"
                          },
                          "type": {
                              "type": "string",
                              "description": "Level of the degree. Enum  `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`"
                          },
                          "field_of_study": {
                              "type": "array",
                              "description": "List of objects with information about the field of study",
                              "items": {
                                  "properties": {
                                      "type": {
                                          "type": "string",
                                          "description": "Type of study. Enum `MAJOR`,`MINOR`,`CONCENTRATION`"
                                      },
                                      "description": {
                                          "type": "string",
                                          "description": "Name of the field of study"
                                      },
                                      "code_type": {
                                          "type": "string",
                                          "description": "Type of the code used for identifying the field of study E.g. CIP, HEGIS, OTHER"
                                      },
                                      "code": {
                                          "type": "string",
                                          "description": "Specifies the code for the field of study"
                                      }
                                  }
                              }
                          }
                      }
                  }
              }
          }
      }

      /%}
  - name: M1_W2_RECORD
    x-displayName: M1_W2_RECORD
    description: >-
      ---

      title: M1_W2_RECORD 

      description:  The M1_W2_RECORD Schema represents the details of a W-2 tax
      form, which reports wages, tips, and other compensation paid to an
      employee. It includes information about the employee, employer, earnings,
      taxes withheld, and other payroll-related details for tax filing purposes.

      ---

      The M1_W2_RECORD Schema represents the details of a W-2 tax form, which
      reports wages, tips, and other compensation paid to an employee. It
      includes information about the employee, employer, earnings, taxes
      withheld, and other payroll-related details for tax filing purposes.


      {% json-schema
              schema={
          "type": "object",
          "properties": {
              "allocated_tips": {
                  "type": "string",
                  "description": "Tips allocated to the employee by the employer."
              },
              "employee": {
                  "type": "object",
                  "properties": {
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "description": "Postal code of the employee's address."
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "string",
                                          "description": "ISO 3166-1 alpha-2 country code."
                                      },
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country."
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Additional address line."
                              },
                              "addr1": {
                                  "type": "string",
                                  "description": "Primary address line."
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City of the employee's address."
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State of the employee's address."
                              }
                          }
                      },
                      "gender": {
                          "type": "string",
                          "description": "Gender of the employee."
                      },
                      "prefix": {
                          "type": "string",
                          "description": "Prefix of the employee's name (e.g., Mr., Ms.)."
                      },
                      "date_of_birth": {
                          "type": "string",
                          "description": "Date of birth of the employee."
                      },
                      "last_name": {
                          "type": "string",
                          "description": "Last name of the employee."
                      },
                      "middle_name": {
                          "type": "string",
                          "description": "Middle name of the employee."
                      },
                      "suffix": {
                          "type": "string",
                          "description": "Suffix of the employee's name (e.g., Jr., Sr.)."
                      },
                      "ssn": {
                          "type": "string",
                          "description": "Social Security Number of the employee."
                      },
                      "marital_status": {
                          "type": "string",
                          "description": "Marital status of the employee."
                      },
                      "full_name": {
                          "type": "string",
                          "description": "Full name of the employee."
                      },
                      "nationality": {
                          "type": "string",
                          "description": "Nationality of the employee."
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the employee."
                      },
                      "first_name": {
                          "type": "string",
                          "description": "First name of the employee."
                      },
                      "email": {
                          "type": "string",
                          "description": "Email address of the employee."
                      }
                  }
              },
              "social_security_tips": {
                  "type": "string",
                  "description": "Tips subject to Social Security tax."
              },
              "local_wages_tips": {
                  "type": "string",
                  "description": "Local wages and tips."
              },
              "control_number": {
                  "type": "string",
                  "description": "Control number assigned by the employer."
              },
              "federal_income_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of federal income tax withheld."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "medicare_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of Medicare tax withheld."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "employer": {
                  "type": "object",
                  "properties": {
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "description": "Postal code of the employer's address."
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "string",
                                          "description": "ISO 3166-1 alpha-2 country code."
                                      },
                                      "name": {
                                          "type": "string",
                                          "description": "Name of the country."
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Additional address line."
                              },
                              "addr1": {
                                  "type": "string",
                                  "description": "Primary address line."
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City of the employer's address."
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State of the employer's address."
                              }
                          }
                      },
                      "name": {
                          "type": "string",
                          "description": "Name of the employer."
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the employer."
                      },
                      "employer_id": {
                          "type": "string",
                          "description": "Employer identification number."
                      }
                  }
              },
              "box_13": {
                  "type": "object",
                  "properties": {
                      "statutory_employee": {
                          "type": "boolean",
                          "description": "Indicates if the employee is a statutory employee."
                      },
                      "third_party_sick_pay": {
                          "type": "boolean",
                          "description": "Indicates if the employee received third-party sick pay."
                      },
                      "retirement_plan": {
                          "type": "boolean",
                          "description": "Indicates if the employee is part of a retirement plan."
                      }
                  }
              },
              "box_12": {
                  "type": "array",
                  "description": "Box 12 items, including codes and amounts."
              },
              "state": {
                  "type": "string",
                  "description": "State code for state wages and taxes."
              },
              "box_9": {
                  "type": "string",
                  "description": "Verification code for employment-based verification."
              },
              "dependent_care_benefits": {
                  "type": "string",
                  "description": "Dependent care benefits provided by the employer."
              },
              "box_14_other": {
                  "type": "string",
                  "description": "Other amounts reported in Box 14."
              },
              "record_year": {
                  "type": "integer",
                  "description": "Year for which the record is applicable."
              },
              "state_wages_tips": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of state wages and tips."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "wages_tips_other_comp": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of wages, tips, and other compensation."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "nonqualified_plans": {
                  "type": "string",
                  "description": "Nonqualified plans amount."
              },
              "social_security_wages": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of wages subject to Social Security tax."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "social_security_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of Social Security tax withheld."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "locality_name": {
                  "type": "string",
                  "description": "Name of the locality for local wages and taxes."
              },
              "medicare_wages_and_tips": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "description": "Amount of wages and tips subject to Medicare tax."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "employer_state_id_number": {
                  "type": "string",
                  "description": "Employer's state identification number."
              },
              "state_income_tax": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "integer",
                          "description": "Amount of state income tax withheld."
                      },
                      "currency": {
                          "type": "string",
                          "description": "Currency of the amount."
                      }
                  }
              },
              "local_income_tax": {
                  "type": "string",
                  "description": "Amount of local income tax withheld."
              }
          }
      }

      /%}
  - name: M1_1099_RECORD
    x-displayName: M1_1099_RECORD
    description: >
      ---

      title: M1_1099_RECORD 

      description: The M1_1099_RECORD Schema represents the details of a 1099
      tax form, which reports income such as nonemployee compensation, rents,
      royalties, and other types of income. It includes information about the
      payer and recipient (e.g., names, addresses, and tax identification
      numbers), income amounts, and any federal or state tax withholdings. This
      schema is used for tax reporting purposes.

      ---


      The M1_1099_RECORD Schema represents the details of a 1099 tax form, which
      reports income such as nonemployee compensation, rents, royalties, and
      other types of income. It includes information about the payer and
      recipient (e.g., names, addresses, and tax identification numbers), income
      amounts, and any federal or state tax withholdings. This schema is used
      for tax reporting purposes.


      {% json-schema
              schema={
          "title": "M1_1099_RECORD schema",
          "type": "object",
          "description": "Representation of the 1099 Tax records\n",
          "properties": {
              "record_year": {
                  "type": "number",
                  "description": "Year on which the record was generated",
                  "format": "YYYY",
                  "examples": [
                      2024
                  ]
              },
              "record_date": {
                  "type": "string",
                  "description": "Date on which the record was generated",
                  "format": "MM/DD/YYYY"
              },
              "document_id": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "account_number": {
                  "type": "string",
                  "description": "Account Number as presented on the datasource"
              },
              "fatca_filing_requirement": {
                  "type": "boolean",
                  "description": "Used to show FATCA filing requirement value"
              },
              "void": {
                  "type": "boolean",
                  "description": "Marks the form as void"
              },
              "corrected": {
                  "type": "boolean",
                  "description": "Marks the form as corrected"
              },
              "recipient": {
                  "type": "object",
                  "description": "Details of the recipient",
                  "properties": {
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the recipient"
                      },
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "string",
                                          "examples": [
                                              "string"
                                          ]
                                      },
                                      "name": {
                                          "type": "string",
                                          "examples": [
                                              "string"
                                          ]
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "addr1": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "city": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "state": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "gender": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "prefix": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "date_of_birth": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "last_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "middle_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "suffix": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "ssn": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "marital_status": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "full_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "nationality": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "phone_number": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "first_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "email": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "payer": {
                  "type": "object",
                  "description": "Details of the payer",
                  "properties": {
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the payer"
                      },
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "null"
                                      },
                                      "name": {
                                          "type": "null"
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "addr1": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "city": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "state": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "phone_number": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "form_1099_div": {
                  "type": "object",
                  "properties": {
                      "transactions": {
                          "type": "array",
                          "items": {
          "title": "M1_FORM_1099_DIV Schema",
          "type": "object",
          "description": "Representation of the 1099 DIV \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "total_ordinary_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "asset_details": {
                  "type": "object",
                  "description": "Details of the asset",
                  "properties": {
                      "description": {
                          "type": "string",
                          "description": "Description of property"
                      },
                      "cusip": {
                          "type": "string",
                          "description": "CUSIP number"
                      },
                      "pay_date": {
                          "type": "string",
                          "description": "Pay date of the transaction"
                      }
                  }
              },
              "qualified_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "total_capital_gain_distribution": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "unrecap_sec_1250_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_1202_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "collection_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_897_ordinary_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_897_capital_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "non_dividend_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "section_199A_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_tax_paid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_country_or_us_possession": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "cash_liquidation_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "noncash_liquidation_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "exempt_interest_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "specified_private_activity_bond_interest_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                      },
                      "totals": {
          "title": "M1_FORM_1099_DIV Schema",
          "type": "object",
          "description": "Representation of the 1099 DIV \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "total_ordinary_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "asset_details": {
                  "type": "object",
                  "description": "Details of the asset",
                  "properties": {
                      "description": {
                          "type": "string",
                          "description": "Description of property"
                      },
                      "cusip": {
                          "type": "string",
                          "description": "CUSIP number"
                      },
                      "pay_date": {
                          "type": "string",
                          "description": "Pay date of the transaction"
                      }
                  }
              },
              "qualified_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "total_capital_gain_distribution": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "unrecap_sec_1250_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_1202_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "collection_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_897_ordinary_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "sec_897_capital_gain": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "non_dividend_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "section_199A_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_tax_paid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_country_or_us_possession": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "cash_liquidation_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "noncash_liquidation_distributions": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "exempt_interest_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "specified_private_activity_bond_interest_dividends": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                  }
              },
              "form_1099_int": {
                  "type": "object",
                  "properties": {
                      "transactions": {
                          "type": "array",
                          "items": {
          "title": "M1_FORM_1099_INT Schema",
          "type": "object",
          "description": "Representation of the 1099 INT \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "interest_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "asset_details": {
                  "type": "object",
                  "description": "Details of the asset",
                  "properties": {
                      "description": {
                          "type": "string",
                          "description": "Description of property"
                      },
                      "cusip": {
                          "type": "string",
                          "description": "CUSIP number"
                      },
                      "pay_date": {
                          "type": "string",
                          "description": "Pay date of the transaction"
                      }
                  }
              },
              "early_withdrawal_penalty": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "interest_on_us_savings_bonds_and_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_tax_paid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_country_or_us_territory": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "tax_exempt_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "specified_private_activity_bond_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "market_discount": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium_on_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium_on_tax_exempt_bond": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "tax_exempt_and_tax_credit_bond_cusip_no": {
                  "type": "number",
                  "examples": [
                      0
                  ]
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                      },
                      "totals": {
          "title": "M1_FORM_1099_INT Schema",
          "type": "object",
          "description": "Representation of the 1099 INT \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "interest_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "asset_details": {
                  "type": "object",
                  "description": "Details of the asset",
                  "properties": {
                      "description": {
                          "type": "string",
                          "description": "Description of property"
                      },
                      "cusip": {
                          "type": "string",
                          "description": "CUSIP number"
                      },
                      "pay_date": {
                          "type": "string",
                          "description": "Pay date of the transaction"
                      }
                  }
              },
              "early_withdrawal_penalty": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "interest_on_us_savings_bonds_and_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_tax_paid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "foreign_country_or_us_territory": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "tax_exempt_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "specified_private_activity_bond_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "market_discount": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium_on_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium_on_tax_exempt_bond": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "tax_exempt_and_tax_credit_bond_cusip_no": {
                  "type": "number",
                  "examples": [
                      0
                  ]
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                  }
              },
              "form_1099_misc": {
                  "type": "object",
                  "properties": {
                      "transactions": {
                          "type": "array",
                          "items": {
          "title": "M1_FORM_1099_MISC Schema",
          "type": "object",
          "description": "Representation of the 1099 MISC \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "rents": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "royalties": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "other_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "fishing_boat_proceeds": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "medical_and_health_care_payments": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "payer_made_direct_sales": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "substitute_payments_in_lieu_of_dividends_or_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "crop_insurance_proceeds": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "gross_proceeds_paid_to_an_attorney": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "fish_purchased_for_resale": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "section_409a_deferrals": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "excess_golden_parachute_payments": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "nonqualified_deferred_compensation": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              }
          }
      }
                      },
                      "totals": {
          "title": "M1_FORM_1099_MISC Schema",
          "type": "object",
          "description": "Representation of the 1099 MISC \n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "rents": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "royalties": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "other_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "fishing_boat_proceeds": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "medical_and_health_care_payments": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "payer_made_direct_sales": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "substitute_payments_in_lieu_of_dividends_or_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "crop_insurance_proceeds": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "gross_proceeds_paid_to_an_attorney": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "fish_purchased_for_resale": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "section_409a_deferrals": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "excess_golden_parachute_payments": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "nonqualified_deferred_compensation": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state_income": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              }
          }
      }
                  }
              },
        "form_1099_nec": {
          "type": "object",
          "properties": {
            "transactions": {
              "type": "array",
              "items": {
                "title": "M1_FORM_1099_NEC Schema",
                "type": "object",
                "description": "Representation of the 1099 NEC",
                "properties": {
                  "second_tin_not": {
                    "type": "boolean"
                  },
                  "non_employee_compensation": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "enum": ["USD"],
                        "description": "Currency"
                      },
                      "value": {
                        "type": "number",
                        "description": "Amount"
                      }
                    }
                  },
                  "payer_made_direct_sales": {
                    "type": "boolean"
                  },
                  "excess_golden_parachute_payments": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "enum": ["USD"],
                        "description": "Currency"
                      },
                      "value": {
                        "type": "number",
                        "description": "Amount"
                      }
                    }
                  },
                  "federal_income_tax_withheld": {
                    "type": "object",
                    "description": "Federal income tax withheld",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "enum": ["USD"],
                        "description": "Currency"
                      },
                      "value": {
                        "type": "number",
                        "description": "Amount"
                      }
                    }
                  },
                  "state_tax_withheld": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "enum": ["USD"],
                        "description": "Currency"
                      },
                      "value": {
                        "type": "number",
                        "description": "Amount"
                      }
                    }
                  },
                  "state_no": {
                    "type": "string"
                  },
                  "state_income": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "enum": ["USD"],
                        "description": "Currency"
                      },
                      "value": {
                        "type": "number",
                        "description": "Amount"
                      }
                    }
                  }
                }
              }
            },
            "totals": {
              "type": "object",
              "title": "M1_FORM_1099_NEC Schema",
              "description": "Representation of the 1099 NEC",
              "properties": {
                "second_tin_not": {
                  "type": "boolean"
                },
                "non_employee_compensation": {
                  "type": "object",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "enum": ["USD"],
                      "description": "Currency"
                    },
                    "value": {
                      "type": "number",
                      "description": "Amount"
                    }
                  }
                },
                "payer_made_direct_sales": {
                  "type": "boolean"
                },
                "excess_golden_parachute_payments": {
                  "type": "object",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "enum": ["USD"],
                      "description": "Currency"
                    },
                    "value": {
                      "type": "number",
                      "description": "Amount"
                    }
                  }
                },
                "federal_income_tax_withheld": {
                  "type": "object",
                  "description": "Federal income tax withheld",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "enum": ["USD"],
                      "description": "Currency"
                    },
                    "value": {
                      "type": "number",
                      "description": "Amount"
                    }
                  }
                },
                "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "enum": ["USD"],
                      "description": "Currency"
                    },
                    "value": {
                      "type": "number",
                      "description": "Amount"
                    }
                  }
                },
                "state_no": {
                  "type": "string"
                },
                "state_income": {
                  "type": "object",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "enum": ["USD"],
                      "description": "Currency"
                    },
                    "value": {
                      "type": "number",
                      "description": "Amount"
                    }
                  }
                }
              }
            }
          }
        },
              "form_1099_oid": {
                  "type": "object",
                  "properties": {
                      "transactions": {
                          "type": "array",
                          "items": {
          "title": "M1_FORM_1099_OID Schema",
          "type": "object",
          "description": "Representation of the 1099 OID\n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "original_issue_discount_for_the_year": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "other_periodic_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "early_withdrawal_penalty": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "market_discount": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "acquisition_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "description": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "original_issue_discount_on_us_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "tax-exempt_oid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                      },
                      "totals": {
          "title": "M1_FORM_1099_OID Schema",
          "type": "object",
          "description": "Representation of the 1099 OID\n",
          "properties": {
              "second_tin_not": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "original_issue_discount_for_the_year": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "other_periodic_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "early_withdrawal_penalty": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "federal_income_tax_withheld": {
                  "description": "Federal income tax withheld",
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "market_discount": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "acquisition_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "description": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "original_issue_discount_on_us_treasury_obligations": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "investment_expenses": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "bond_premium": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "tax-exempt_oid": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_tax_withheld": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "state_no": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "state": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
                  }
              },
              "form_1099_B": {
          "title": "M1_FORM_1099_B Schema",
          "type": "object",
          "description": "Representation of the 1099 B \n",
          "properties": {
              "transactions": {
                  "type": "array",
                  "description": "List of transactions",
                  "items": {
                      "properties": {
                          "cusip": {
                              "type": "string",
                              "description": "CUSIP number"
                          },
                          "second_tin_not": {
                              "type": "boolean",
                              "examples": [
                                  false
                              ]
                          },
                          "gain_type": {
                              "type": "string",
                              "enum": [
                                  "SHORT_TERM",
                                  "LONG_TERM"
                              ],
                              "description": "Type of the gain"
                          },
                          "quantity_sold": {
                              "type": "number",
                              "description": "Quantity sold"
                          },
                          "asset_details": {
                              "type": "object",
                              "description": "Details of the asset",
                              "properties": {
                                  "type": {
                                      "type": "string",
                                      "enum": [
                                          "SECURITY",
                                          "CRYPTO",
                                          "REAL_ESTATE",
                                          "OTHER"
                                      ],
                                      "description": "Type of asset"
                                  },
                                  "description": {
                                      "type": "string",
                                      "description": "Description of property"
                                  },
                                  "cusip": {
                                      "type": "string",
                                      "description": "CUSIP number"
                                  },
                                  "ticker": {
                                      "type": "string",
                                      "description": "Ticker"
                                  }
                              }
                          },
                          "acquired_date": {
                              "type": "number",
                              "description": "Date acquired"
                          },
                          "sell_date": {
                              "type": "number",
                              "description": "Date sold or disposed"
                          },
                          "proceeds": {
                              "type": "object",
                              "description": "Proceeds",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of the proceed"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "value of the proceed"
                                  }
                              }
                          },
                          "cost": {
                              "type": "object",
                              "description": "Cost or other Basis",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of the cost"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Value of cost or basis"
                                  }
                              }
                          },
                          "accrued_market_discount": {
                              "type": "object",
                              "description": "Accrued Market Discount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of accrued market discount"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Value"
                                  }
                              }
                          },
                          "wash_sale_disallowed": {
                              "type": "object",
                              "description": "Wash Sale disallowed amount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Wash Sale Loss Disallowed Value"
                                  }
                              }
                          },
                          "gain": {
                              "type": "object",
                              "description": "gain Amount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "gain Amount"
                                  }
                              }
                          },
                          "additional_information": {
                              "type": "string",
                              "description": "Additional Information"
                          },
                          "proceed_type": {
                              "type": "string",
                              "enum": [
                                  "GROSS",
                                  "NET"
                              ]
                          },
                          "basis_reported_to_irs": {
                              "type": "boolean",
                              "description": "Basis Reported to the IRS"
                          },
                          "non_covered_security": {
                              "type": "boolean",
                              "description": "Covered/Non-covered Security (Box 5)"
                          }
                      }
                  }
              },
              "totals": {
                  "type": "object",
                  "description": "Realized gain totals",
                  "properties": {
                      "short_term_gains": {
                          "type": "object",
                          "description": "Total short term realized gains",
                          "properties": {
                              "proceeds": {
                                  "type": "object",
                                  "description": "Proceeds",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Proceeds Value"
                                      }
                                  }
                              },
                              "cost": {
                                  "type": "object",
                                  "description": "Cost basis",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Cost basis value"
                                      }
                                  }
                              },
                              "accrued_market_discount": {
                                  "type": "object",
                                  "description": "Accrued Market Discount",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Accrued Market Discount Value"
                                      }
                                  }
                              },
                              "wash_sale_disallowed": {
                                  "type": "object",
                                  "description": "Wash Sale Loss Disallowed",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Wash Sale Loss Disallowed Value"
                                      }
                                  }
                              },
                              "gain": {
                                  "type": "object",
                                  "description": "Realized gain",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Realized gain value. The number will be negative incase if loss"
                                      }
                                  }
                              }
                          }
                      },
                      "long_term_gains": {
                          "type": "object",
                          "description": "Total long term realized gains",
                          "properties": {
                              "proceeds": {
                                  "type": "object",
                                  "description": "Proceeds",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Proceeds Value"
                                      }
                                  }
                              },
                              "cost": {
                                  "type": "object",
                                  "description": "Cost basis",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Cost basis value"
                                      }
                                  }
                              },
                              "accrued_market_discount": {
                                  "type": "object",
                                  "description": "Accrued Market Discount",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Accrued Market Discount Value"
                                      }
                                  }
                              },
                              "wash_sale_disallowed": {
                                  "type": "object",
                                  "description": "Wash Sale Loss Disallowed",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Wash Sale Loss Disallowed Value"
                                      }
                                  }
                              },
                              "gain": {
                                  "type": "object",
                                  "description": "Realized gain",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Realized gain value. The number will be negative incase if loss"
                                      }
                                  }
                              }
                          }
                      }
                  }
              }
          }
      }
          }

              }
      /%}
  - name: M1_FORM_1098_MORTGAGE_INTEREST
    x-displayName: M1_FORM_1098_MORTGAGE_INTEREST
    description: >
      ---

      title: M1_FORM_1098_MORTGAGE_INTEREST 

      description: The M1_FORM_1098_MORTGAGE_INTEREST schema represents the
      details of a 1098 tax form, which reports mortgage interest paid by a
      taxpayer. It includes information about the borrower, lender, and the
      amount of interest paid on the mortgage.

      ---


      The M1_FORM_1098_MORTGAGE_INTEREST schema represents the details of a 1098
      tax form, which reports mortgage interest paid by a taxpayer. It includes
      information about the borrower, lender, and the amount of interest paid on
      the mortgage.


      {% json-schema
              schema={
          "title": "M1_1098_RECORD Schema",
          "type": "object",
          "description": "Representation of the 1098 MORTGAGE_INTEREST\n",
          "properties": {
              "record_year": {
                  "type": "number",
                  "description": "Year on which the record was generated",
                  "format": "YYYY",
                  "examples": [
                      2024
                  ]
              },
              "record_date": {
                  "type": "string",
                  "description": "Date on which the record was generated",
                  "format": "MM/DD/YYYY"
              },
              "void": {
                  "type": "boolean",
                  "description": "Marks the form as void"
              },
              "corrected": {
                  "type": "boolean",
                  "description": "Marks the form as corrected"
              },
              "recipient": {
                  "type": "object",
                  "description": "Details of the recipient",
                  "properties": {
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the payer"
                      },
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "null"
                                      },
                                      "name": {
                                          "type": "null"
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "addr1": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "city": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "state": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "phone_number": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "payer": {
                  "type": "object",
                  "description": "Details of the payer",
                  "properties": {
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the recipient"
                      },
                      "address": {
                          "type": "object",
                          "properties": {
                              "zipcode": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "country": {
                                  "type": "object",
                                  "properties": {
                                      "a2_code": {
                                          "type": "string",
                                          "examples": [
                                              "string"
                                          ]
                                      },
                                      "name": {
                                          "type": "string",
                                          "examples": [
                                              "string"
                                          ]
                                      }
                                  }
                              },
                              "addr2": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "addr1": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "city": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "state": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "gender": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "prefix": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "date_of_birth": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "last_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "middle_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "suffix": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "ssn": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "marital_status": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "full_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "nationality": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "phone_number": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "first_name": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "email": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "account_number": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "transactions": {
                  "type": "array",
                  "items": {
          "title": "M1_FORM_1098 Schema",
          "type": "object",
          "description": "Representation of the 1098\n",
          "properties": {
              "mortgage_interest_received": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "outstanding_mortgage_principal": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "mortgage_origination_date": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "refund_of_overpaid_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "mortgage_insurance_premiums": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "points_paid_on_purchase_of_principal_residence": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "address_of_property_same_as_payers": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "property_address": {
                  "type": "object",
                  "properties": {
                      "zipcode": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "country": {
                          "type": "object",
                          "properties": {
                              "a2_code": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "name": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "addr2": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "addr1": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "city": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "state": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "number_of_properties_securing_the_mortgage": {
                  "type": "number",
                  "examples": [
                      0
                  ]
              },
              "other": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "examples": [
                              0
                          ]
                      },
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      }
                  }
              },
              "mortgage_acquisition_date": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
              },
              "totals": {
          "title": "M1_FORM_1098 Schema",
          "type": "object",
          "description": "Representation of the 1098\n",
          "properties": {
              "mortgage_interest_received": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "outstanding_mortgage_principal": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "mortgage_origination_date": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              },
              "refund_of_overpaid_interest": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "mortgage_insurance_premiums": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "points_paid_on_purchase_of_principal_residence": {
                  "type": "object",
                  "properties": {
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      },
                      "value": {
                          "type": "number",
                          "description": "Amount"
                      }
                  }
              },
              "address_of_property_same_as_payers": {
                  "type": "boolean",
                  "examples": [
                      false
                  ]
              },
              "property_address": {
                  "type": "object",
                  "properties": {
                      "zipcode": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "country": {
                          "type": "object",
                          "properties": {
                              "a2_code": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              },
                              "name": {
                                  "type": "string",
                                  "examples": [
                                      "string"
                                  ]
                              }
                          }
                      },
                      "addr2": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "addr1": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "city": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      },
                      "state": {
                          "type": "string",
                          "examples": [
                              "string"
                          ]
                      }
                  }
              },
              "number_of_properties_securing_the_mortgage": {
                  "type": "number",
                  "examples": [
                      0
                  ]
              },
              "other": {
                  "type": "object",
                  "properties": {
                      "amount": {
                          "type": "number",
                          "examples": [
                              0
                          ]
                      },
                      "currency": {
                          "type": "string",
                          "enum": [
                              "USD"
                          ],
                          "description": "Currency"
                      }
                  }
              },
              "mortgage_acquisition_date": {
                  "type": "string",
                  "examples": [
                      "string"
                  ]
              }
          }
      }
          }
      }

      /%}
  - name: M1_PROCEEDS_1099_B
    x-displayName: M1_PROCEEDS_1099_B
    description: >-
      ---

      title: M1_PROCEEDS_1099_B 

      description: This  schema represents the details of a 1099-B tax form,
      which reports proceeds from broker and barter exchange transactions. It
      includes information about the seller, the broker, the type of securities
      sold, the sale amount, and any associated gains or losses for tax
      reporting. coverage details, premium amounts, beneficiaries, claims
      history, and insurer information.

      ---

      This  schema represents the details of a 1099-B tax form, which reports
      proceeds from broker and barter exchange transactions. It includes
      information about the seller, the broker, the type of securities sold, the
      sale amount, and any associated gains or losses for tax reporting.
      coverage details, premium amounts, beneficiaries, claims history, and
      insurer information. 


      {% json-schema
              schema={
          "title": "M1_Realized gains Schema",
          "type": "object",
          "description": "Representation of the 1099 B\n",
          "properties": {
              "as_of_date": {
                  "type": "number",
                  "description": "timestamp when this record was generated"
              },
              "account_number": {
                  "type": "string",
                  "description": "Account Number as presented on the datasource"
              },
              "recipient": {
                  "type": "object",
                  "description": "Details of the recipient",
                  "properties": {
                      "name": {
                          "type": "string",
                          "description": "Name of the recipient"
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the recipient"
                      },
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the recipient"
                      },
                      "address": {
                          "type": "object",
                          "description": "Address of the recipient",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode"
                              },
                              "country": {
                                  "type": "object",
                                  "description": "Country details",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Country name"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code of country"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "payer": {
                  "type": "object",
                  "description": "Details of the payer",
                  "properties": {
                      "tin": {
                          "type": "string",
                          "description": "Tax identification number of the payer"
                      },
                      "name": {
                          "type": "string",
                          "description": "Name of the payer"
                      },
                      "phone_number": {
                          "type": "string",
                          "description": "Phone number of the payer"
                      },
                      "address": {
                          "type": "object",
                          "description": "Address of the payer",
                          "properties": {
                              "addr1": {
                                  "type": "string",
                                  "description": "Address Line 1"
                              },
                              "addr2": {
                                  "type": "string",
                                  "description": "Address Line 2"
                              },
                              "city": {
                                  "type": "string",
                                  "description": "City"
                              },
                              "state": {
                                  "type": "string",
                                  "description": "State"
                              },
                              "zipcode": {
                                  "type": "string",
                                  "description": "Zipcode"
                              },
                              "country": {
                                  "type": "object",
                                  "description": "Country details",
                                  "properties": {
                                      "name": {
                                          "type": "string",
                                          "description": "Country name"
                                      },
                                      "a2_code": {
                                          "type": "string",
                                          "description": "Alpha-2 code of country"
                                      }
                                  }
                              }
                          }
                      }
                  }
              },
              "transactions": {
                  "type": "array",
                  "description": "List of transactions",
                  "items": {
                      "properties": {
                          "gain_type": {
                              "type": "string",
                              "enum": [
                                  "SHORT_TERM",
                                  "LONG_TERM"
                              ],
                              "description": "Type of the gain"
                          },
                          "quantity_sold": {
                              "type": "number",
                              "description": "Quantity sold"
                          },
                          "asset_details": {
                              "type": "object",
                              "description": "Details of the asset",
                              "properties": {
                                  "type": {
                                      "type": "string",
                                      "enum": [
                                          "SECURITY",
                                          "CRYPTO",
                                          "REAL_ESTATE",
                                          "OTHER"
                                      ],
                                      "description": "Type of asset"
                                  },
                                  "description": {
                                      "type": "string",
                                      "description": "Description of property"
                                  },
                                  "cusip": {
                                      "type": "string",
                                      "description": "CUSIP number"
                                  },
                                  "ticker": {
                                      "type": "string",
                                      "description": "Ticker"
                                  }
                              }
                          },
                          "acquired_date": {
                              "type": "number",
                              "description": "Date acquired"
                          },
                          "sell_date": {
                              "type": "number",
                              "description": "Date sold or disposed"
                          },
                          "proceeds": {
                              "type": "object",
                              "description": "Proceeds",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of the proceed"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "value of the proceed"
                                  }
                              }
                          },
                          "cost": {
                              "type": "object",
                              "description": "Cost or other Basis",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of the cost"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Value of cost or basis"
                                  }
                              }
                          },
                          "accrued_market_discount": {
                              "type": "object",
                              "description": "Accrued Market Discount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency of accrued market discount"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Value"
                                  }
                              }
                          },
                          "wash_sale_disallowed": {
                              "type": "object",
                              "description": "Wash Sale disallowed amount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "Wash Sale Loss Disallowed Value"
                                  }
                              }
                          },
                          "gain": {
                              "type": "object",
                              "description": "gain Amount",
                              "properties": {
                                  "currency": {
                                      "type": "string",
                                      "enum": [
                                          "USD",
                                          "INR"
                                      ],
                                      "description": "Currency"
                                  },
                                  "value": {
                                      "type": "number",
                                      "description": "gain Amount"
                                  }
                              }
                          },
                          "additional_information": {
                              "type": "string",
                              "description": "Additional Information"
                          },
                          "proceed_type": {
                              "type": "string",
                              "enum": [
                                  "GROSS",
                                  "NET"
                              ]
                          },
                          "basis_reported_to_irs": {
                              "type": "boolean",
                              "description": "Basis Reported to the IRS"
                          },
                          "non_covered_security": {
                              "type": "boolean",
                              "description": "Covered/Non-covered Security (Box 5)"
                          }
                      }
                  }
              },
              "totals": {
                  "type": "object",
                  "description": "Realized gain totals",
                  "properties": {
                      "short_term_gains": {
                          "type": "object",
                          "description": "Total short term realized gains",
                          "properties": {
                              "proceeds": {
                                  "type": "object",
                                  "description": "Proceeds",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Proceeds Value"
                                      }
                                  }
                              },
                              "cost": {
                                  "type": "object",
                                  "description": "Cost basis",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Cost basis value"
                                      }
                                  }
                              },
                              "accrued_market_discount": {
                                  "type": "object",
                                  "description": "Accrued Market Discount",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Accrued Market Discount Value"
                                      }
                                  }
                              },
                              "wash_sale_disallowed": {
                                  "type": "object",
                                  "description": "Wash Sale Loss Disallowed",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Wash Sale Loss Disallowed Value"
                                      }
                                  }
                              },
                              "gain": {
                                  "type": "object",
                                  "description": "Realized gain",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Realized gain value. The number will be negative incase if loss"
                                      }
                                  }
                              }
                          }
                      },
                      "long_term_gains": {
                          "type": "object",
                          "description": "Total long term realized gains",
                          "properties": {
                              "proceeds": {
                                  "type": "object",
                                  "description": "Proceeds",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Proceeds Value"
                                      }
                                  }
                              },
                              "cost": {
                                  "type": "object",
                                  "description": "Cost basis",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Cost basis value"
                                      }
                                  }
                              },
                              "accrued_market_discount": {
                                  "type": "object",
                                  "description": "Accrued Market Discount",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Accrued Market Discount Value"
                                      }
                                  }
                              },
                              "wash_sale_disallowed": {
                                  "type": "object",
                                  "description": "Wash Sale Loss Disallowed",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Wash Sale Loss Disallowed Value"
                                      }
                                  }
                              },
                              "gain": {
                                  "type": "object",
                                  "description": "Realized gain",
                                  "properties": {
                                      "currency": {
                                          "type": "string",
                                          "enum": [
                                              "USD",
                                              "INR"
                                          ],
                                          "description": "Currency"
                                      },
                                      "value": {
                                          "type": "number",
                                          "description": "Realized gain value. The number will be negative incase if loss"
                                      }
                                  }
                              }
                          }
                      }
                  }
              }
          }
      }

      /%}
x-tagGroups:
  - name: Getting Started
    tags:
      - API Host and Protocols
      - API Keys and Access
      - Versioning
      - Endpoints
      - CheckSignalsIntroduction
      - Status Codes
      - AsynchronousCommunication
  - name: Resources
    tags:
      - Individuals
      - Data Requests
      - Datasources
      - Items
      - Invitations
      - ExperiencesV3
      - ComplianceV3
  - name: Services
    tags:
      - Education
      - Income & Employment
      - Insurance
      - Tax Records
  - name: Webhooks
    tags:
      - webhooks
      - responding_to_webhooks
      - webhook_security
  - name: data_types
    x-displayName: Data Types
    tags:
      - M1_ACADEMIC_RECORD
      - M1_DIGEST
      - M1_INCOME_EMPLOYMENT_RECORD
      - M1_INSURANCE_RECORD
      - M1_AUTO_INSURANCE_CLAIM_RECORD
      - M1_STUDENT_ID_RECORD
      - M1_W2_RECORD
      - M1_1099_RECORD
      - M1_FORM_1098_MORTGAGE_INTEREST
      - M1_PROCEEDS_1099_B
    description: >
      Data Types are used to represent the data that is returned by the API.
      MeasureOne standardizes the data types to ensure that the data is
      consistent and can be used across different applications.
paths:
  /v3/invitations/new:
    post:
      security:
        - Bearer: []
      operationId: new_invitation
      tags:
        - Invitations
      deprecated: true
      summary: Create a new Invitation
      description: >
        Creates a new invitation. This API is deprecated. Use
        `/datarequests/generate_link` and `/datarequests/notify_user` to create
        an invitation
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Invitation'
                - $ref: '#/components/schemas/InvitationWithDatasource'
            examples:
              With_Institution_name:
                $ref: '#/components/examples/v3@invitations@new'
              With_Datasource:
                $ref: '#/components/examples/v3@invitationsWithDatasource@new'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: MeasureOne recognized Unique ID of the Invitation
                    example: 1faOM8Q4efEWIjzdE2SBM2kLq4O
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Invalid Individual ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/invitations/get:
    post:
      security:
        - Bearer: []
      operationId: invitations_get
      tags:
        - Invitations
      deprecated: true
      summary: Get the list of invitations
      description: >
        Get the list of invitations based on the filter criteria provided. This
        API is deprecated. Use `/datarequests/get`
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  properties:
                    status:
                      type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Invitation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/invitations/get_by_id:
    post:
      security:
        - Bearer: []
      operationId: invitation_get_by_id
      tags:
        - Invitations
      summary: Get details of an Invitation
      deprecated: true
      description: >
        Get the details of an Invitation. The endpoint will return an error
        response if the Invitation is not found. This API is deprecated. Use
        `/datarequests/get_by_id`
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: MeasureOne recognized Unique ID of the Invitation
                  example: 1faOM8Q4efEWIjzdE2SBM2kLq4O
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/InvitationWithDatasource'
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@invitations@get_by_id'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Invalid Invitation ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/invitations/expire:
    post:
      security:
        - Bearer: []
      operationId: invitations_delete
      tags:
        - Invitations
      summary: Expire an Invitation
      deprecated: true
      description: >
        Expire an Invitation. The Invitation can be expired only if it has not
        yet been `EXPIRED`. An attempt to expire an invitation that is already
        expired will return an error. This API is deprecated. Use
        `/datarequests/expire_invitation_link`
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: MeasureOne recognized Unique ID of the Invitation
                  example: 1faOM8Q4efEWIjzdE2SBM2kLq4O
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Invalid Invitation ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Error_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/individuals/new:
    post:
      security:
        - Bearer: []
      tags:
        - Individuals
      summary: Create a new Individual
      description: >
        Creates a new Individual.  The returned ID is then used in subsequent
        API calls to reference Items and Services.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Individual'
            examples:
              Adding_new_individual:
                $ref: '#/components/examples/v3@individuals@new'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: individual_id
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@individuals@new-2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/individuals/get_by_id:
    post:
      security:
        - Bearer: []
      tags:
        - Individuals
      summary: Get details of an Individual
      description: |
        Retrieve the details of the given Individual.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
            examples:
              Get_By_ID:
                $ref: '#/components/examples/v3@individuals@get_by_id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Individual'
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@individuals@get_by_id-2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Individual_Not_found:
                  $ref: '#/components/examples/v3@errors@404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Server_Error:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/individuals/get_items:
    post:
      security:
        - Bearer: []
      tags:
        - Individuals
      summary: Get Items for an individual
      description: Retrieve the list of items created for an Individual
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - individual
              oneOf:
                - $ref: '#/components/schemas/IndividualParent'
                - $ref: '#/components/schemas/DataRequest'
            examples:
              Get_Items_request_with_individual_id:
                $ref: '#/components/examples/v3@individuals@get_items'
              Get_Items_request_with_datarequest_id:
                $ref: >-
                  #/components/examples/v3@services@get_transaction_by_datarequest_id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    description: Individual details
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne.
                      datasources:
                        type: array
                        description: Array of datasources for which the items were fetched
                  datarequest_id:
                    type: string
                    description: Unique ID of the Datarequest identified by MeasureOne.
                  items:
                    type: array
                    description: List of items for an Individual
                    items:
                      properties:
                        id:
                          type: string
                          description: >-
                            Unique ID of the item identified by MeasureOne. Use
                            this id in  `item/get_by_id` to get the details
                        source_data_type:
                          type: string
                          description: Source data type of the item
                        datarequest_id:
                          type: string
                          description: >-
                            Unique ID of the Datarequest identified by
                            MeasureOne.
                        created_at:
                          type: number
                          description: Timestamp at which the Item was created
                        updated_at:
                          type: number
                          description: Timestamp at which the Item was last updated
                        duplicates:
                          type: array
                          description: >-
                            List of item IDs which are duplicate of an item in a
                            datarequest
                          items:
                            type: string
                        refresh_id:
                          type: string
                          description: >-
                            Unique ID of a scheduled refresh identified by
                            MeasureOne
              examples:
                Successful_Response_when_call_with_individual:
                  $ref: '#/components/examples/v3@individuals@get_items-2'
                Successful_Response_when_call_with_datarequest_id:
                  $ref: >-
                    #/components/examples/v3@individuals@get_items_datarequest_id
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                When_Individual_is_not_found:
                  $ref: '#/components/examples/v3@errors@404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/items/new:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Submit a new item
      description: |
        ### Usage options 
          The usage of `/v3/items/new` varies depending on its intended use and availability of information. The request payload must include either a `source_data_value` object **OR** a `source_data_reference` object. Passing both as a part of the payload may result in processing errors.

          #### Using Source Data Object
          If the attribute values for a transcript are known, send the source data inline in the request using the `source_data_value` object. 

          #### Using Source Data Reference Object

          If the data is in a document, upload it using the [`/items/upload`](#upload-item-data) endpoint or make it available at a remote location. A reference to the uploaded document should then be included in the request using the `source_data_reference` object. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Item'
            examples:
              Submitting_M1_DIGEST_as_Digital_Payload:
                $ref: '#/components/examples/v3@item@new@m1digest_digital_payload'
              Submitting_M1_TRANSCRIPT_as_Digital_Payload:
                $ref: >-
                  #/components/examples/v3@item@new@m1_transcript_digital_payload
              Submitting_Transcripts_as_uploaded_files:
                $ref: >-
                  #/components/examples/v3@item@new@m1_transcript_source_data_ref_remote
              Submitting_Transcripts_as_remote_files:
                $ref: >-
                  #/components/examples/v3@item@new@m1_transcript_source_data_ref
              Submitting_Student_ID_card:
                $ref: '#/components/examples/v3@item@new@student_id'
              Submitting_Insurance_card:
                $ref: '#/components/examples/v3@item@new@insurance_card'
      responses:
        '200':
          description: >-
            Successful Response. You can now call the end points to get desired
            information from a transcript.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the created record
                  individual_id:
                    type: string
                    description: Unique ID of the individual identified by MeasureOne
                  datarequest_id:
                    type: string
                    description: Unique ID of the datarequest identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - IN_PROGRESS
                      - COMPLETED
              examples:
                Successful_Response_when_processing_is_IN_PROGRESS:
                  $ref: '#/components/examples/v3@item@new'
                Successful_Response_when_processing_of_an_academic_record_is_COMPLETED:
                  $ref: '#/components/examples/v3@item@new_completed'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/items/upload:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Upload files
      description: >
        The /items/upload endpoint is used to upload documents containing source
        data for a new item. </br>

        *Supported File Types*: **HTML**, **JPG**, **PDF**, **PNG**, **TIFF**,
        **TIF**
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/form-data-upload:
            schema:
              $ref: '#/components/schemas/uploadfiles'
            examples:
              Uploading_files:
                $ref: '#/components/examples/v3@item@uploadfiles'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    id:
                      type: string
                      description: Unique ID of the document identified by MeasureOne
                    uri:
                      type: string
                      description: >-
                        URI scheme for a remote document. The supported schemes
                        include the M1 scheme, an internal scheme used to refer
                        to internal MeasureOne resources. See below for
                        examples. Supported Schemes are `M1`, `HTTP`, `HTTPS`,
                        `FTP`, `SFTP`.Format
                        scheme:[//authority]path[?query][#fragment]
                    file_name:
                      type: string
                      description: File name of uploaded document
                    created_at:
                      type: number
                      description: Timestamp at which the document was uploaded
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@item@upload'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655226381409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: UNSUPPORTED_MEDIA_TYPE
                  error_message:
                    type: string
                    description: Details of the error
                    example: Exceed Max File size of 10MB
                  http_code:
                    type: number
                    description: http response code
                    example: 415
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/items/get_by_id:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Get the details of item
      description: >
        Retrieves an existing Item data. The endpoint can be used once the
        `processing_status` for an Item is `COMPLETED`. It will return Item data
        in its response payload. If the processing of the Item is not yet
        complete, it will return the current status of the Item. This API is
        [asynchronous](#tag/AsynchronousCommunication). 


        The optional `data_confidence` object, if present, lists data attributes
        whose extraction accuracy was lower than 95%. Such a scenario can come
        up when processing images or other unstructured source data items. The
        attributes are specified as a json path within the corresponding data
        object. In the event that the `data_confidence` object is not present
        (i.e., null), the data extraction should be considered 100% accurate. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Item identified by MeasureOne
            examples:
              Get_transcript_by_id_for_TRANSCRIPT_FILE:
                $ref: '#/components/examples/v3@item@get_by_id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Item'
              examples:
                Successful_Response_when_processing_is_complete_for_college_TRANSCRIPT_FILE:
                  $ref: '#/components/examples/v3@item@get_by_id-2'
                Successful_Response_when_processing_is_complete_for_highschool_TRANSCRIPT_FILE:
                  $ref: '#/components/examples/v3@item@get_by_id_hs'
                Successful_Response_when_processing_is_complete_for_PAYSTUB_FILE:
                  $ref: '#/components/examples/v3@item@get_by_id_paystub_file'
                Successful_Response_when_processing_is_complete_for_INSURANCE_POLICY:
                  $ref: '#/components/examples/v3@item@get_by_id_insurance'
                Successful_Response_when_processing_is_complete_for_AUTO_INSURANCE_CLAIM:
                  $ref: '#/components/examples/v3@item@get_by_id_auto_insurance_claim'
                Get_transcript_by_id_for_M1_DIGEST:
                  $ref: '#/components/examples/v3@item@get_by_id_M1_DIGEST'
                Get_Student_id:
                  $ref: '#/components/examples/v3@item@get_by_id_Student_id'
                Successful_Response_when_processing_is_pending:
                  $ref: '#/components/examples/v3@item@get_by_id_pending'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The item can not be processed due to unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The item can not be processed due to unprocessable document quality.
                             |PARTIAL_DOCUMENT| The item can not be processed due to partial document.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            media_type:
                              type: string
                              description: >-
                                Media type of the source data document Supported
                                Types eg `application/pdf`, `application/json`,
                                `image/jpeg`, `image/png`, `image/tiff`,
                                `text/html`
                  http_code:
                    type: number
                    description: Error status code
              example:
                error_code: UNPROCESSABLE_ENTITY
                error_message: Item cannot be processed
                reason_codes:
                  - code: UNSUPPORTED_FORMAT
                    description: The item can not be processed due to unsupported format.
                    context:
                      media_type: image/jpeg
                timestamp: 1688121957400
                http_code: 422
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/items/get:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Get the list of Items
      description: >
        Get the list of items based on the filter criteria provided. If no
        filter criteria is provided, it will fetch the latest 200 items.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  description: Filters that can be applied to fetch the list of Items
                  properties:
                    id:
                      type: array
                      description: List of unique ID of the Item identified by MeasureOne
                      items:
                        type: string
                    individual_id:
                      type: string
                      description: Unique ID of the Individual identified by MeasureOne
                    datarequest_id:
                      type: string
                      description: Unique ID of the data request identified by MeasureOne
                    datasource_id:
                      type: array
                      description: >-
                        List of Data Sources for which you want to find the Data
                        Requests
                      items:
                        type: string
                    external_id:
                      type: string
                      description: >-
                        A customer generated unique identifier linked to the
                        Individual
                    source_data_type:
                      type: array
                      description: Source data type of an item
                      items:
                        type: string
                        enum:
                          - M1_ACADEMIC_RECORD
                          - M1_DIGEST
                          - TRANSCRIPT_FILE
                          - PAYSTUB_FILE
                          - W2_FILE
                          - INSURANCE_POLICY
                          - AUTO_INSURANCE_POLICY
                          - HOME_INSURANCE_POLICY
                          - RENTERS_INSURANCE_POLICY
                          - UNINSURED_MOTORIST_FORM
                          - AUTO_INSURANCE_CLAIM
                          - INSURANCE_CARD
                          - STUDENT_ID_CARD
                          - PROCEEDS_1099_B
                          - TWN_EDR
                          - FORM_1099_B
                          - FORM_1099_CONSOLIDATED
                          - FORM_1099_INT
                          - FORM_1099_DIV
                          - FORM_1099_OID
                          - FORM_1099_MISC
                          - FORM_1099_NEC
                          - FORM_1098
                          - POLICY_LISTING
                          - POLICY_DETAILS
                          - VEHICLE_LISTING
                          - VEHICLE_DETAILS
                    processing_status:
                      type: array
                      description: Processing status of an item
                      items:
                        type: string
                        enum:
                          - COMPLETED
                          - IN_PROGRESS
                          - UNPROCESSABLE
                options:
                  type: object
                  properties:
                    count:
                      type: number
                      description: Number of items required
                      minimum: 1
                      maximum: 500
                      default: 200
                    offset:
                      type: number
                      default: 1
                      description: offset is used for pagination
                    sort_by:
                      type: string
                      default: created_at
                      enum:
                        - created_at
                        - updated_at
                        - source_data_type
                        - processing_status
                        - external_id
                        - data.pay_date
                    sort_order:
                      type: string
                      enum:
                        - ASC
                        - DESC
                      default: DESC
                    duplicate_identification_mode:
                      type: string
                      description: >-
                        Identify duplicate items at datarequest or individual
                        level
                      enum:
                        - DATAREQUEST
                        - INDIVIDUAL
                      default: DATAREQUEST
                fields:
                  type: array
                  items:
                    type: string
                  description: >-
                    Fields you want in response. Default fields are `id`,
                    `created_at`, `individual_id`, `datarequest_id`,
                    `external_id`, `datasource_id`, `processing_status`,
                    `source_data_type`, `data`
            examples:
              Get_Items_by_Individual_ID:
                $ref: '#/components/examples/v3@item@get_filter'
      responses:
        '200':
          description: Successful Response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    description: List of Items
                    items:
                      $ref: '#/components/schemas/Item_get'
                  rowCount:
                    type: integer
                    description: Total results
              examples:
                successful_response:
                  $ref: '#/components/examples/v3@items@get'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
  /v3/items/get_files:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Get item files
      description: >-
        The `items/get_files` endpoint is used to download the source data for
        an item. The API returns a byte stream of a zip file.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Item identified by MeasureOne
            examples:
              Get transcript by id for TRANSCRIPT_FILE:
                $ref: '#/components/examples/v3@item@get_files'
      responses:
        '200':
          description: Successful Response will return a byte stream of a zip file
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful Response:
                  $ref: '#/components/examples/v3@errors@404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
              examples:
                Successful Response:
                  $ref: '#/components/examples/v3@errors@405'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/items/get_pdf:
    post:
      security:
        - Bearer: []
      tags:
        - Items
      summary: Get PDF item
      description: >-
        The `items/get_pdf` endpoint is used to download/view an item as PDF
        document. The API returns a byte stream of a PDF item file.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Item identified by MeasureOne
                  example: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
      responses:
        '200':
          description: Successful Response will return a byte stream of a PDF file
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: 404
                  error_message:
                    type: string
                    description: Details of the error
                    example: 'Item Not Found: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/checkcodes/get:
    post:
      security:
        - Bearer: []
      tags:
        - Checkcodes
      summary: Get checkcodes
      description: >
        Returns the list of checkcodes for a  session. To enable checkcodes for
        your account, please reach out to sales@measureone.com
         
      parameters:
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: Bearer <<access_token>>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                session_id:
                  type: string
                  description: Unique ID of the session identified by MeasureOne.
            examples:
              Get_list_of_checkcodes:
                $ref: '#/components/examples/v3@checkcodes@get'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                properties:
                  session_id:
                    type: string
                    description: Unique ID for the session identified by MeasureOne
                  checkcodes:
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: >-
                            Type of checkcode. Currently MeasureOne supports one
                            checkcode; CC_DUPLICATE_CREDENTIALS
                        context:
                          type: object
                          description: Details about the checkcode.
                          properties:
                            data:
                              type: array
                              items:
                                properties:
                                  timestamp:
                                    type: number
                                    description: Timestamp in milliseconds
                                  individual_id:
                                    type: string
                                    description: >-
                                      Unique ID of the other Individuals for
                                      which the checkcode was created.
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@checkcodes@get-2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy .
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Invalid session_id
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_academic_summary:
    post:
      security:
        - Bearer: []
      tags:
        - Education
      summary: Get academic summary
      description: >
        Provides a summary of academic and educational data, including dates of
        attendance, degrees achieved, and other fields.  Please see response
        payload for the detailed fields. MeasureOne uses a set of heuristics to
        make a final determination. These heuristics are summarized in Reason
        Codes as detailed in the following table.

        ###  Reason Codes 
          |Code|Description|
          |--- |--- |
          |MAS_DRVD_ATTNDNC_ACAD_SESSION|Attendance determined via academic session enrollments|
          |MAS_DRVD_STD_CLSF_CRSE_IN_PRG|Courses are in progress|
          | MAS_EXPLICIT_TYPE             | Enrollment Type explicitly available on the school website                                                                         |
          | MAS_DRVD_ENRL_TYPE_ENRL_STS   | Enrollment Type derived based INACTIVE enrollment status                                                                           |
          | MAS_DRVD_ENRL_TYPE            | Enrollment Type derived based on credits attempted in currently enrolled term                                                      |
          | MAS_DRVD_ENRL_TYPE_PRV_TERM   | Enrollment Type derived based on credits attempted in the previous enrolled term within 180 days of the date available in the data |
          | MAS_DRVD_ENRL_TYPE_INFR_CRED  | Enrollment Type derived based on inferred credits attempted                                                                        |
          | MAS_DRVD_ENRL_TYPE_COOP_CRSE  | Enrollment Type derived based on enrolled COOP course                                                                              |
          |MAS_INSUFFICIENT_DATA|Attendance record not available|
          |MAS_INSUFFICIENT_DATA|Date degree was awarded not available|
          |MAS_INSUFFICIENT_DATA|Degree GPA not available|
          |MAS_INSUFFICIENT_DATA|Degree majors not available|
          |MAS_INSUFFICIENT_DATA|Description of degree not available|
          |MAS_INSUFFICIENT_DATA|Number of credits not available|
          |MAS_INSUFFICIENT_DATA|Number of degree credits not available|
          |MAS_INSUFFICIENT_DATA|Status of student degree not available|
          |MAS_INSUFFICIENT_DATA|Student classification data not available|
          |MAS_INSUFFICIENT_DATA|Student degree data not available|
          |MAS_INSUFFICIENT_DATA|Student GPA not available|
          |MAS_INSUFFICIENT_DATA|Type of student degree not available|
          |MAS_INSUFFICIENT_DATA|Enrollment Type of student not available|
          |ITEM_ON_HOLD|Student transcript(s) on financial hold|
          |MAS_VF_DAC|Verification method: Direct school account connection|
          |MAS_VF_USD|Verification method: User-submitted transcript|
          |MAS_VF_DAC_USD|Verification method: Direct school account connection and one or more user-submitted transcript|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - $ref: '#/components/schemas/DataRequestParent'
                - $ref: '#/components/schemas/IndividualParent'
            examples:
              Get_Academic_Summary_request_with_service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              Get_Academic_Summary_request_with_transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              Get_Academic_Summary_request_with_datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              Get_Academic_Summary_request_with_individual_id:
                $ref: '#/components/examples/v3@individuals@get_academic_summary'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the summary needs to
                            be retrieved. If the list is empty, the summary will
                            be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                      - IN_PROGRESS
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      academic summary. Note that if MeasureOne system requires
                      any intervention from our team, the status will update to
                      IN_PROGRESS. `IN_PROGRESS` - We have received the request
                      and our team is working to process the the academic
                      summary.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  academic_summary:
                    type: array
                    items:
                      $ref: '#/components/schemas/AcademicSummary'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - OTHER
                              description: Code identifying type of signal
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH` and `SSN_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                Get_Academic_Summary_when_processing_is_completed:
                  $ref: >-
                    #/components/examples/v3@services@academic_accounts@academic_summary
                Get_Academic_Summary_when_processing_is_acquiring:
                  $ref: >-
                    #/components/examples/v3@services@academic_accounts@academic_summary_acquiring
                Get_Academic_Summary_when_processing_is_in-progress:
                  $ref: >-
                    #/components/examples/v3@services@academic_accounts@academic_summary_pending
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id` or `datarequest_id`or
            `transaction_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report ACADEMIC_SUMMARY found in
                      the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when academic summary cannot be
            generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable.
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_enrollment_status:
    post:
      security:
        - Bearer: []
      tags:
        - Education
      summary: Get enrollment status
      description: >
        This endpoint provides an assessment of the student's enrollment
        status.  MeasureOne uses a set of heuristics to make a final
        determination.   These heuristics are summarized in Reason Codes as
        detailed in the following table.


        ###  Reason Codes 
          |Code|Description|
          |--- |--- |
          |MES_EXPLICIT_STATUS|Enrollment Status explicitly available on school website|
          |MES_CURRENTLY_ENROLLED|Currently enrolled in a program|
          |MES_COURSE_IN_PRG|One or more courses in progress|
          |MES_COURSE_IN_PRG_DEG_AWD_LT_90|One or more courses in progress but degree awarded before 90 days of the date available in the data|
          |MES_LAST_TERM_LT_180|Last term ended within 180 days of date available in the data|
          |MES_LAST_TERM_LT_180_DEG_AWD_GT_270|Last term ended within 180 days of item creation but degree awarded date is greater than 270 days|
          |MES_COURSE_IN_PRG_DEG_AWD_LT_60|One or more courses in progress, but degree awarded before 60 days of item creation|
          |MES_LAST_TERM_GT_180|Last term ended greater than 180 days of the date available in the data|
          |MES_WITHDRAWN|Withdrawn from all programs|
          |MES_VERIFIED_CREDENTIALS|Successfully verified Individual’s login credentials|
          |MES_INSUFFICIENT_DATA|Insufficient Data|
          |MES_VF_DAC|Verification method: Direct school account connection|
          |MES_VF_USD|Verification method: User-submitted transcript|
          |MES_VF_DAC_USD|Verification method: Direct school account connection and one or more user-submitted transcript|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - $ref: '#/components/schemas/DataRequestParent'
                - $ref: '#/components/schemas/IndividualParent'
            examples:
              Get_Enrollment_Status_request_with_service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              Get_Enrollment_Status_request_with_transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              Get_Enrollment_Status_request_with_datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              Get_Enrollment_Status_request_with_individual_id:
                $ref: '#/components/examples/v3@individuals@get_academic_summary'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the summary needs to
                            be retrieved. If the list is empty, the summary will
                            be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                      - IN_PROGRESS
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      enrollment status. Note that if MeasureOne system requires
                      any intervention from our team, the status will update to
                      IN_PROGRESS. `IN_PROGRESS` - We have received the request
                      and our team is working to process the the enrollment
                      status.
                    readOnly: true
                  transaction_id:
                    type: string
                    description: Unique identifier for this transaction.
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  enrollment_status:
                    type: array
                    items:
                      $ref: '#/components/schemas/EnrollmentStatus'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - OTHER
                              description: Code identifying type of signal
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH` and `SSN_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                When_processing_is_COMPLETED:
                  $ref: >-
                    #/components/examples/v3@individuals@get_enrollment_status_complete
                When_processing_is_ACQUIRING:
                  $ref: >-
                    #/components/examples/v3@services@get_enrollment_status_acquiring
                When_processing_is_IN_PROGRESS:
                  $ref: >-
                    #/components/examples/v3@services@get_enrollment_status_pending
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report ENROLLMENT_STATUS found
                      in the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when enrollment status cannot be
            generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/meritscore:
    post:
      security:
        - Bearer: []
      tags:
        - Education
      summary: Get MeritScore
      description: >
        MeasureOne's MeritScore is a proprietary predictive analytic that
        provides an assessment of an Individual's credit default risk based on
        an academic transcript.  This endpoint calculates and returns the
        MeritScore based on the Individual's transcript. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  items:
                    required:
                      - id
                    properties:
                      id:
                        type: string
                        description: Unique ID of the transcript identified by MeasureOne
            examples:
              Submitting_Transcript_ID_for_MeritScore:
                $ref: '#/components/examples/v3@analytics@get_merit_score'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction_id:
                    type: string
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  items:
                    type: array
                    items:
                      properties:
                        id:
                          type: string
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - IN_PROGRESS
                  meritscore:
                    $ref: '#/components/schemas/MeritScore'
              examples:
                Successful_Response_when_processing_is_COMPLETED:
                  $ref: '#/components/examples/v3@meritscore@get'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@422-unprocessable@meritscore'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/gradscore:
    post:
      security:
        - Bearer: []
      tags:
        - Education
      summary: Get GradScore
      description: >
        MeasureOne's Gradscore is a proprietary predictive analytic that
        provides an assessment of an Individual's academic persistence rate
        (probability of the student to be enrolled or graduated 12 months from
        measurement).   This endpoint calculates and returns the Gradscore based
        on the Individual's transcript. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  items:
                    required:
                      - id
                    properties:
                      id:
                        type: string
                        description: Unique ID of the transcript identified by MeasureOne
            examples:
              Submitting_Transcript_to_get_GradScore:
                $ref: '#/components/examples/v3@analytics@get_grad_score'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction_id:
                    type: string
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  items:
                    type: array
                    items:
                      properties:
                        id:
                          type: string
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - IN_PROGRESS
                  gradscore:
                    $ref: '#/components/schemas/GradScore'
              examples:
                Successful_Response_when_processing_is_completed:
                  $ref: '#/components/examples/v3@gradscore@get'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@422-unprocessable@gradscore'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_digest_by_id:
    post:
      security:
        - Bearer: []
      tags:
        - Education
      summary: Get M1_DIGEST for Transcript
      description: >
        This API also has an [asynchronous
        response](#section/Introduction/Asynchronous-communication). It
        retrieves transcript metadata and Digest fields. The endpoint can be
        used once a the processing_status for a transcript is COMPLETED. It will
        return the M1_DIGEST schema.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
            examples:
              M1_DIGEST:
                $ref: '#/components/examples/v3@item@get_by_id_digest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transcript_without_raw'
              examples:
                Successful_Response_when_processing_is_complete:
                  $ref: '#/components/examples/v3@item@get_by_id_digest_complete'
                Successful_Response_when_processing_is_pending:
                  $ref: '#/components/examples/v3@item@get_by_id_digest-2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Response:
                  $ref: '#/components/examples/v3@errors@422-unprocessable@digest'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Error:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_income_summary:
    post:
      security:
        - Bearer: []
      tags:
        - Income & Employment
      summary: Get income summary
      description: >
        Retrieves a summary of an Individual's income based on the income
        related Items, including salary and other income related information.
        MeasureOne uses a set of heuristics to make a final determination. These
        heuristics are summarized in Reason Codes as detailed in the following
        table.


        ###  Reason Codes 
          |Code|Description|
          |--- |--- |
          |MIE_VF_DPC|Verification method: Direct payroll account connection|
          |MIE_VF_USP_BAC|Verification method: User-submitted paystub with bank account check|
          |MIE_VF_USP_NO_BAC|Verification method: User-submitted paystub without bank account check|
          |MIE_VF_USW2|Verification method: User-submitted W-2|
          |MIE_VF_US1099NEC| Verification method: User-submitted 1099-NEC|
          |MIE_VF_US1099MISC| Verification method: User-submitted 1099-MISC|
          |MIE_VF_US1099B| Verification method: User-submitted 1099-B|
          |MIE_VF_US1099OID| Verification method: User-submitted 1099-OID|
          |MIE_VF_US1099DIV| Verification method: User-submitted 1099-DIV|
          |MIE_VF_US1099INT| Verification method: User-submitted 1099-INT|
          |MIE_VF_US1099CONSOLIDATED| Verification method: User-submitted 1099-CONSOLIDATED|
          |MIE_VF_DPC_USP|Verification method: Direct payroll account connection and one or more User-submitted Paystub|
          |MIE_VF_DPC_USW2|Verification method: Direct payroll account connection and User-submitted W-2|
          |MIE_VF_USP_USW2|Verification method: User-submitted one or more Paystub and W-2|
          |MIE_VF_W2|Verification method: W-2 reported income is the wages, tips and other comp. (box 1) as reported on the W-2|
          |MIE_ERNG_1099NEC| Nonemployee compensation income is Nonemployee compensation (box 1) as reported on 1099-NEC|
          |MIE_ERNG_1099INT|Interest income computed using data available on 1099-INT|
          |MIE_ERNG_1099DIV|Dividend income computed using data available on 1099-DIV|
          |MIE_ERNG_1099B|Investment income computed using data available on 1099-B|
          |MIE_ERNG_1099OID|Interest income computed using data available on 1099-OID|
          |MIE_ERNG_1099MISC|Rental income is Rents (box 1) as reported on 1099-MISC|
          |MIE_ERNG_1099MISC|Royalty income is Royalties (box 2) as reported on 1099-MISC|
          |MIE_ERNG_1099MISC|Other income is Other Income (box 3) as reported on 1099-MISC|
          |MIE_VF_US_EDR|Verification method: User-submitted THE WORK NUMBER Employment Data Report|
          |MIE_VF_UCB|Verification method: User-connected bank account|
          |MIE_DRVD_EIN|Employment Identification Number (EIN) derived from W-2|
          |MIE_NI_BEM|Net income on Paystub matches with a corresponding entry in the bank statement|
          |MIE_NI_NO_BEM|Net income on Paystub does not matches with a corresponding entry in the bank statement|
          |MIE_NID_BEM|Net income on Paystub matches with a corresponding entry in the bank statement (Deposit Split)|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive earnings|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive yearly earnings|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive an EIN|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - title: datarequest_id
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - datarequest_id
                  properties:
                    datarequest_id:
                      type: string
                      description: Unique ID of the Data Request identified by MeasureOne
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        get_yearly_earnings:
                          type: boolean
                          description: >-
                            Include yearly earnings up to CY + last 2 years in
                            the VOIE/Income Summary report.
                          default: false
                        earnings_period_type:
                          type: string
                          description: Earnings period type.
                          enum:
                            - CURRENT
                            - HISTORIC
                          default: CURRENT
                          x-enumDescriptions:
                            CURRENT: >-
                              Get earnings for last 2 pay period in the
                              VOIE/Income Summary report.
                            HISTORIC: >-
                              Get earnings for pay periods up to CY + last 2
                              years in the VOIE/Income Summary report.
                        include_earnings_description:
                          type: boolean
                          description: >-
                            Whether to include earnings description in the
                            Income Summary report.
                          default: false
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
                - title: individual
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - individual
                  properties:
                    individual:
                      type: object
                      description: Individual Details
                      required:
                        - individual_id
                      properties:
                        individual_id:
                          type: string
                          description: Unique ID of the individual identified by MeasureOne
                        datasources:
                          type: array
                          items:
                            type: string
                          description: >-
                            List of data sources for which the data needs to be
                            retrieved. If the list is empty, the data will be
                            retrieved for all the data sources
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        get_yearly_earnings:
                          type: boolean
                          description: >-
                            Include yearly earnings up to CY + last 2 years in
                            the VOIE/Income Summary report.
                          default: false
                        earnings_period_type:
                          type: string
                          description: Earnings period type.
                          enum:
                            - CURRENT
                            - HISTORIC
                          default: CURRENT
                          x-enumDescriptions:
                            CURRENT: Get earnings for last 2 pay period
                            HISTORIC: >-
                              Get earnings for pay periods up to CY + last 2
                              years
                        include_earnings_description:
                          type: boolean
                          description: >-
                            Whether to include earnings description in the
                            Income Summary report.
                          default: false
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: >-
                  #/components/examples/v3@individuals@get_income_employment_details
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the summary needs to
                            be retrieved. If the list is empty, the summary will
                            be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction.
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      academic summary.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  income_summary:
                    type: array
                    items:
                      $ref: '#/components/schemas/IncomeSummary'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - EMPLOYEE_ID_MISMATCH
                                - GROSS_PAY_CALC_MISMATCH
                                - NET_PAY_GREATER_THAN_GROSS
                                - W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                                - W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                                - W2_INVALID_MEDICARE_TAX_WITHHELD
                                - W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                                - OTHER
                              description: Signal code
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: GROSS_PAY_CALC_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: NET_PAY_GREATER_THAN_GROSS
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_INVALID_MEDICARE_TAX_WITHHELD
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH`, `SSN_MISMATCH`, and
                                        `EMPLOYEE_ID_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@income_summary'
                COMPLETED YEARLY EARNINGS:
                  $ref: '#/components/examples/v3@services@income_summary_yearly'
                COMPLETED BANK INCOME EARNINGS:
                  $ref: '#/components/examples/v3@services@income_summary_bank_income'
                ACQUIRING:
                  $ref: '#/components/examples/v3@services@income_summary_acquiring'
                IN-PROGRESS:
                  $ref: '#/components/examples/v3@services@income_summary_pending'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report INCOME_SUMMARY found in
                      the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when income summary cannot be generated
            due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_employment_summary:
    post:
      security:
        - Bearer: []
      tags:
        - Income & Employment
      summary: Get employment summary
      description: >
        Retrieves an summary of an Individual's employment based on employment
        related Items, including history and status. MeasureOne uses a set of
        heuristics to make a final determination. These heuristics are
        summarized in Reason Codes as detailed in the following table.


        ###  Reason Codes 
          |Code|Description|
          |--- |--- |
          |MIE_VF_DPC|Verification method: Direct payroll account connection|
          |MIE_VF_US_EDR|Verification method: Individual-submitted THE WORK NUMBER Employment Data Report|
          |MIE_VF_USP_NO_BAC|Verification method: Individual-submitted paystub|
          |MIE_VF_USW2|Verification method: User-submitted W-2|
          |MIE_VF_USP_USW2|Verification method: User-submitted one or more Paystub and W-2|
          |MIE_DA_ESD|Employment start date directly available in source data|
          |MIE_DRVD_ESD|Employment start date derived earliest available paystub|
          |MIE_DA_EED|Employment end date directly available in source data|
          |MIE_DRVD_EED|Employment end date derived from latest paystub|
          |MIE_DA_ROLE|Role information directly available in source data|
          |MIE_DA_ES|Employment status directly available in source data|
          |MIE_DRVD_ES|Employment status derived based on last pay date|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment status|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employee role|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment start date|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment end date|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - $ref: '#/components/schemas/DataRequestParent'
                - $ref: '#/components/schemas/IndividualParent'
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: >-
                  #/components/examples/v3@individuals@get_income_employment_details
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the summary needs to
                            be retrieved. If the list is empty, the summary will
                            be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction.
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      academic summary.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  employment_summary:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmploymentSummary'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - EMPLOYEE_ID_MISMATCH
                                - GROSS_PAY_CALC_MISMATCH
                                - NET_PAY_GREATER_THAN_GROSS
                                - OTHER
                              description: Signal code
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: GROSS_PAY_CALC_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: NET_PAY_GREATER_THAN_GROSS
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH`, `SSN_MISMATCH`, and
                                        `EMPLOYEE_ID_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@employment_summary'
                ACQUIRING:
                  $ref: >-
                    #/components/examples/v3@services@employment_summary_acquiring
                IN-PROGRESS:
                  $ref: '#/components/examples/v3@services@employment_summary_pending'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report EMPLOYMENT_SUMMARY found
                      in the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when employment summary cannot be
            generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_income_employment_details:
    post:
      security:
        - Bearer: []
      tags:
        - Income & Employment
      summary: Get income employment details (VOIE)
      description: >
        Retrieves details of an Individual's income and employment based on
        employment/income related Items, including history and status.
        MeasureOne uses a set of heuristics to make a final determination. These
        heuristics are summarized in Reason Codes as detailed in the following
        table.


        ###  Reason Codes 
          |Code|Description|
          |--- |--- |
          |MIE_VF_DPC|Verification method: Direct payroll account connection|
          |MIE_VF_USP_BAC|Verification method: User-submitted paystub with bank account check|
          |MIE_VF_USP_NO_BAC|Verification method: User-submitted paystub without bank account check|
          |MIE_VF_US_EDR|Verification method: User-submitted THE WORK NUMBER Employment Data Report|
          |MIE_VF_USW2|Verification method: User-submitted W-2|
          |MIE_VF_US1099NEC| Verification method: User-submitted 1099-NEC|
          |MIE_VF_US1099MISC| Verification method: User-submitted 1099-MISC|
          |MIE_VF_US1099B| Verification method: User-submitted 1099-B|
          |MIE_VF_US1099OID| Verification method: User-submitted 1099-OID|
          |MIE_VF_US1099DIV| Verification method: User-submitted 1099-DIV|
          |MIE_VF_US1099INT| Verification method: User-submitted 1099-INT|
          |MIE_VF_US1099CONSOLIDATED| Verification method: User-submitted 1099-CONSOLIDATED|
          |MIE_VF_DPC_USP|Verification method: Direct payroll account connection and one or more User-submitted Paystub|
          |MIE_VF_DPC_USW2|Verification method: Direct payroll account connection and User-submitted W-2|
          |MIE_VF_USP_USW2|Verification method: User-submitted one or more Paystub and W-2|
          |MIE_VF_W2|Verification method: W-2 reported income is the wages, tips and other comp. (box 1) as reported on the W-2|
          |MIE_ERNG_1099NEC| Nonemployee compensation income is Nonemployee compensation (box 1) as reported on 1099-NEC|
          |MIE_ERNG_1099INT|Interest income computed using data available on 1099-INT|
          |MIE_ERNG_1099DIV|Dividend income computed using data available on 1099-DIV|
          |MIE_ERNG_1099B|Investment income computed using data available on 1099-B|
          |MIE_ERNG_1099OID|Interest income computed using data available on 1099-OID|
          |MIE_ERNG_1099MISC|Rental income is Rents (box 1) as reported on 1099-MISC|
          |MIE_ERNG_1099MISC|Royalty income is Royalties (box 2) as reported on 1099-MISC|
          |MIE_ERNG_1099MISC|Other income is Other Income (box 3) as reported on 1099-MISC|
          |MIE_VF_UCB|Verification method: User-connected bank account|
          |MIE_DA_ESD|Employment start date directly available in source data|
          |MIE_DRVD_ESD|Employment start date derived earliest available paystub|
          |MIE_DRVD_EIN|Employment Identification Number (EIN) derived from W-2|
          |MIE_DA_EED|Employment end date directly available in source data|
          |MIE_DRVD_EED|Employment end date derived from latest paystub|
          |MIE_DA_ROLE|Role information directly available in source data|
          |MIE_DA_ES|Employment status directly available in source data|
          |MIE_DRVD_ES|Employment status derived based on last pay date|
          |MIE_NI_BEM|Net income on Paystub matches with a corresponding entry in the bank statement|
          |MIE_NI_NO_BEM|Net income on Paystub does not matches with a corresponding entry in the bank statement|
          |MIE_NID_BEM|Net income on Paystub matches with a corresponding entry in the bank statement (Deposit Split)|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment status|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employee role|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment start date|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive employment end date|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive earnings|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive yearly earnings|
          |MIE_INSUFFICIENT_DATA|Insufficient information to derive an EIN|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - title: datarequest_id
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - datarequest_id
                  properties:
                    datarequest_id:
                      type: string
                      description: Unique ID of the Data Request identified by MeasureOne
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        get_yearly_earnings:
                          type: boolean
                          description: >-
                            Include yearly earnings up to CY + last 2 years the
                            VOIE/Income Summary report.
                          default: false
                        earnings_period_type:
                          type: string
                          description: Earnings period type.
                          enum:
                            - CURRENT
                            - HISTORIC
                          default: CURRENT
                          x-enumDescriptions:
                            CURRENT: >-
                              Get earnings for last 2 pay period in the
                              VOIE/Income Summary report.
                            HISTORIC: >-
                              Get earnings for pay periods up to CY + last 2
                              years in the VOIE/Income Summary report.
                        include_earnings_description:
                          type: boolean
                          description: >-
                            Whether to include earnings description in the
                            Income Summary report.
                          default: false
                        generate_with_error:
                          type: boolean
                          default: false
                          description: >-
                            Generate report with error. Report will have record
                            for each datarequest even if datarequest doesn't
                            have data to generate the report.
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
                - title: individual
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - individual
                  properties:
                    individual:
                      type: object
                      description: Individual Details
                      required:
                        - individual_id
                      properties:
                        individual_id:
                          type: string
                          description: Unique ID of the individual identified by MeasureOne
                        datasources:
                          type: array
                          items:
                            type: string
                          description: >-
                            List of data sources for which the data needs to be
                            retrieved. If the list is empty, the data will be
                            retrieved for all the data sources
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        get_yearly_earnings:
                          type: boolean
                          description: >-
                            Include yearly earnings up to CY + last 2 years in
                            the VOIE/Income Summary report.
                          default: false
                        earnings_period_type:
                          type: string
                          description: Earnings period type.
                          enum:
                            - CURRENT
                            - HISTORIC
                          default: CURRENT
                          x-enumDescriptions:
                            CURRENT: Get earnings for last 2 pay period
                            HISTORIC: >-
                              Get earnings for pay periods up to CY + last 2
                              years
                        include_earnings_description:
                          type: boolean
                          description: >-
                            Whether to include earnings description in the
                            Income Summary report.
                          default: false
                        generate_with_error:
                          type: boolean
                          default: false
                          description: >-
                            Generate report with error. Report will have record
                            for each datarequest even if datarequest doesn't
                            have data to generate the report.
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: >-
                  #/components/examples/v3@individuals@get_income_employment_details
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the summary needs to
                            be retrieved. If the list is empty, the summary will
                            be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    deprecated: true
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction.
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: Processing status of the request.
                    readOnly: true
                    x-enumDescriptions:
                      COMPLETED: MeasureOne has finished processing of the request.
                      ACQUIRING: >-
                        We have received the request and system is acquiring the
                        income employment details.
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  income_employment_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/VOIESummary'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - EMPLOYEE_ID_MISMATCH
                                - GROSS_PAY_CALC_MISMATCH
                                - NET_PAY_GREATER_THAN_GROSS
                                - W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                                - W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                                - W2_INVALID_MEDICARE_TAX_WITHHELD
                                - W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                                - OTHER
                              description: Signal code
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: GROSS_PAY_CALC_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: NET_PAY_GREATER_THAN_GROSS
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_INVALID_MEDICARE_TAX_WITHHELD
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH`, `SSN_MISMATCH`, and
                                        `EMPLOYEE_ID_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@income_employment_details'
                COMPLETED YEARLY EARNINGS:
                  $ref: >-
                    #/components/examples/v3@services@income_employment_details_yearly
                COMPLETED BANK INCOME EARNINGS:
                  $ref: >-
                    #/components/examples/v3@services@income_employment_details_bank_income
                COMPLETED GENERATE WITH ERROR:
                  $ref: >-
                    #/components/examples/v3@services@income_employment_details_with_error
                ACQUIRING:
                  $ref: >-
                    #/components/examples/v3@services@income_employment_details_acquiring
                IN-PROGRESS:
                  $ref: >-
                    #/components/examples/v3@services@income_employment_details_pending
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id` or `datarequest_id` or or
            `transaction_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report INCOME_EMPLOYMENT_DETAILS
                      found in the Data Request. Please provide params/metadata
                      in request
        '422':
          description: >-
            Unprocessable Entity. Occurs when income employment details cannot
            be generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_insurance_details:
    post:
      security:
        - Bearer: []
      summary: Get insurance details
      tags:
        - Insurance
      description: >
        Provides insurance details including policy type, policy dates,
        coverages, premium amount and other fields. Please see response payload
        for the detailed fields. Following table has reason code for Insurance
        Details.


        ###  Reason Codes 

        |Code|Description|

        |--- |--- |

        |MID_VF_DAC|Verification method: Direct insurance provider account
        connection|

        |MID_VF_USD|Verification method: User-submitted insurance policy|

        |MID_VF_USIC|Verification method: User-submitted insurance card|

        |MID_VF_DAC_USD|Verification method: Direct insurance provider account
        connection and one or more user-submitted insurance policy|

        |MID_INSUFFICIENT_DATA|MeasureOne does not have sufficient data to
        process the requested transaction|

        |MID_DRVD_STATUS |Insurance status derived from coverage dates|

        |MID_DA_STATUS |Insurance status directly available in source data|

        |MID_INSUFFICIENT_DATA |Insufficient information to derive insurance
        status|
          
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - title: datarequest_id
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - datarequest_id
                  properties:
                    datarequest_id:
                      type: string
                      description: Unique ID of the Data Request identified by MeasureOne
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        policy_type:
                          type: string
                          description: Type of policy to be considered for the report
                          enum:
                            - AUTO
                            - HOME
                            - RENTERS
                        allow_partial_report:
                          type: boolean
                          default: false
                          description: Allow report generation with minimal available data
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
                - title: individual
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - individual
                  properties:
                    individual:
                      type: object
                      description: Individual Details
                      required:
                        - individual_id
                      properties:
                        individual_id:
                          type: string
                          description: Unique ID of the individual identified by MeasureOne
                        datasources:
                          type: array
                          items:
                            type: string
                          description: >-
                            List of data sources for which the data needs to be
                            retrieved. If the list is empty, the data will be
                            retrieved for all the data sources
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        policy_type:
                          type: string
                          description: Type of policy to be considered for the report
                          enum:
                            - AUTO
                            - HOME
                            - RENTERS
                        allow_partial_report:
                          type: boolean
                          default: false
                          description: Allow report generation with minimal available data
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: '#/components/examples/v3@individuals@get_insurance_details'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    description: Individual Details
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the insurance details
                            needs to be retrieved. If the list is empty, the
                            details will be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      academic summary.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  insurance_details:
                    type: array
                    description: List of insurance details retrieved
                    items:
                      $ref: '#/components/schemas/InsuranceDetails'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - OTHER
                              description: Code identifying type of signal
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH` and `SSN_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@insurance_details'
                ACQUIRING:
                  $ref: >-
                    #/components/examples/v3@services@insurance_details_acquiring
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id` or `datarequest_id` or
            `transaction_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report INSURANCE_DETAILS found
                      in the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when insurance details cannot be
            generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_insurance_status:
    post:
      security:
        - Bearer: []
      summary: Get insurance status
      tags:
        - Insurance
      description: >
        Provides basic insurance information including policy status, policy
        dates, coverage type and other fields. Please see response payload for
        the detailed fields. Following table has reason code for Insurance
        Status.


        ###  Reason Codes 

        |Code|Description|

        |--- |--- |

        |MIS_VF_DAC|Verification method: Direct insurance provider account
        connection|

        |MIS_VF_USD|Verification method: User-submitted insurance policy|

        |MIS_VF_USIC|Verification method: User-submitted insurance card|

        |MIS_VF_DAC_USD|Verification method: Direct insurance provider account
        connection and one or more user-submitted insurance policy|

        |MIS_DRVD_STATUS | Insurance status derived from coverage dates|

        |MIS_DA_STATUS | Insurance status directly available in source data |

        |MIS_INSUFFICIENT_DATA |MeasureOne does not have sufficient data to
        process the requested transaction|

        |MIS_INSUFFICIENT_DATA |Insufficient information to derive insurance
        status|
          
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - title: datarequest_id
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - datarequest_id
                  properties:
                    datarequest_id:
                      type: string
                      description: Unique ID of the Data Request identified by MeasureOne
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        policy_type:
                          type: string
                          description: Type of policy to be considered for the report
                          enum:
                            - AUTO
                            - HOME
                            - RENTERS
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
                - title: individual
                  type: object
                  description: >-
                    Service APIs calls with datarequest_id and individual are
                    asynchronous in nature. You can initiate a service by
                    calling service API with datarequest_id and individual. Call
                    Service APIs with transaction_id to get the results.
                  required:
                    - individual
                  properties:
                    individual:
                      type: object
                      description: Individual Details
                      required:
                        - individual_id
                      properties:
                        individual_id:
                          type: string
                          description: Unique ID of the individual identified by MeasureOne
                        datasources:
                          type: array
                          items:
                            type: string
                          description: >-
                            List of data sources for which the data needs to be
                            retrieved. If the list is empty, the data will be
                            retrieved for all the data sources
                    params:
                      type: object
                      description: Parameters for fetching Income Summary Report
                      properties:
                        policy_type:
                          type: string
                          description: Type of policy to be considered for the report
                          enum:
                            - AUTO
                            - HOME
                            - RENTERS
                    metadata:
                      type: object
                      description: >-
                        metadata can be used for storing additional information
                        in a structured format. metadata will be sent in
                        webhooks and report response.
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: '#/components/examples/v3@individuals@get_insurance_details'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    description: Individual Status
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the individual identified by MeasureOne
                      datasources:
                        type: array
                        items:
                          type: string
                          description: >-
                            List of data sources for which the insurance details
                            needs to be retrieved. If the list is empty, the
                            details will be retrieved for all the data sources
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      Insurance Policy.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  insurance_status:
                    type: array
                    description: List of basic insurance information retrieved
                    items:
                      $ref: '#/components/schemas/InsuranceStatus'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - OTHER
                              description: Code identifying type of signal
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH` and `SSN_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@insurance_status'
                ACQUIRING:
                  $ref: '#/components/examples/v3@services@insurance_status_acquiring'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id` or `datarequest_id` or or
            `transaction_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report INSURANCE_STATUS found in
                      the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when insurance status cannot be
            generated due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/services/get_realized_gains:
    post:
      security:
        - Bearer: []
      tags:
        - Tax Records
      summary: Get Realized Gains
      description: >
        Provides short-term and long-term realized gains on proceeds from the
        securities transactions. Please see response payload for the detailed
        fields. Following table has reason code for Insurance Details.


        ###  Reason Codes 

        |Code|Description|

        |--- |--- |

        |MRG_VF_DAC|Verification method: Direct brokerage account connection|

        |MRG_VF_USD|Verification method: User-submitted 1099-B|

        |MRG_VF_DAC_USD|Verification method: Direct brokerage account connection
        and one or more user-submitted 1099-B|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ServiceContextParent'
                - $ref: '#/components/schemas/TransactionParent'
                - $ref: '#/components/schemas/DataRequestParent'
                - $ref: '#/components/schemas/BrokerageIndividualParent'
            examples:
              service_context_id:
                $ref: '#/components/examples/v3@services@with_service_context_id'
              transaction_id:
                $ref: '#/components/examples/v3@individuals@with_transaction_id'
              datarequest_id:
                $ref: '#/components/examples/v3@individuals@with_datarequest_id'
              individual_id:
                $ref: '#/components/examples/v3@individuals@get_realized_gains'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  individual:
                    type: object
                    description: Individual Details
                    properties:
                      individual_id:
                        type: string
                        description: Unique ID of the Individual identified by MeasureOne
                      datasources:
                        type: array
                        default: null
                        items:
                          type: string
                        description: >-
                          List of datasource IDs for which the realized gains
                          needs to be retrieved. If the list is empty, the
                          details will be retrieved for all the data sources
                      account_numbers:
                        type: array
                        default: null
                        items:
                          type: string
                        description: >-
                          List of account numbers for which the realized gains
                          needs to be retrieved. If the list is empty, the
                          details will be retrieved for all the accounts
                          available
                      tax_years:
                        type: array
                        default: null
                        items:
                          type: string
                        description: >-
                          List of tax years for which the realized gains needs
                          to be retrieved. If the list is empty, the details
                          will be retrieved for all the tax years available
                  datarequest_id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                  transaction_id:
                    type: string
                    description: Unique ID of this transaction
                    deprecated: true
                  service_context_id:
                    type: string
                    description: Unique ID of the service context identified by MeasureOne
                  processing_status:
                    type: string
                    enum:
                      - COMPLETED
                      - ACQUIRING
                    description: >-
                      Processing status of the request. `COMPLETED` - MeasureOne
                      has finished processing of the request. `ACQUIRING` - We
                      have received the request and system is acquiring the
                      realized gains.
                    readOnly: true
                  metadata:
                    type: object
                    description: >-
                      metadata can be used for storing additional information in
                      a structured format. metadata will be sent in webhooks and
                      report response.
                  realized_gains:
                    type: array
                    description: >-
                      Array of realized gains for each datasource with the
                      details as presented in the acquired data.
                    items:
                      $ref: '#/components/schemas/RealizedGains'
                  check_signals:
                    description: >-
                      Identified check signals. More information on **[Check
                      Signals](#tag/CheckSignalsIntroduction)**
                    properties:
                      signals:
                        type: array
                        description: List of signals
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - METADATA_MISMATCH
                                - FONT_MISMATCH
                                - NAME_MISMATCH
                                - SSN_MISMATCH
                                - OTHER
                              description: Code identifying type of signal
                            description:
                              type: string
                              description: Human-readable description of the signal
                            context:
                              oneOf:
                                - title: items
                                  type: object
                                  properties:
                                    items:
                                      type: array
                                      description: >-
                                        List of Items where the signal is
                                        applicable
                                      items:
                                        oneOf:
                                          - title: METADATA_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: FONT_MISMATCH
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                          - title: OTHER
                                            type: object
                                            properties:
                                              id:
                                                type: string
                                                description: >-
                                                  Unique ID of the Item identified by
                                                  MeasureOne
                                              attributes:
                                                type: array
                                                description: List of attributes
                                                items:
                                                  type: object
                                                  properties:
                                                    name:
                                                      type: string
                                                      description: >-
                                                        Dot (.) separated JSON path of the
                                                        attribute
                                - title: groups
                                  type: object
                                  properties:
                                    groups:
                                      type: array
                                      description: >-
                                        List of identities identified in the
                                        documents. Applicable for
                                        `NAME_MISMATCH` and `SSN_MISMATCH`
                                      items:
                                        type: object
                                        properties:
                                          attributes:
                                            type: array
                                            description: Identities attributes
                                            items:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                  description: >-
                                                    Dot (.) separated JSON path of the
                                                    attribute
                                                value:
                                                  type: string
                                                  description: Value of the attribute
                                          items:
                                            type: array
                                            description: >-
                                              List of Items where this identity is
                                              available
                                            items:
                                              type: string
              examples:
                COMPLETED:
                  $ref: '#/components/examples/v3@services@realized_gains'
                ACQUIRING:
                  $ref: '#/components/examples/v3@services@realized_gains_acquiring'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: >-
            One or more provided parameters were not found. E.g -
            `individual_id` or `service_context_id`
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  http_code:
                    type: number
                    description: Error status code
                    example: 409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: MULTIPLE_REPORT_INSTANCES
                  error_message:
                    type: string
                    description: Details of the error
                    example: >-
                      Multiple instances of the report REALIZED_GAINS found in
                      the Data Request. Please provide params/metadata in
                      request
        '422':
          description: >-
            Unprocessable Entity. Occurs when realized gains cannot be generated
            due to data unavailability
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  reason_codes:
                    description: >-
                      List of reason codes. Helps developer understand what
                      error occurred during processing an item.
                    type: array
                    items:
                      properties:
                        code:
                          type: string
                          description: |
                            Reason code applicable
                             |Reason Code|Description|
                             |--- |--- |
                             |UNSUPPORTED_FORMAT| The report could not be generated as the following items are of unsupported format.
                             |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as the following items are unprocessable.
                             |PARTIAL_DOCUMENT| The report could not be generated as the following items are partial.
                             |NO_ITEMS| The report could not be generated as there are no items for this Individual.
                        description:
                          type: string
                          description: >-
                            Description providing details to understand what
                            error occurred during processing an item.
                        context:
                          type: object
                          description: >-
                            Context to understand where the reason code is
                            applicable
                          properties:
                            items:
                              type: array
                              description: >-
                                List of Items where the reason code is
                                applicable
                              items:
                                type: string
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@errors@422-unprocessable_other_services
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/auth/generate_access_token:
    post:
      security:
        - Basic: []
      tags:
        - API Keys and Access
      summary: Generate Access Token
      description: >
        This API  returns the access token required for you to access the
        MeasureOne APIs. 


        The Authorization header should contain the word **Basic** word followed
        by a space and a base64-encoded string **username:password**. For
        example, to authorize as demo / p@55w0rd you should send
         

         ```json
          Authorization: Basic ZGVtbzpwQDU1dzByZA==
         ```

        This API does not require any request body
      parameters:
        - in: header
          name: Authorization
          description: >-
            Provide the Base64 representation of your `client_id:secret` e.g.
            "Basic \<\<BASE64\>\>".
          schema:
            type: string
            format: Basic <client_id>:<secret>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmptyBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
              examples:
                Successful_Response_when_processing_is_completed:
                  $ref: >-
                    #/components/examples/v3@authentication@generate_access_token
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/auth/generate_purge_token:
    post:
      security:
        - Basic: []
      tags:
        - API Keys and Access
      summary: Generate Purge Token
      description: >
        This API returns the purge token required for you to access the
        MeasureOne Compliance APIs.


        The Authorization header should contain the word **Basic** word followed
        by a space and a base64-encoded string **username:password**. For
        example, to authorize as demo / p@55w0rd you should send
         

         ```json
          Authorization: Basic ZGVtbzpwQDU1dzByZA==
         ```

        This API does not require any request body
      parameters:
        - in: header
          name: Authorization
          description: >-
            Provide the Base64 representation of your `client_id:secret` e.g.
            "Basic \<\<BASE64\>\>".
          schema:
            type: string
            format: Basic <client_id>:<secret>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmptyBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDeletionToken'
              examples:
                Successful_Response_when_processing_is_completed:
                  $ref: >-
                    #/components/examples/v3@authentication@generate_data_deletion_token
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/auth/invalidate:
    post:
      security:
        - Basic: []
      tags:
        - API Keys and Access
      summary: Invalidate Token
      description: >
        This API invalidates the provided Token.


        The Authorization header should contain the word **Basic** word followed
        by a space and a base64-encoded string **client_id:secret**. For
        example, to authorize as demo / p@55w0rd you should send
         

         ```json
          Authorization: Basic ZGVtbzpwQDU1dzByZA==
         ```

        This API does not require any request body
      parameters:
        - in: header
          name: Authorization
          description: >-
            Provide the Base64 representation of your `client_id:secret` e.g.
            "Basic \<\<BASE64\>\>".
          schema:
            type: string
            format: Basic <client_id>:<secret>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - access_token
              properties:
                access_token:
                  type: string
                  description: Token generated for you to access MeasureOne API
                  example: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/auth/generate_public_token:
    post:
      security:
        - Basic: []
      tags:
        - API Keys and Access
      summary: Generate Public Token
      description: >
        This API  returns the Public Token which are short lived tokens required
        for you to access MeasureOne APIs. 


        The Authorization header should contain the word **Basic** word followed
        by a space and a base64-encoded string **username:password**. For
        example, to authorize as demo / p@55w0rd you should send
         
        ### Public Tokens

         ```json
          Authorization: Basic ZGVtbzpwQDU1dzByZA==
         ```
             
      parameters:
        - in: header
          name: Authorization
          description: >-
            Provide the Base64 representation of your `client_id:secret` e.g.
            "Basic \<\<BASE64\>\>".
          schema:
            type: string
            format: Basic <client_id>:<secret>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                validity:
                  type: number
                  description: Public token validity in seconds
                  default: 900
                scopes:
                  type: array
                  description: >
                    List of scopes for the generated public token. Each scope
                    defines the set of API endpoints that can be accessed using
                    the token. See the table above for details


                    Compatibility note: An unspecified scope will default to
                    `WIDGET`<br/>         
                  items:
                    type: string
                    enum:
                      - WIDGET
                      - GLOBAL
                policy:
                  type: object
                  description: >
                    A set of attributes for specifying data access rules
                    associated with this token. 
                  properties:
                    individual_id:
                      type: string
                      description: >-
                        Restricts access to the Individual identified by the
                        specified MeasureOne ID.
            examples:
              Generating_a_public_token:
                $ref: '#/components/examples/v3@auth@generate_public_token_with_scope'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
              examples:
                Successful_Response:
                  $ref: >-
                    #/components/examples/v3@authentication@generate_public_access_token
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datasources/get:
    post:
      security:
        - Bearer: []
      tags:
        - Datasources
      summary: Get / Search Data Sources
      description: |
        Get / Search Data Sources
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise.
          schema:
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                filters:
                  type: object
                  description: Allows filtering the list by different attributes
                  properties:
                    id:
                      type: array
                      description: Unique ID of the Datasource identified by MeasureOne
                      items:
                        type: string
                    institution_display_name:
                      type: string
                      description: >-
                        Institution name for which you want to search
                        datasources
                    countries:
                      type: array
                      description: List of country a2 codes. e.g. US, CA
                      items:
                        type: string
                    action:
                      type: string
                      enum:
                        - GET
                        - ADD_VEHICLE
                      description: Type of action for which you want to search datasources.
                    supports_direct_connection:
                      type: boolean
                      description: Filter records which has support for direct connections.
                    institution_type:
                      type: string
                      description: >
                        Type of institution for which you want to search
                        datasources. 


                        `COLLEGE`: To search for academic institutions<br>

                        `EMPLOYER`: To search for employers<br>

                        `PAYROLL_PROCESSOR`: To search for payroll providers<br>

                        `HOMEINSURANCE`: To search for home insurance
                        providers<br>

                        `AUTOINSURANCE`: To search for auto insurance
                        providers<br>

                        `RENTERSINSURANCE`: To search for renters insurance
                        providers<br>

                        `BROKERAGE_ACCOUNT`: To search for brokerage firms<br>

                        `BANK_ACCOUNT`: To search for banks<br>
                    ipeds_id:
                      type: string
                      description: >-
                        IPEDS ID of the school. This attribute will be available
                        for academic institution datasources
                    ope_id:
                      type: string
                      description: >-
                        OPE ID of the school. This attribute will be available
                        for academic institution datasources
                    ceeb_id:
                      type: string
                      description: >-
                        CEEB ID of the school. This attribute will be available
                        for academic institution datasources
                options:
                  type: object
                  properties:
                    get_logo:
                      type: boolean
                      description: Get datasource logo in response.
                      default: false
                    count:
                      type: number
                      description: number of datasources required
                      minimum: 1
                      maximum: 1000
                      default: 200
            examples:
              Example_with_filters:
                $ref: >-
                  #/components/examples/v3@datasource_query_example_with_filters@get
              Example_get_logo:
                $ref: '#/components/examples/v3@datasource_options_get_logo@get'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique ID of the datasource identified by MeasureOne
                    contact_info:
                      type: object
                      description: Contact information of Datasource institution
                      properties:
                        website:
                          type: string
                          description: Web address of the datasource institution
                        registrar_phone:
                          type: string
                          description: >-
                            Registrar phone_number of the school. This attribute
                            will be available for academic institution
                            datasources
                        phone_number:
                          type: string
                          description: Phone number of institution
                        it_helpdesk_email:
                          type: string
                          description: IT helpdesk email address of institution
                        it_helpdesk_phone:
                          type: string
                          description: IT helpdesk phone_number of institution
                        registrar_email:
                          type: string
                          description: >-
                            Registrar email address of the school. This
                            attribute will be available for academic institution
                            datasources
                        addresses:
                          type: array
                          items:
                            type: object
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              country:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    description: Name of the country
                                  a2_code:
                                    type: string
                                    description: A2 code  of the country
                              state_name:
                                type: string
                                description: Name of the state
                              state_short_code:
                                type: string
                                description: Short code of the state. e.g CA, CO, NY etc.
                              city:
                                type: string
                                description: Name of the city
                              zipcode:
                                type: string
                                description: zipcode
                    ipeds_id:
                      type: string
                      description: >-
                        IPEDS ID of the school. This attribute will be available
                        for academic institution datasources
                    ceeb_id:
                      type: string
                      description: >-
                        CEEB ID of the school. This attribute will be available
                        for academic institution datasources
                    ope_id:
                      type: string
                      description: >-
                        OPE ID of the school. This attribute will be available
                        for academic institution datasources
                    institution_display_name:
                      type: string
                      description: Institution name of the Datasource
                    student_type:
                      type: array
                      description: >-
                        Types of students supported by this academic institution
                        Datasource. Can be CURRENT_STUDENT, ALUMNI
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: Student type
                          name:
                            type: string
                            description: Description of student type
                    employment_type:
                      type: array
                      description: >-
                        Types of employment supported by this Datasource. Can be
                        EMPLOYEE, CONTRACTOR, GIG_WORKER
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: Employment type
                          name:
                            type: string
                            description: Description of Employment type
                    employment_status:
                      type: array
                      description: >-
                        Employment status supported by this Datasource. Can be
                        CURRENT, FORMER
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: Employment status
                          name:
                            type: string
                            description: Description of Employment status
                    logos:
                      type: array
                      description: Logos of institution
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: Type of logo
                          uri:
                            type: string
                            description: URI of logo
                          base64_content:
                            type: string
                            description: base64-encoded logo
                    countries:
                      type: array
                      description: Datasource supported country
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Name of the country
                          a2_code:
                            type: string
                            description: A2 Code of the country
              examples:
                Example:
                  $ref: >-
                    #/components/examples/v3@datasource@get@200@example_with_default_fields
                Example_get_logo:
                  $ref: '#/components/examples/v3@datasource@get@200_get_logo@get'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        description: message will be returned
              examples:
                Successful_Response:
                  summary: Bad Request
                  description: Example payload Bad Requests
                  value:
                    data:
                      message: string
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
  /v3/datarequests/new:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Create a new Data Request
      description: >
        Creates a new Data Request. The returned ID is then used in
        [Link](#tag/LinkIntroduction) and in service calls to reference Items
        and services.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
          required: true
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StaticDataRequest'
                - $ref: '#/components/schemas/CustomDataRequest'
            examples:
              Create_a_new_Static_DataRequest:
                $ref: '#/components/examples/v3@datarequest@new'
              Create_a_new_Custom_DataRequest:
                $ref: '#/components/examples/v3@datarequest@new_custom'
              Create_a_new_DataRequest_with_auth_token_creds:
                $ref: '#/components/examples/v3@datarequest@new_with_auth_token_creds'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                    example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Either individual_id or id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Error_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/generate_invitation_link:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Generate invitation link for the Data Request
      description: >
        Generate a shareable invitation link for the Data Request. 

        You can share the invitation link with the Individual for them to
        complete the Data Request. The invitation link will direct the user to
        MeasureOne's hosted solution. 


        * If there is a invitation link with status `ACTIVE` available, it will
        return the same invitation link. Generating a invitation link when there
        is already existing `ACTIVE` available. it  will return the same
        invitation link with the  `expires_at` updated as provided. 

        * It will generate a new invitation link if there are no `ACTIVE` links
        available for the Data Request.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                  example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                expires_at:
                  type: number
                  description: >-
                    Timestamp in milliseconds at which the link expires. If not
                    provided, it will take system default i.e. now() + default
                    expiration from your account preferences. The link status
                    will remain ACTIVE till it is either  `COMPLETE` OR
                    'EXPIRED'
                  example: 1675605305012
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique ID of the Data Request identified by MeasureOne
                    example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                  uri:
                    type: string
                    format: scheme:[//authority]path
                    description: URI of the invitation link generated by MeasureOne
                    example: https://link.measureone.com/2RQSeNYvTeNMLvdY2kLeNtMOyrI
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/notify_user:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Invite the Individual to complete the Data Request
      description: >
        Send a notification to the user to complete the data request. The API
        will return an error if the link is already `EXPIRED`.

        MeasureOne sends upto 3 reminders, 12 hours apart to notify the user. 
        Call this API on an already active link for which notifications have
        been sent earlier will reset the counter.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
                - notifications
              properties:
                id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                  example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                notifications:
                  type: array
                  description: >-
                    Type of notifications to be sent to the user. At least one
                    notification channel must be provided.
                  minLength: 1
                  items:
                    required:
                      - type
                    properties:
                      type:
                        type: string
                        description: Type of the notification to be sent
                        enum:
                          - EMAIL
                          - SMS
                additional_message:
                  type: string
                  maxLength: 1000
                  default: null
                  description: >-
                    Additional message that you may want to pass to the
                    Individual in the invitation email/sms
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Either individual_id or id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
                  http_code:
                    type: number
                    description: http response code
              examples:
                Error_Response:
                  summary: Conflict Error
                  description: Example payload for Conflict Error
                  value:
                    content:
                      error_code: CONFLICT
                      error_message: The link is already EXPIRED
                      timestamp: 1690175233110
                      http_code: 409
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/get_invitation_link:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Get shareable invitation links for Data Request
      description: |
        Get the list of invitation links associated with a Data Request
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                  example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                properties:
                  links:
                    type: array
                    description: List of invitation links associated with Data Request.
                    items:
                      $ref: '#/components/schemas/link'
              example:
                - id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                  uri: https://link-stg.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
                  expires_at: 1675605305012
                  email_notification: true
                  sms_notification: false
                  status: ACTIVE
                  additional_message: null
                  expiry_reason: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/get_by_id:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Get the details of Data Request
      description: >
        Get the details of a Data Request. MeasureOne records various events for
        a Data Request. These events are summarized in the following table.



        ### Data Request Events


        |event|Description|

        |--- |--- |

        |DATAREQUEST_CREATED| Data Request created|

        |DATAREQUEST_UPDATED| Updated the details of Data Request|

        |DATAREQUEST_LINK_GENERATED| Data Request link generated|

        |NOTIFY_USER_REQUESTED| Email and/or SMS notification sent to user|

        |DATAREQUEST_LINK_EXTENDED| Link expiry time extended|

        |DATAREQUEST_LINK_EXPIRED| Link for Data Request expired|

        |DATAREQUEST_LINK_ACCESSED| Data Request link accessed by user|

        |WIDGET_INITIATED| Widget initiated for Data Request|

        |DATASOURCE_CLASSIFIED| Individual landed on login screen|

        |LOGIN_ATTEMPTED| Individual tried to login|

        |INVALID_CREDENTIALS| Credentials provided by user are invalid|

        |DATASOURCE_CONNECTED| Individual entered valid credentials and the Data
        Source is connected|

        |INSUFFICIENT_CREDENTIALS| Individual was not able to provide
        credentials|

        |ITEM_CREATED| Item was downloaded and stored database|

        |ITEM_PROCESSED| Data extracted and formatted|

        |ITEM_UNPROCESSABLE| Unable to process an item|

        |ITEMS_AVAILABLE| Data Extraction is completed with some items |

        |NO_ITEMS| Data Extraction is completed without an item|

        |USER_INTERVENTION_REQUIRED| Individual re-login required |

        |DATASOURCE_NOT_FOUND| Individual was unable to find Data Source|

        |PLAID_INITIATED| Plaid flow initiated|

        |PLAID_CONNECTION_SUCCESSFUL| Plaid connection successful|

        |PLAID_CONNECTION_UNSUCCESSFUL| Plaid connection unsuccessful|

        |REPORT_REQUESTED| Report requested by customer|

        |REPORT_AVAILABLE| Report data is available|

        |REPORT_ERROR| Error occurred during generating report|

        |UPDATES_AVAILABLE| Updated data for Data Request is available|

        |REFRESH_INITIATED| A scheduled refresh is initiated for Data Request|

        |REFRESH_FAILED| A scheduled refresh is failed for Data Request|

        |CONSENT_REGISTERED| Consent registered forData Request|  

        |CONSENT_DEREGISTER| Consent deregistered for Data Request| 

        |SESSION_TERMINATED| A session is terminated for Data Request|

        |SESSION_LOGGED_OUT| A session is logged out for Data Request|
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                  example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                get_x_auth_token_credentials:
                  type: boolean
                  description: >-
                    If this value is `true`, the response will contain
                    x_auth_token_credentials object.
                  default: false
                get_consent:
                  type: boolean
                  description: >-
                    If this value is `true`, the response will contain consent
                    object.
                  default: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/StaticDataRequest'
                  - $ref: '#/components/schemas/CustomDataRequest'
              examples:
                GET_DETAILS:
                  $ref: '#/components/examples/v3@datarequest@get_by_id'
                GET_DETAILS x_auth_token_credentials:
                  $ref: >-
                    #/components/examples/v3@datarequest@get_by_id_x_auth_token_credentials
                GET_DETAILS Consent:
                  $ref: '#/components/examples/v3@datarequest@get_by_id_consent'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Error_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/expire_invitation_link:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Expire invitation link for Data Request
      description: |
        Expires the invitation link for a data request.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - id
              properties:
                id:
                  type: string
                  description: MeasureOne recognized Unique ID of the Data Request
                  example: 1faOM8Q4efEWIjzdE2SBM2kLq4O
            examples:
              Expire_Data_Request_Invitation_link:
                $ref: '#/components/examples/v3@datarequest@expire'
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/get:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Get the list of Data Requests
      description: >
        Get the list of Data Requests based on the filter criteria provided. If
        not filter criteria is provided, it will fetch the latest 200 data
        requests.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  description: >-
                    Filters that can be applied to fetch the list of Data
                    Requests
                  properties:
                    status:
                      type: array
                      description: Status of the Invitations link you want to filter
                      items:
                        type: string
                        enum:
                          - ACTIVE
                          - USED
                          - EXPIRED
                    individual_id:
                      type: string
                      description: Unique ID of the Individual identified by MeasureOne
                    datasource_id:
                      type: array
                      description: >-
                        List of Data Sources for which you want to find the Data
                        Requests
                      items:
                        type: string
                    type:
                      type: array
                      description: Type of the Data Request
                      items:
                        type: string
                        description: Types of the Data Requests you want to filter
                        enum:
                          - ACADEMIC_SUMMARY
                          - ENROLLMENT_STATUS
                          - EMPLOYMENT_SUMMARY
                          - INCOME_SUMMARY
                          - HOME_INSURANCE_DETAILS
                          - AUTO_INSURANCE_DETAILS
                          - RENTERS_INSURANCE_DETAILS
                          - INCOME_EMPLOYMENT_DETAILS
                          - REALIZED_GAINS
                          - CUSTOM
                    name:
                      type: string
                      description: Full name of individual
                    external_id:
                      type: string
                      description: >-
                        A customer generated unique identifier linked to the
                        Individual
                    last_connection_status:
                      type: array
                      description: Data source connection status.
                      items:
                        type: string
                        enum:
                          - NOT_CONNECTED
                          - CONNECTED
                    last_connected_at:
                      description: Data source last connected timestamp (milliseconds)
                      oneOf:
                        - title: _eq
                          type: object
                          description: |
                            Matches values that are equal to a specified value.

                            Example: 
                            ```
                            {
                              "_eq": 1724324724000
                            }
                            ```
                          properties:
                            _eq:
                              type: number
                        - title: _ne
                          type: object
                          description: >
                            Matches all values that are not equal to a specified
                            value.


                            Example: Matches values that not equal to
                            1724324724000

                            ```

                            {
                              "_ne": 1724324724000
                            }

                            ```


                            Matches records where last_connected_at is not null

                            ```

                            {
                              "_ne": null
                            }

                            ```
                          properties:
                            _ne:
                              type: number
                        - title: _gt
                          type: object
                          description: >
                            Matches values that are greater than a specified
                            value.


                            Example:

                            ```

                            {
                              "_gt": 1724324724000
                            }

                            ```
                          properties:
                            _gt:
                              type: number
                        - title: _gte
                          type: object
                          description: >
                            Matches values that are greater than or equal to a
                            specified  value.


                            Example:

                            ```

                            {
                              "_gte": 1724324724000
                            }

                            ```
                          properties:
                            _gte:
                              type: number
                        - title: _lt
                          type: object
                          description: |
                            Matches values that are less than a specified value.

                            Example:
                            ```
                            {
                              "_lt": 1724324724000
                            }
                            ```
                          properties:
                            _lt:
                              type: number
                        - title: _lte
                          type: object
                          description: >
                            Matches values that are less than or equal to a
                            specified value.


                            Example:

                            ```

                            {
                              "_lte": 1724324724000
                            }

                            ```
                          properties:
                            _lte:
                              type: number
                    refresh_enabled:
                      type: boolean
                      description: >-
                        Status of refresh policy. Filter Data Request based on
                        the refresh policy.
                fields:
                  type: array
                  items:
                    type: string
                  description: >-
                    Fields you want in response. The default fields will be id,
                    created_at, event_logs, experience_id, individual_id,
                    invitation_links, reports, source_data_types, type
            examples:
              Get_Data_Request_by_Data_Request_Type:
                $ref: '#/components/examples/v3@datarequest@get_by_datarequest_type'
              Get_Data_Request_Multiple_filters:
                $ref: '#/components/examples/v3@datarequest@get_multiple_filters'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    description: List of data requests
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/StaticDataRequest'
                        - $ref: '#/components/schemas/CustomDataRequest'
                  rowCount:
                    type: integer
                    description: Total results
              examples:
                Get_list_of_Data_Requests:
                  $ref: '#/components/examples/v3@datarequest@get'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/update:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Update a Data Request
      description: |
        Update details of a Data Request
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatarequestUpdate'
            examples:
              Update_Data_Request:
                $ref: '#/components/examples/v3@datarequest@update'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: MeasureOne recognized Unique ID of the Data request
                    example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Error_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/refresh_now:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Refresh data on demand
      description: |
        Refresh data for a Data Request on demand.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: Single DataRequest
                  required:
                    - id
                  properties:
                    id:
                      type: string
                      description: Unique ID of the DataRequest identified by MeasureOne
                      example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                - title: List of DataRequests
                  maxItems: 1000
                  items:
                    required:
                      - id
                    properties:
                      id:
                        type: string
                        description: Unique ID of the DataRequest identified by MeasureOne
                        example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                  example:
                    - id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
      responses:
        '201':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@405'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/enable_refresh:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Enable refresh data for Data Requests
      description: |
        Enable Refresh data for Data Requests. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              maxItems: 1000
              items:
                required:
                  - id
                properties:
                  id:
                    type: string
                    description: Unique ID of the DataRequest identified by MeasureOne
                    example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                  refresh_policy:
                    type: object
                    description: Refresh Policy details to auto refresh data periodically
                    properties:
                      schedule:
                        oneOf:
                          - title: Daily
                            type: object
                            required:
                              - frequency
                            description: |
                              Refresh schedule to auto refresh data daily

                              Example: refresh daily
                              ```
                              {
                                "frequency": "DAILY"
                              }
                              ``` 
                            properties:
                              frequency:
                                type: string
                                description: Type of recurrence
                                enum:
                                  - DAILY
                                  - WEEKLY
                                  - MONTHLY
                          - title: Weekly
                            type: object
                            required:
                              - frequency
                              - by_weekday
                            description: |
                              Refresh schedule to auto refresh data Weekly

                              Example: refresh every week on Monday
                              ```
                              {
                                "frequency": "WEEKLY",
                                "by_weekday": ["MO"]              
                              }
                              ``` 
                            properties:
                              frequency:
                                type: string
                                description: Type of recurrence
                                enum:
                                  - DAILY
                                  - WEEKLY
                                  - MONTHLY
                              by_weekday:
                                type: array
                                description: >
                                  List of days of the week. `SU` indicates
                                  Sunday; `MO` indicates Monday; `TU` indicates
                                  Tuesday; `WE` indicates Wednesday; `TH`
                                  indicates Thursday; `FR` indicates Friday; and
                                  `SA` indicates Saturday.
                                items:
                                  type: string
                                  enum:
                                    - SU
                                    - MO
                                    - TU
                                    - WE
                                    - TH
                                    - FR
                                    - SA
                          - title: Monthly
                            type: object
                            required:
                              - frequency
                              - by_monthday
                            description: |
                              Refresh schedule to auto refresh data Monthly

                              Example: refresh every month on 15th
                              ```
                              {
                                "frequency": "MONTHLY",
                                "by_monthday": [15]
                              }
                              ``` 
                            properties:
                              frequency:
                                type: string
                                description: Type of recurrence
                                enum:
                                  - DAILY
                                  - WEEKLY
                                  - MONTHLY
                              by_monthday:
                                type: array
                                description: >
                                  List of days of the month. Valid values are 1
                                  to 31
                                items:
                                  type: number
                      effective_date:
                        type: number
                        description: Timestamp (milliseconds) when the refresh should start
                      end_date:
                        type: number
                        description: Timestamp (milliseconds) when the refresh should end
                      last_refresh_at:
                        type: number
                        description: >-
                          Timestamp (milliseconds) when the last refresh was
                          executed for the datarequest
                        readOnly: true
                      next_refresh_at:
                        type: number
                        description: >-
                          Timestamp (milliseconds) when the next refresh is
                          scheduled for the datarequest
                        readOnly: true
            examples:
              Enable_refresh_for_data_request:
                $ref: '#/components/examples/v3@datarequest@enable_refresh'
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@405'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/datarequests/disable_refresh:
    post:
      security:
        - Bearer: []
      tags:
        - Data Requests
      summary: Disable refresh data for Data Requests
      description: |
        Disable Refresh data for Data Requests. 
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              maxItems: 1000
              items:
                required:
                  - id
                properties:
                  id:
                    type: string
                    description: Unique ID of the DataRequest identified by MeasureOne
                    example: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
      responses:
        '200':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: Authentication with the API Failed
        '403':
          description: Forbidden
        '404':
          description: id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@405'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@500'
  /v3/experiences/upload_logo:
    post:
      summary: Upload logo
      security:
        - Bearer: []
      tags:
        - ExperiencesV3
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: Authorization API Key
          required: true
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            multipart/form-data format unless specified otherwise
          schema:
            type: string
            format: multipart/form-data
      requestBody:
        content:
          application/form-data-upload:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  description: >-
                    Path to file being uploaded. Extensions allowed `jpg`,
                    `jpeg`,`png`, `ico`, `webp`, `svg`
                  example: path/to/logo.png
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                properties:
                  file_uri:
                    description: URI of the file being uploaded.
                    type: string
              example:
                file_uri: m1://logo_2HGZRIwHPWCfqlEvcN27EY09aED.png
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655226381409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: BAD_REQUEST
                  error_message:
                    type: string
                    description: Details of the error
                    example: No file found to upload
                  http_code:
                    type: number
                    example: 400
        '403':
          description: Forbidden
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655226381409
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: UNSUPPORTED_MEDIA_TYPE
                  error_message:
                    type: string
                    description: Details of the error
                    example: 'Unsupported media type : crt'
                  http_code:
                    type: number
                    example: 415
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: API_ERROR
                  error_message:
                    type: string
                    description: Details of the error
                    example: Internal Server Error
                  http_code:
                    type: number
                    example: 500
  /v3/compliances/purge_individual:
    post:
      security:
        - Bearer: []
      tags:
        - ComplianceV3
      summary: Purge an Individual
      description: >
        Purge an Individual. Purging an Individual will also remove all
        associated data. MeasureOne will permanently purge the Individual and
        their data after 120 hours of receiving the request.
      parameters:
        - in: header
          name: version
          description: Version number of the MeasureOne API you wish to integrate.
          schema:
            type: number
        - in: header
          name: Authorization
          description: >-
            Authorization API Key. Provide [Purge
            Token](#tag/api-keys-and-access/purge-tokens).
          schema:
            type: string
            format: bearer <API_KEY>
        - in: header
          name: Content-type
          description: >-
            Content-type of the request payload. MeasureOne accepts content in
            application/json format unless specified otherwise
          schema:
            type: string
            format: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - individual_id
              properties:
                individual_id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
                delivery_details:
                  type: array
                  description: >-
                    List of endpoints to which the [webhooks](#tag/webhooks)
                    should be delivered
                  items:
                    required:
                      - event_type
                      - url
                    properties:
                      event_type:
                        type: string
                        description: Event for which you want a notification.
                        enum:
                          - individual.purged
                      url:
                        description: URL to which the webhook should be delivered
                        type: string
                        format: url
                      headers:
                        type: object
                        description: >-
                          Additional http headers that you may want to pass.
                          MeasureOne will send the data with content-type as
                          `application/json`
                        example:
                          content-type: application/json
                      x_auth_token_credentials:
                        description: >-
                          MeasureOne will generate the authorization token with
                          provided auth token credentials and use the generated
                          token while delivering webhooks.
                          `x_auth_token_credentials` details can be provided
                          when a fresh authorization token needs to be used when
                          MeasureOne delivers webhook.
                        type: object
                        required:
                          - token_type
                          - http_method
                          - url
                        properties:
                          token_type:
                            type: string
                            description: Type of token
                            enum:
                              - JWT
                          http_method:
                            type: string
                            description: Type of HTTP method
                            enum:
                              - POST
                          url:
                            type: string
                            format: url
                            description: Endpoint url to generate auth token
                            examples:
                              - https://sampledomain.com/generate_token
                          key_id:
                            type: string
                            description: >-
                              Unique ID of the Encryption key identified by
                              MeasureOne. `x_auth_token_credentials` holds
                              credentials details. So, `authorization` header
                              and `data` can be provided in encrypted form. When
                              `key_id` is provided then `authorization` header
                              and attributes value in `data` object will be
                              treated as encrypted. Please reach out to us on
                              support@mesureone.com to get your encryption
                              key_id setup.
                          headers:
                            type: object
                            description: >
                              Request body headers that you may want to pass
                              while calling endpoint.


                              MeasureOne supports two content-type
                              `application/json` and
                              `application/x-www-form-urlencoded` for generate
                              auth token endpoint. An unspecified content-type
                              will default to `application/json`
                          data:
                            type: object
                            description: >-
                              Data that we need to pass in body while calling
                              endpoint. attribute's value can be pass in
                              encrypted form when `key_id` is provided.
                          response_token_path:
                            type: string
                            description: >-
                              Path from response for token attribute. When
                              `response_token_path` is unspecified then complete
                              response will be used as auth token.
                            examples:
                              - access_token.token
            examples:
              Get_By_ID:
                $ref: '#/components/examples/v3@compliances@purge_individual'
      responses:
        '201':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Successful_Response:
                  $ref: '#/components/examples/v3@errors@400'
        '401':
          description: >-
            Authentication with the API Failed due to invalid token OR
            unauthorized scope / policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
        '403':
          description: Forbidden
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Individual_Not_found:
                  $ref: '#/components/examples/v3@errors@404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                    example: 1655227025839
                  error_code:
                    type: string
                    description: MeasureOne Error code
                    example: METHOD_NOT_ALLOWED
                  error_message:
                    type: string
                    description: Details of the error
                    example: Given Method not allowed
                  http_code:
                    type: number
                    example: 405
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: number
                    description: Timestamp in milliseconds
                  error_code:
                    type: string
                    description: MeasureOne Error code
                  error_message:
                    type: string
                    description: Details of the error
              examples:
                Internal_Server_Error:
                  $ref: '#/components/examples/v3@errors@500'
servers:
  - url: https://api.measureone.com
    description: Production
  - url: https://api-stg.measureone.com
    description: Staging
components:
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        Enter the token with the `Bearer: ` prefix, e.g. "Bearer \<\<Your API
        KEY\>\>".
    Basic:
      type: http
      scheme: basic
      description: >-
        Provide the Base64 representation of your `client_id:secret` e.g. "Basic
        \<\<BASE64\>\>".
    Internal:
      name: applicationId
      type: apiKey
      in: header
      description: Provide the application ID.
    None:
      name: None
      type: apiKey
      in: header
      description: No authorization is required
  schemas:
    Invitation:
      title: Invitation
      type: object
      required:
        - query_type
        - individual_id
      properties:
        id:
          type: string
          description: Unique ID of the Invitation identified by MeasureOne
          readOnly: true
        individual_id:
          type: string
          description: Unique ID of the Individual identified by MeasureOne
        url:
          type: string
          format: url
          readOnly: true
        created_at:
          description: Timestamp at which the invitation was created
          type: integer
          readOnly: true
        updated_at:
          description: Timestamp at which the invitation was last updated
          type: integer
          readOnly: true
        validity:
          description: >-
            Validity in seconds from the created Timestamp. Default is 259200
            seconds (3 days) from the created time stamp.
          type: number
          writeOnly: true
        expires_at:
          description: Timestamp at which the invitation expires
          type: integer
          readOnly: true
        status:
          description: Status of the invitation
          enum:
            - ACTIVE
            - USED
            - EXPIRED
            - COMPLETED
          readOnly: true
        expiry_reason:
          description: reason for expiration
          type: string
          readOnly: true
        link_only:
          type: boolean
          description: >-
            Boolean indicating whether to send communication to the Individual
            or just generate a link. Default is `false` and MeasureOne sends the
            Email Communication to the Individual. If `false`, `individual_id`
            is required.
        requestor_name:
          type: string
          description: Name of the requesting organization / entity
        additional_message:
          type: string
          maxLength: 1000
          description: >-
            Additional message that you may want to pass to the candidate in the
            invitation email. This attribute cannot be used when `link_only` is
            false.
        institution_name:
          type: string
          description: >-
            Institution name for which you want the candidate to complete
            verification.
        query_type:
          type: array
          items:
            type: string
            enum:
              - ACADEMIC_SUMMARY
              - ENROLLMENT_STATUS
              - EMPLOYMENT_SUMMARY
              - INCOME_SUMMARY
              - AUTO_INSURANCE_DETAILS
              - HOME_INSURANCE_DETAILS
              - INCOME_EMPLOYMENT_DETAILS
              - REALIZED_GAINS
    InvitationWithDatasource:
      title: Invitation with Datasource
      type: object
      required:
        - query_type
        - individual_id
      properties:
        id:
          type: string
          description: Unique ID of the Invitation identified by MeasureOne
          readOnly: true
        individual_id:
          type: string
          description: Unique ID of the Individual identified by MeasureOne
        url:
          type: string
          format: url
          readOnly: true
        created_at:
          description: Timestamp at which the invitation was created
          type: integer
          readOnly: true
        updated_at:
          description: Timestamp at which the invitation was last updated
          type: integer
          readOnly: true
        validity:
          description: >-
            Validity in seconds from the created Timestamp. Default is 259200
            seconds (3 days) from the created time stamp.
          type: number
          writeOnly: true
        expires_at:
          description: Timestamp at which the invitation expires
          type: integer
          readOnly: true
        status:
          description: Status of the invitation
          enum:
            - ACTIVE
            - USED
            - EXPIRED
            - COMPLETED
          readOnly: true
        expiry_reason:
          description: reason for expiration
          type: string
        link_only:
          type: boolean
          description: >-
            Boolean indicating whether to send communication to the Individual
            or just generate a link. Default is `false` and MeasureOne sends the
            Email Communication to the Individual. If `false`, `individual_id`
            is required.
        requestor_name:
          type: string
          description: Name of the requesting organization / entity
        additional_message:
          type: string
          description: >-
            Additional message that you may want to pass to the candidate in the
            invitation email. This attribute cannot be used when `link_only` is
            false.
        query_type:
          type: array
          items:
            type: string
            enum:
              - ACADEMIC_SUMMARY
              - ENROLLMENT_STATUS
              - EMPLOYMENT_SUMMARY
              - INCOME_SUMMARY
              - AUTO_INSURANCE_DETAILS
              - HOME_INSURANCE_DETAILS
              - INCOME_EMPLOYMENT_DETAILS
              - REALIZED_GAINS
        datasource:
          type: object
          properties:
            datasource_id:
              type: string
              description: The datasource id
            datasource_name:
              type: string
              description: Name of the datasource. Same as institute_name if present.
    Individual:
      title: Individual
      type: object
      description: Object representing details of an Individual identified by MeasureOne
      required:
        - first_name
        - last_name
        - email
      properties:
        id:
          type: string
          description: Unique ID of the Individual identified by MeasureOne
          readOnly: true
        external_id:
          type: string
          description: A customer generated unique identifier linked to the Individual
          maxLength: 45
        first_name:
          type: string
          description: First name of the Individual
          maxLength: 45
        middle_name:
          type: string
          description: Middle name of the Individual
          maxLength: 45
        last_name:
          type: string
          description: Last Name of the Individual
          maxLength: 45
        attending_name:
          type: string
          description: Attending name of the Individual
          maxLength: 45
        email:
          type: string
          description: Email address of the Individual
          maxLength: 255
        name_prefix:
          type: string
          description: Name prefix
          maxLength: 5
        name_suffix:
          type: string
          description: Name suffix
          maxLength: 5
        gender:
          type: string
          description: Gender of the Individual
          maxLength: 1
        date_of_birth:
          type: string
          description: Date of birth of the Individual in MM/DD/YYYY format.
          format: MM/DD/YYYY
          pattern: /(0[1-9]|1[012])[- \/.](0[1-9]|[12][0-9]|3[01])[- \/.](19|20)\d\d/
        phone_number:
          type: string
          description: Phone number of the Individual
          maxLength: 15
        address:
          type: object
          description: Address of the Individual
          required:
            - addr1
            - country
            - zipcode
          properties:
            addr1:
              type: string
              description: Address Line 1
              maxLength: 45
            addr2:
              type: string
              description: Address Line 2
              maxLength: 45
            city:
              type: string
              description: Name of the city
              maxLength: 45
            state_name:
              type: string
              description: Name of the state
              maxLength: 45
            zipcode:
              type: string
              description: zipcode
              maxLength: 10
            country:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the country
                  maxLength: 45
        last_activity_at:
          type: number
          readOnly: true
          description: Timestamp of the last activity recorded for the Individual
    IndividualParent:
      title: individual
      type: object
      description: >-
        Service APIs calls with datarequest_id and individual are asynchronous
        in nature. You can initiate a service by calling service API with
        datarequest_id and individual. Call Service APIs with transaction_id to
        get the results.
      required:
        - individual
      properties:
        individual:
          type: object
          description: Individual Details
          required:
            - individual_id
          properties:
            individual_id:
              type: string
              description: Unique ID of the individual identified by MeasureOne
            datasources:
              type: array
              items:
                type: string
              description: >-
                List of data sources for which the data needs to be retrieved.
                If the list is empty, the data will be retrieved for all the
                data sources
        metadata:
          type: object
          description: >-
            metadata can be used for storing additional information in a
            structured format. metadata will be sent in webhooks and report
            response.
    DataRequest:
      title: datarequest_id
      type: object
      required:
        - datarequest_id
      properties:
        datarequest_id:
          type: string
          description: Unique identifier for a datarequest.
    SourceDataValue:
      title: Source Data Value
      type: object
      properties:
        source_data_value:
          type: object
          description: >-
            Item Record in one of the [supported](#tag/m1_transcript_model)
            format
    SourceDataReference:
      title: Source Data Reference
      type: object
      required:
        - uri
        - media_type
      properties:
        uri:
          type: string
          description: >
            URI scheme for a remote document. The supported schemes include the
            M1 scheme, an internal scheme used to refer to internal MeasureOne
            resources. See below for examples. Supported Schemes: M1, HTTP,
            HTTPS, FTP, SFTP. Format:
            scheme:[//authority]path[?query][#fragment]
        media_type:
          type: string
          description: >
            Media type of the source data document Supported Types:
            application/pdf, application/json, image/jpeg, image/png,
            image/tiff, text/html
        http_method:
          type: string
          enum:
            - GET
            - POST
          description: Required for HTTP/S requests
        http_headers:
          type: object
          description: Required for HTTP/S requests
        http_body:
          type: object
          description: Required for HTTP/S requests
        file_name:
          type: string
        created_at:
          type: string
          readOnly: true
    SourceDataReferenceParent:
      title: Source Data Reference
      type: object
      properties:
        source_data_reference:
          $ref: '#/components/schemas/SourceDataReference'
    SourceData:
      title: Source Data Object
      type: object
      properties:
        referrer:
          type: string
      oneOf:
        - $ref: '#/components/schemas/SourceDataValue'
        - $ref: '#/components/schemas/SourceDataReferenceParent'
    M1_ACADEMIC_RECORD:
      summary: M1_TRANSCRIPT SCHEMA
      description: >-
        Represents an academic record of an Individual. In other words,
        M1_ACADEMIC_RECORD is an equivalent of a transcript comprising one or
        more degrees from the same educational institution. You can use the
        `items/get_by_id` endpoint to parse a transcript
      type: object
      properties:
        transcript_date:
          type: string
          format: MM/DD/YYYY
          description: >-
            Date on which the transcript was issued. `transcript_date` should
            not be a future date
        student_id:
          type: string
          description: Unique, school-provided Student ID
        other_attributes:
          type: object
          description: Any other Attributes which are not defined in M1 TRANSCRIPT
        student:
          type: object
          description: >-
            Object with information about the Individual, as provided on the
            transcript
          properties:
            first_name:
              type: string
              description: First name of the student
            last_name:
              type: string
              description: Last name of the student
            middle_name:
              type: string
              description: Middle name of the student
            prefix:
              type: string
              description: Prefix to the name
            suffix:
              type: string
              description: Suffix to the name
            full_name:
              type: string
              description: Full name of the student
            former_first_name:
              type: string
              description: Former first name
            former_middle_name:
              type: string
              description: Former middle name
            former_last_name:
              type: string
              description: Former last name
            former_full_name:
              type: string
              description: Former full name
            former_suffix:
              type: string
              description: Suffix to the former name
            former_prefix:
              type: string
              description: Prefix to the former name
            date_of_birth:
              type: string
              description: Birthdate of the student
            ssn:
              type: string
              description: SSN of the student
            email:
              type: string
              description: Email address of the student, as provided on the transcript
            address:
              type: object
              description: Student's Address information as provided on the transcript
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  description: Country information
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        pgc:
          type: array
          description: List of parent/guardian/counselor information on the transcript
          items:
            properties:
              individual_type:
                type: string
                description: Type of Individual. Enum `PARENT_GUARDIAN`, `COUNSELOR`
              first_name:
                type: string
                description: First name of the Individual
              last_name:
                type: string
                description: Last name of the Individual
              middle_name:
                type: string
                description: Middle name of the Individual
              prefix:
                type: string
                description: Prefix to the name
              suffix:
                type: string
                description: Suffix to the name
              full_name:
                type: string
                description: Full name of the Individual
              former_first_name:
                type: string
                description: Former first name
              former_middle_name:
                type: string
                description: Former middle name
              former_last_name:
                type: string
                description: Former last name
              former_full_name:
                type: string
                description: Former full name
              former_suffix:
                type: string
                description: Suffix to the former name
              former_prefix:
                type: string
                description: Prefix to the former name
              date_of_birth:
                type: string
                description: Birthdate of the Individual
              ssn:
                type: string
                description: SSN of the Individual
              email:
                type: string
                description: Email address of the Individual, as provided on the transcript
              address:
                type: object
                description: Individual's Address information as provided on the transcript
                properties:
                  addr1:
                    type: string
                    description: Address line 1
                  addr2:
                    type: string
                    description: >-
                      Address line 2. Should be populated only if `addr1` is
                      populated
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode for the address
                  country:
                    type: object
                    description: Country information
                    properties:
                      name:
                        type: string
                        description: Name of the country
                      a2_code:
                        type: string
                        description: Alpha-2 code for the country from ISO 3166
        immunizations:
          type: array
          description: List of immunization provided on the transcript
          items:
            properties:
              code:
                type: string
                description: Code identifying the type of immunization
              name:
                type: string
                description: Name of the immunization
              date:
                type: string
                description: Immunization date
              status_code:
                type: string
                description: >-
                  Code identifying the status of immunization conducted on
                  student
              report_type_code:
                type: string
                description: >-
                  Code identifying the record used to verify immunization of
                  student
        test_records:
          type: array
          description: >-
            List of national, regional, state, or local test records provided on
            the transcript
          items:
            properties:
              name:
                type: string
                description: Name of the test
              date:
                type: string
                description: Test date
              code:
                type: string
                description: Code identifying the type of test
              subsets:
                type: array
                description: List of subsets provided on the transcript
                items:
                  properties:
                    name:
                      type: string
                      description: Name of the subset
                    score:
                      type: string
                      description: Test score
                    score_qualifier:
                      type: string
                      description: >-
                        Code indicating the manner in which the test score
                        result is reported
        previous_academic_record:
          type: array
          description: List of previous academic records provided on the transcript
          items:
            properties:
              name:
                type: string
                description: Name of the institution
              id_type:
                type: string
                description: ID Type of the institutionEnum `IPEDS`, `CEEB`
              id:
                type: string
                description: Unique identifier of the institution
              start_date:
                type: string
                description: Start date of the program
              end_date:
                type: string
                description: End date of the program
              address:
                type: object
                description: >-
                  Student's Address information as provided for previous
                  academic record
                properties:
                  addr1:
                    type: string
                    description: Address line 1
                  addr2:
                    type: string
                    description: >-
                      Address line 2. Should be populated only if `addr1` is
                      populated
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode for the address
                  country:
                    type: object
                    description: Country information
                    properties:
                      name:
                        type: string
                        description: Name of the country
                      a2_code:
                        type: string
                        description: Alpha-2 code for the country from ISO 3166
              degrees:
                type: array
                description: List of degrees found in this academic record
                items:
                  properties:
                    type:
                      type: string
                      description: >-
                        Level of the degree. Enum `HIGH-SCHOOL-DIPLOMA`,
                        `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`,
                        `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`,
                        `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`
                    description:
                      type: string
                      description: Name of the degree
                    status:
                      type: string
                      description: >-
                        Status of the degree. Enum `AWARDED`, `ENROLLED`,
                        `WITHDRAWN`, `TERMINATED`, `UNKNOWN`
                    awarded_date:
                      type: string
                      description: Degree awarded date (applicable to graduates only)
                    years_of_study:
                      type: number
                      description: Number of years of study for the given degree
                    other_attributes:
                      type: object
                    academic_summary:
                      type: array
                      description: Summary information about the degree
                      items:
                        properties:
                          credit_type:
                            type: string
                            description: >-
                              Type of credit used. Enum `SEMESTER`, `QUARTER`,
                              `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`,
                              `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`,
                              `OTHER`
                          level:
                            type: string
                            description: >-
                              The level of the academic summary. Enum
                              `INSTITUTION`, `TRANSFER`, `TOTAL`
                          cumulative:
                            type: boolean
                            description: >-
                              Boolean indicating whether the summary is
                              cumulative
                          gpa_credits:
                            type: number
                            description: >-
                              Credits attempted on courses that are included in
                              the GPA calculation. Should be a non negative
                              number, if available
                          attempted:
                            type: number
                            description: >-
                              Credits attempted. Should be a non negative
                              number, if available
                          earned:
                            type: number
                            description: >-
                              Credits earned. Should be a non negative number,
                              if available
                          gpa_range:
                            type: object
                            description: GPA range for School/University
                            properties:
                              minimum:
                                type: number
                                description: minimum value for GPA
                              maximum:
                                type: number
                                description: maximum value for GPA
                          gpa:
                            type: number
                            description: >-
                              Grade Point Average. Should be a non negative
                              number, if available
                          quality_points:
                            type: number
                            description: >-
                              Quality points for grade, used in GPA calculation.
                              Should be a non negative number, if available
                          student_rank:
                            type: number
                            description: Student rank
                          class_size:
                            type: number
                            description: Number of students in the class
                          rank_date:
                            type: string
                            description: Class rank date
                          days_attended:
                            type: string
                            description: Days student attended class
                          days_absent:
                            type: string
                            description: Days student absent in class
                    field_of_study:
                      type: array
                      description: >-
                        List of objects with information about the field of
                        study
                      items:
                        properties:
                          type:
                            type: string
                            description: >-
                              Type of study. Enum
                              `MAJOR`,`MINOR`,`CONCENTRATION`
                          description:
                            type: string
                            description: Name of the field of study
                          code_type:
                            type: string
                            description: >-
                              Type of the code used for identifying the field of
                              study E.g. CIP, HEGIS, OTHER
                          code:
                            type: number
                            description: >-
                              Specifies the code for the field of study
                              associated with the academic record.
        transcript_institution:
          deprecated: true
          type: object
          description: >-
            Object with information about the institution for which the
            transcript was issued
          properties:
            name:
              type: string
              description: Name of the institution
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            id:
              type: string
              description: Unique identifier of the institute
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  description: Country information
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
            other_attributes:
              type: object
        teaching_institution:
          type: object
          description: >-
            Object with information about the teaching institution for which the
            transcript was issued
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        degree_awarding_institution:
          type: object
          description: >-
            Object with information about the degree awarding institution for
            which the transcript was issued
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        academic_summary:
          type: array
          description: Summary information about the degree
          items:
            properties:
              credit_type:
                type: string
                description: >-
                  Type of credit used. Enum `SEMESTER`, `QUARTER`, `UNITS`,
                  `CLOCK_HOURS`, `CARNEGIE_UNITS`, `CONTINUING_EDUCATION_UNIT`,
                  `HIGHSCHOOL_CREDIT`, `OTHER`
              level:
                type: string
                description: >-
                  The level of the academic summary. Enum `INSTITUTION`,
                  `TRANSFER`, `TOTAL`
              cumulative:
                type: boolean
                description: Boolean indicating whether the summary is cumulative
              gpa_credits:
                type: number
                description: >-
                  Credits attempted on courses that are included in the GPA
                  calculation. Should be a non negative number, if available
              attempted:
                type: number
                description: >-
                  Credits attempted. Should be a non negative number, if
                  available
              earned:
                type: number
                description: Credits earned. Should be a non negative number, if available
              gpa_range:
                type: object
                description: GPA scale for School/University
                properties:
                  minimum:
                    type: number
                    description: minimum range for GPA
                  maximum:
                    type: number
                    description: maximum range for GPA
              gpa:
                type: number
                description: >-
                  Grade Point Average. Should be a non negative number, if
                  available
              quality_points:
                type: number
                description: >-
                  Quality points for grade, used in GPA calculation. Should be a
                  non negative number, if available
              student_rank:
                type: number
                description: Student rank
              class_size:
                type: number
                description: Number of students in the class
              rank_date:
                type: string
                description: Class rank date
              days_attended:
                type: string
                description: Days student attended class
              days_absent:
                type: string
                description: Days student absent in class
        academic_sessions:
          type: array
          description: List of academic sessions provided on the transcript
          items:
            properties:
              type:
                type: string
                description: >-
                  Type of session E.g. SEMESTER, TRIMESTER, QUARTER, FULL_YEAR,
                  MINI_TERM, SUMMER_SESSION, UNKNOWN
              name:
                type: string
                description: Name of the session E.g. Fall 2012
              start_date:
                type: string
                description: Start Date of the session
              end_date:
                type: string
                description: End Date of the session
              in_progress:
                type: boolean
                description: >-
                  Boolean indicating whether the session is in-progress at the
                  time of transcript_date
              level:
                type: string
                description: >-
                  Grade Level or Academic Level of the Individual for the
                  session
              honors:
                type: array
                description: >-
                  Academic honors or awards for the session E.g.  Cum Laude,
                  Summa Cum Laude, Magna Cum Laude
                items:
                  type: string
              curriculum_code_type:
                type: string
                description: >-
                  Type of the code used for identifying curriculum E.g. CIP,
                  HEGIS, OTHER
              curriculum_code:
                type: string
                description: >-
                  Code identifying the program in which the Individual is
                  enrolled for this session
              curriculum_name:
                type: string
                description: >-
                  Name of the program in which the Individual is enrolled for
                  this session
              academic_summary:
                type: array
                description: Summary information about the degree
                items:
                  properties:
                    credit_type:
                      type: string
                      description: >-
                        Type of credit used. Enum `SEMESTER`, `QUARTER`,
                        `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`,
                        `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`,
                        `OTHER`
                    level:
                      type: string
                      description: >-
                        The level of the academic summary. Enum `INSTITUTION`,
                        `TRANSFER`, `TOTAL`
                    cumulative:
                      type: boolean
                      description: Boolean indicating whether the summary is cumulative
                    gpa_credits:
                      type: number
                      description: >-
                        Credits attempted on courses that are included in the
                        GPA calculation. Should be a non negative number, if
                        available
                    attempted:
                      type: number
                      description: >-
                        Credits attempted. Should be a non negative number, if
                        available
                    earned:
                      type: number
                      description: >-
                        Credits earned. Should be a non negative number, if
                        available
                    gpa_range:
                      type: object
                      description: GPA range for School/University
                      properties:
                        minimum:
                          type: number
                          description: minimum value for GPA
                        maximum:
                          type: number
                          description: maximum value for GPA
                    gpa:
                      type: number
                      description: >-
                        Grade Point Average. Should be a non negative number, if
                        available
                    quality_points:
                      type: number
                      description: >-
                        Quality points for grade, used in GPA calculation.
                        Should be a non negative number, if available
                    student_rank:
                      type: number
                      description: Student rank
                    class_size:
                      type: number
                      description: Number of students in the class
                    rank_date:
                      type: string
                      description: Class rank date
                    days_attended:
                      type: string
                      description: Days student attended class
                    days_absent:
                      type: string
                      description: Days student absent in class
              courses:
                type: array
                description: >-
                  List of courses taken in this academic session. At least one
                  of the academic sessions should have courses object
                items:
                  properties:
                    credit_basis:
                      type: string
                      description: >-
                        Indicates the method of credits earned for the course.
                        Enum `REGULAR_ENROLLMENT` `TRANSFER`
                        `ADVANCED_PLACEMENT`
                    honors_course:
                      type: boolean
                      description: Indicates if it is honors course or not
                    repeated:
                      type: boolean
                      description: If the course was repeated by the Individual
                    count_in_gpa:
                      type: boolean
                      description: >-
                        If the course performance is counted in gpa calculation
                        or not
                    code_type:
                      type: string
                      description: >-
                        Code designating the system/method of code structure
                        used for Identification Code used to describe the
                        content of the course. Enum `CIP`, `HEGIS`, `OTHER`,
                        `UNKNOWN`
                    code:
                      type: string
                      description: Course code information as presented on the transcript
                    id:
                      type: string
                      description: Course ID as presented on the transcript
                    name:
                      type: string
                      description: Free-form name to describe the content of the course
                    instructional_setting:
                      type: string
                      description: >-
                        Type of instructional setting in which a program is
                        provided
                    start_date:
                      type: string
                      description: Course start date
                    end_date:
                      type: string
                      description: Course end date
                    other_attributes:
                      type: object
                    credits:
                      type: object
                      description: >-
                        Object with information related to credits for the
                        course
                      properties:
                        credit_type:
                          type: string
                          description: >-
                            Type of credit used. Enum `SEMESTER`, `QUARTER`,
                            `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`,
                            `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`,
                            `OTHER`. For a valid credits object, credit_type is
                            mandatory
                        gpa_credits:
                          type: number
                          description: >-
                            Credits attempted on courses that are included in
                            the GPA calculation. Should be a non negative
                            number, if available
                        attempted:
                          type: number
                          description: >-
                            Credits attempted on courses that are included in
                            the GPA calculation. Should be a non negative
                            number, if available
                        earned:
                          type: number
                          description: >-
                            Credits earned. Should be a non negative number, if
                            available
                        quality_points:
                          type: number
                          description: >-
                            Quality points for grade, used in GPA calculation.
                            Should be a non negative number, if available
                        grade_qualifier:
                          type: string
                          description: >-
                            The grading scale used by an academic institution
                            for the course.
                        grade:
                          type: string
                          description: >-
                            Indicates the grade that an Individual received for
                            participation in the course.
                    marks_awarded:
                      type: array
                      description: >-
                        Indicates the series of marks that an Individual
                        received for participation in the course.
                      items:
                        properties:
                          grade:
                            type: string
                            description: >-
                              Indicates the grade that an Individual received
                              for participation in the course.
                          grade_qualifier:
                            type: string
                            description: >-
                              The grading scale used by an academic institution
                              for the course.
                          period:
                            type: string
                            description: Indicates the period for which mark awarded
              degrees:
                type: array
                description: List of degrees found in this academic record
                items:
                  properties:
                    description:
                      type: string
                      description: Name of the degree
                    type:
                      type: string
                      description: >-
                        Level of the degree. Enum  `HIGH-SCHOOL-DIPLOMA`,
                        `ASSOCIATE`, `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`,
                        `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`,
                        `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`
                    status:
                      type: string
                      description: >-
                        Status of the degree. Enum `AWARDED`, `ENROLLED`,
                        `WITHDRAWN`, `TERMINATED`, `UNKNOWN`
                    awarded_date:
                      type: string
                      description: Degree awarded date (applicable to graduates only)
                    years_of_study:
                      type: number
                      description: Number of years of study for the given degree
                    other_attributes:
                      type: object
                    academic_summary:
                      type: array
                      description: Summary information about the degree
                      items:
                        properties:
                          credit_type:
                            type: string
                            description: >-
                              Type of credit used. Enum `SEMESTER`, `QUARTER`,
                              `UNITS`, `CLOCK_HOURS`, `CARNEGIE_UNITS`,
                              `CONTINUING_EDUCATION_UNIT`, `HIGHSCHOOL_CREDIT`,
                              `OTHER`
                          level:
                            type: string
                            description: >-
                              The level of the academic summary. Enum
                              `INSTITUTION`, `TRANSFER`, `TOTAL`
                          cumulative:
                            type: boolean
                            description: >-
                              Boolean indicating whether the summary is
                              cumulative
                          gpa_credits:
                            type: number
                            description: >-
                              Credits attempted on courses that are included in
                              the GPA calculation. Should be a non negative
                              number, if available
                          attempted:
                            type: number
                            description: >-
                              Credits attempted. Should be a non negative
                              number, if available
                          earned:
                            type: number
                            description: >-
                              Credits earned. Should be a non negative number,
                              if available
                          gpa_range:
                            type: object
                            description: GPA range for School/University
                            properties:
                              minimum:
                                type: number
                                description: minimum value for GPA
                              maximum:
                                type: number
                                description: maximum value for GPA
                          gpa:
                            type: number
                            description: >-
                              Grade Point Average. Should be a non negative
                              number, if available
                          quality_points:
                            type: number
                            description: >-
                              Quality points for grade, used in GPA calculation.
                              Should be a non negative number, if available
                          student_rank:
                            type: number
                            description: Student rank
                          class_size:
                            type: number
                            description: Number of students in the class
                          rank_date:
                            type: string
                            description: Class rank date
                          days_attended:
                            type: string
                            description: Days student attended class
                          days_absent:
                            type: string
                            description: Days student absent in class
                    field_of_study:
                      type: array
                      description: >-
                        List of objects with information about the field of
                        study
                      items:
                        properties:
                          type:
                            type: string
                            description: >-
                              Type of study. Enum
                              `MAJOR`,`MINOR`,`CONCENTRATION`
                          description:
                            type: string
                            description: Name of the field of study
                          code_type:
                            type: string
                            description: >-
                              Type of the code used for identifying the field of
                              study E.g. CIP, HEGIS, OTHER
                          code:
                            type: string
                            description: >-
                              Specifies the code for the field of study
                              associated with the academic record.
              other_attributes:
                type: object
    M1_DIGEST:
      title: M1_DIGEST Schema
      type: object
      required:
        - degree_type
        - years_in_school
        - min_grade
        - cgpa
        - last_term_gpa
        - credits_earned
      properties:
        degree_type:
          type: string
          description: >-
            Granular level of study. Enum `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`,
            `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`,
            `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`,
            `UNDERGRADUATE`
        years_in_school:
          type: number
          format: double
          description: >-
            Number of years that the Individual has been enrolled, including any
            breaks between enrollments. Non-zero, non-negative, rounded to two
            decimals
        min_grade:
          type: string
          description: Lowest grade earned on a course taken
        cgpa:
          type: number
          format: double
          description: >-
            Weighted CGPA, in the 0 to 4 scale, for the combination of courses
            attended at the transcript-issuing school
        last_term_gpa:
          type: number
          format: double
          description: GPA, in the 0 to 4 scale, for the last term of attendance
        credits_earned:
          type: number
          format: double
          description: >-
            Total credits earned including transferred credits, converted to a
            standard semester credit hour system
      example:
        degree_type: BACHELORS
        years_in_school: 4
        min_grade: D
        cgpa: 3
        last_term_gpa: 2
        credits_earned: 65
    M1_INCOME_EMPLOYMENT_RECORD:
      title: M1_INCOME_EMPLOYMENT_RECORD Schema
      type: object
      description: |
        Representation of the Income Employment record for an individual
      properties:
        record_date:
          type: string
          description: Date on which the record was generated
          format: MM/DD/YYYY
        pay_date:
          type: string
          description: Payment date
          format: MM/DD/YYYY
        interval:
          type: object
          description: Interval for which the income employment details is denoted
          properties:
            start_date:
              type: string
              description: start date of the interval
              format: MM/DD/YYYY
            end_date:
              type: string
              description: end date of the interval
              format: MM/DD/YYYY
        employee:
          type: object
          description: Details about the employee
          properties:
            service_details:
              type: object
              description: Service details of the employee
              properties:
                employee_id:
                  type: string
                  description: employee_id provided by the employer
                hire_date:
                  type: string
                  description: Hire date of the employee
                  format: MM/DD/YYYY
                status:
                  type: string
                  description: Status of employee with the employer
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - TERMINATED
                    - UNKNOWN
                salary:
                  type: number
                  description: Salary of the employee
                salary_basis:
                  type: string
                  description: Basis of salary
                  enum:
                    - HOURLY
                    - MONTHLY
                    - SEMI_MONTHLY
                    - WEEKLY
                    - BI_WEEKLY
                    - ANNUAL
                    - OTHER
                termination_date:
                  type: string
                  description: Termination date of the employee
                  format: MM/DD/YYYY
                termination_reason:
                  type: string
                  description: Termination reason
            first_name:
              type: string
              description: First name of the employee
              maxLength: 45
            middle_name:
              type: string
              description: Middle name of the employee
              maxLength: 45
            last_name:
              type: string
              description: Last Name of the employee
              maxLength: 45
            email:
              type: string
              description: Email address of the employee
            prefix:
              type: string
              description: Name prefix
              maxLength: 5
            suffix:
              type: string
              description: Name suffix
              maxLength: 5
            gender:
              type: string
              description: Gender of the employee
              maxLength: 1
            date_of_birth:
              type: string
              description: Date of Birth of the employee in MM/DD/YYYY format.
              format: MM/DD/YYYY
              pattern: >-
                /(0[1-9]|1[012])[- \/.](0[1-9]|[12][0-9]|3[01])[-
                \/.](19|20)\d\d/'
            phone_number:
              type: string
              description: Phone number of the employee
            ssn:
              type: string
              description: SSN of the employee
            address:
              type: object
              description: Address of the employee
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  description: Country information
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country
        employer:
          type: object
          description: Details about the employer
          properties:
            name:
              type: string
              description: Name of the employer
            phone_number:
              type: string
              description: Phone number of the employer
            address:
              type: object
              description: Address of the employer
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  description: Country information
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country
        roles:
          type: array
          description: >-
            Array of objects representing roles of an Individual during their
            employment
          items:
            properties:
              position:
                type: object
                description: Position details of an Individual
                properties:
                  name:
                    type: string
                    description: Name of the position
                  title:
                    type: string
                    description: Title of the position
              type:
                type: string
                description: Type of position
                enum:
                  - FULL_TIME
                  - PART_TIME
                  - CONTRACT
                  - OTHER
              supervisor:
                type: string
                description: Name of supervisor
              interval:
                type: object
                description: Interval details for the role
                properties:
                  start_date:
                    type: string
                    description: start date of the interval
                    format: MM/DD/YYYY
                  end_date:
                    type: string
                    description: end date of the interval
                    format: MM/DD/YYYY
              location:
                type: object
                description: Location details for the role
                properties:
                  name:
                    type: string
                    description: Name of location
                  address:
                    type: object
                    description: Address of the location
                    properties:
                      addr1:
                        type: string
                        description: Address Line 1
                      addr2:
                        type: string
                        description: Address Line 2
                      city:
                        type: string
                        description: City
                      state:
                        type: string
                        description: State
                      zipcode:
                        type: string
                        description: Zipcode for the address
                      country:
                        type: object
                        description: Country information
                        properties:
                          name:
                            type: string
                            description: Name of the country
                          a2_code:
                            type: string
                            description: Alpha-2 code for the country
                  department:
                    type: string
                    description: Department during the deployment
        earnings:
          type: array
          description: Array of objects representing earnings
          items:
            properties:
              type:
                type: string
                description: Type of the earnings
                enum:
                  - SALARY
                  - WAGE
                  - INVESTMENT
                  - RENTAL
                  - COMMISSION
                  - INTEREST
                  - GIFTS
                  - ALLOWANCE
                  - GOVERNMENT_PAYMENT
                  - DIVIDENDS
                  - RETIREMENT_PENSION
                  - TAX_REFUND
                  - UNEMPLOYMENT
                  - TRANSFER_IN
                  - OTHER_DEPOSITS
                  - OTHER
              basis:
                type: string
                description: Basis unit of the payment
                enum:
                  - HOURLY
                  - MONTHLY
                  - SEMI_MONTHLY
                  - WEEKLY
                  - ANNUAL
                  - BI_WEEKLY
                  - OTHER
              interval:
                type: object
                description: Interval for which the earnings is denoted
                properties:
                  start_date:
                    type: string
                    description: start date of the interval
                    format: MM/DD/YYYY
                  end_date:
                    type: string
                    description: end date of the interval
                    format: MM/DD/YYYY
              amounts:
                type: array
                description: Array of objects representing earning amounts
                items:
                  properties:
                    currency:
                      type: string
                      description: Currency of the payment
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of earning
                      enum:
                        - GROSS
                        - NET
                        - REGULAR
                        - OVERTIME
                        - BONUS
                        - COMMISSION
                        - OTHER
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of earning amount
                    description:
                      type: string
                      description: Description of amount
                    rate:
                      type: number
                      description: Pay rate of the employee
                    hours:
                      type: string
                      description: Number of hours worked
        deductions:
          type: array
          description: Deductions of the employee
          items:
            properties:
              type:
                type: string
                description: Type of deduction
                enum:
                  - OTHER
              interval:
                type: object
                description: Interval for which the deduction is denoted
                properties:
                  start_date:
                    type: string
                    description: start date of the interval
                    format: MM/DD/YYYY
                  end_date:
                    type: string
                    description: end date of the interval
                    format: MM/DD/YYYY
              amounts:
                type: array
                description: Array of objects representing deduction amounts
                items:
                  properties:
                    currency:
                      type: string
                      description: Currency of the deduction
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of deduction
                      enum:
                        - OTHER
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of deduction amount
        deposits:
          type: array
          description: Employee Deposits
          items:
            type: object
            properties:
              method:
                type: string
                description: Type of Deposit
                enum:
                  - DIRECT_DEPOSIT
                  - OTHER
              account_name:
                type: string
                description: Name of account
              account_number:
                type: string
                description: Bank account number
              transit_number:
                type: string
                description: Transit number of the bank
              account_type:
                type: string
                description: Type of account
                enum:
                  - CHECKING
                  - SAVING
                  - OTHER
              amount:
                type: object
                description: Amount of the deposits
                properties:
                  currency:
                    type: string
                    description: Currency of the amount. e.g. `USD`, `CAD`
                  value:
                    type: number
                    description: Value of deposited amount
        benefits:
          type: array
          description: Benefits for the employee
          items:
            properties:
              type:
                type: string
                description: Type of benefit
                enum:
                  - OTHER
              interval:
                type: object
                description: Interval for which the benefit is denoted
                properties:
                  start_date:
                    type: string
                    description: start date of the interval
                    format: MM/DD/YYYY
                  end_date:
                    type: string
                    description: end date of the interval
                    format: MM/DD/YYYY
              amounts:
                type: array
                description: Array of objects representing benefit amounts
                items:
                  properties:
                    currency:
                      type: string
                      description: Currency of the benefit
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of benefit
                      enum:
                        - OTHER
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of benefit amount
    M1_W2_RECORD:
      type: object
      properties:
        allocated_tips:
          type: string
          description: Tips allocated to the employee by the employer.
        employee:
          type: object
          properties:
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  description: Postal code of the employee's address.
                country:
                  type: object
                  properties:
                    a2_code:
                      type: string
                      description: ISO 3166-1 alpha-2 country code.
                    name:
                      type: string
                      description: Name of the country.
                addr2:
                  type: string
                  description: Additional address line.
                addr1:
                  type: string
                  description: Primary address line.
                city:
                  type: string
                  description: City of the employee's address.
                state:
                  type: string
                  description: State of the employee's address.
            gender:
              type: string
              description: Gender of the employee.
            prefix:
              type: string
              description: Prefix of the employee's name (e.g., Mr., Ms.).
            date_of_birth:
              type: string
              description: Date of birth of the employee.
            last_name:
              type: string
              description: Last name of the employee.
            middle_name:
              type: string
              description: Middle name of the employee.
            suffix:
              type: string
              description: Suffix of the employee's name (e.g., Jr., Sr.).
            ssn:
              type: string
              description: Social Security Number of the employee.
            marital_status:
              type: string
              description: Marital status of the employee.
            full_name:
              type: string
              description: Full name of the employee.
            nationality:
              type: string
              description: Nationality of the employee.
            phone_number:
              type: string
              description: Phone number of the employee.
            first_name:
              type: string
              description: First name of the employee.
            email:
              type: string
              description: Email address of the employee.
        social_security_tips:
          type: string
          description: Tips subject to Social Security tax.
        local_wages_tips:
          type: string
          description: Local wages and tips.
        control_number:
          type: string
          description: Control number assigned by the employer.
        federal_income_tax_withheld:
          type: object
          properties:
            amount:
              type: number
              description: Amount of federal income tax withheld.
            currency:
              type: string
              description: Currency of the amount.
        medicare_tax_withheld:
          type: object
          properties:
            amount:
              type: number
              description: Amount of Medicare tax withheld.
            currency:
              type: string
              description: Currency of the amount.
        employer:
          type: object
          properties:
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  description: Postal code of the employer's address.
                country:
                  type: object
                  properties:
                    a2_code:
                      type: string
                      description: ISO 3166-1 alpha-2 country code.
                    name:
                      type: string
                      description: Name of the country.
                addr2:
                  type: string
                  description: Additional address line.
                addr1:
                  type: string
                  description: Primary address line.
                city:
                  type: string
                  description: City of the employer's address.
                state:
                  type: string
                  description: State of the employer's address.
            name:
              type: string
              description: Name of the employer.
            phone_number:
              type: string
              description: Phone number of the employer.
            employer_id:
              type: string
              description: Employer identification number.
        box_13:
          type: object
          properties:
            statutory_employee:
              type: boolean
              description: Indicates if the employee is a statutory employee.
            third_party_sick_pay:
              type: boolean
              description: Indicates if the employee received third-party sick pay.
            retirement_plan:
              type: boolean
              description: Indicates if the employee is part of a retirement plan.
        box_12:
          type: array
          description: Box 12 items, including codes and amounts.
        state:
          type: string
          description: State code for state wages and taxes.
        box_9:
          type: string
          description: Verification code for employment-based verification.
        dependent_care_benefits:
          type: string
          description: Dependent care benefits provided by the employer.
        box_14_other:
          type: string
          description: Other amounts reported in Box 14.
        record_year:
          type: integer
          description: Year for which the record is applicable.
        state_wages_tips:
          type: object
          properties:
            amount:
              type: number
              description: Amount of state wages and tips.
            currency:
              type: string
              description: Currency of the amount.
        wages_tips_other_comp:
          type: object
          properties:
            amount:
              type: number
              description: Amount of wages, tips, and other compensation.
            currency:
              type: string
              description: Currency of the amount.
        nonqualified_plans:
          type: string
          description: Nonqualified plans amount.
        social_security_wages:
          type: object
          properties:
            amount:
              type: number
              description: Amount of wages subject to Social Security tax.
            currency:
              type: string
              description: Currency of the amount.
        social_security_tax_withheld:
          type: object
          properties:
            amount:
              type: number
              description: Amount of Social Security tax withheld.
            currency:
              type: string
              description: Currency of the amount.
        locality_name:
          type: string
          description: Name of the locality for local wages and taxes.
        medicare_wages_and_tips:
          type: object
          properties:
            amount:
              type: number
              description: Amount of wages and tips subject to Medicare tax.
            currency:
              type: string
              description: Currency of the amount.
        employer_state_id_number:
          type: string
          description: Employer's state identification number.
        state_income_tax:
          type: object
          properties:
            amount:
              type: integer
              description: Amount of state income tax withheld.
            currency:
              type: string
              description: Currency of the amount.
        local_income_tax:
          type: string
          description: Amount of local income tax withheld.
    M1_INSURANCE_RECORD:
      title: M1_INSURANCE_RECORD Schema
      summary: M1_INSURANCE_RECORD SCHEMA
      type: object
      properties:
        record_date:
          type: string
          description: Date on which the record was generated
        cancelled_date:
          type: string
          description: Date on which the insurance was cancelled
        pending_cancel_date:
          type: string
          description: Date on which the insurance will be cancelled
        policy_number:
          type: string
          description: Policy number
        status:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
            - PENDING_ACTIVATION
            - PENDING_CANCELLATION
            - PENDING_EXPIRATION
            - CANCELLED
            - UNVERIFIED
            - RESCINDED
            - NOT_AVAILABLE
          description: Policy status
        policy_types:
          type: array
          items:
            type: string
            enum:
              - AUTO
              - HOME
              - RENTERS
              - PERSONAL_UMBRELLA
          description: Type of Policy
        premium_amount:
          type: object
          description: Premium amount of policy
          properties:
            currency:
              type: string
              description: Currency of premium amount. e.g. `USD`, `CAD`
            amount:
              type: number
              description: Premium amount
        payment_frequency:
          type: string
          description: Frequency of payment.
          enum:
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTERLY
            - MONTHLY
            - SEMI_MONTHLY
            - OTHER
        coverage_period:
          type: object
          description: Insurance coverage period
          properties:
            start_date:
              type: string
              description: Start date timestamp of policy coverage
            end_date:
              type: string
              description: End date timestamp of policy coverage
        policy_holders:
          type: array
          description: List of policy holders
          items:
            properties:
              name:
                type: string
                description: Name of the policy holder
              phone_number:
                type: string
                description: Phone number of the policy holder
              address:
                type: object
                description: Address of the policy holder
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
        insurance_provider:
          type: object
          description: Details of insurance provider
          properties:
            name:
              type: string
              description: Name of the insurance provider
            phone_number:
              type: string
              description: Phone number of the insurance provider
            address:
              type: object
              description: Address of the insurance provider
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        remit_to:
          type: object
          description: Details of entity to whom premium is remitted
          properties:
            name:
              type: string
              description: Name of the entity to whom premium is remitted
            phone_number:
              type: string
              description: Phone number of the entity to whom premium is remitted
            address:
              type: object
              description: Address of the entity to whom premium is remitted
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        insurance_agent:
          type: object
          description: Details of insurance agent
          properties:
            name:
              type: string
              description: Name of the insurance agent
            phone_number:
              type: string
              description: Phone number of the insurance agent
            address:
              type: object
              description: Address of the insurance agent
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        coverages:
          type: array
          description: List of policy coverages
          items:
            properties:
              type:
                type: string
                description: Type of coverage.
                enum:
                  - AUTO
                  - HOME
                  - RENTERS
                  - PERSONAL_UMBRELLA
              premium_amount:
                type: object
                description: Premium amount for coverage
                properties:
                  currency:
                    type: string
                    description: Currency of premium amount. e.g. `USD`, `CAD`
                  amount:
                    type: number
                    description: Premium amount
              details:
                oneOf:
                  - title: Auto
                    type: object
                    description: Auto coverage details
                    properties:
                      vehicle_info:
                        type: object
                        description: Details of the insured vehicle
                        properties:
                          vin:
                            type: string
                            description: Vehicle identification number
                          model:
                            type: string
                            description: Model of the vehicle
                          make:
                            type: string
                            description: Make of the vehicle
                          year:
                            type: number
                            description: Year when the vehicle was manufactured
                          brand:
                            type: string
                            description: Brand name of the vehicle
                          garaging_address:
                            type: object
                            description: Garaging location
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          current_mileage:
                            oneOf:
                              - title: Range
                                type: object
                                description: Auto yearly mileage as range
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      range:
                                        type: string
                                        description: Mileage in a range
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                              - title: Value
                                type: object
                                description: Auto yearly mileage given as exact value
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      value:
                                        type: number
                                        description: Value of mileage
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                          yearly_mileage:
                            oneOf:
                              - title: Range
                                type: object
                                description: Auto yearly mileage as range
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      range:
                                        type: string
                                        description: Mileage in a range
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                              - title: Value
                                type: object
                                description: Auto yearly mileage given as exact value
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      value:
                                        type: number
                                        description: Value of mileage
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                          fuel_type:
                            type: string
                            description: Fuel type of the vehicle
                          transmission_type:
                            type: string
                            description: Transmission type of the vehicle
                          usage_type:
                            type: string
                            description: Usage type of vehicle.
                            enum:
                              - PERSONAL
                              - BUSINESS
                              - OTHER
                          usage_sub_type:
                            type: string
                            description: Usage sub type of vehicle.
                            enum:
                              - PERSONAL
                              - BUSINESS
                              - PLEASURE
                              - COMMUTE
                              - WORK
                              - SCHOOL
                              - FARM
                              - OTHER
                          purchase_date:
                            type: string
                            description: Date when the vehicle was purchased.
                          ownership_type:
                            type: string
                            enum:
                              - SELF_OR_SPOUSE
                              - CO_OWNED
                              - FINANCED
                              - LEASED
                            description: Ownership status of the vehicle.
                          is_removed:
                            type: boolean
                            description: >-
                              Indicates whether the vehicle has been removed
                              from the policy.
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - LIEN_HOLDER
                                    - SERVICING_AGENT
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      drivers:
                        type: array
                        description: List of drivers
                        items:
                          properties:
                            first_name:
                              type: string
                              description: First name of the driver
                            middle_name:
                              type: string
                              description: Middle name of the driver
                            last_name:
                              type: string
                              description: Last name of the driver
                            full_name:
                              type: string
                              description: Full name of the driver
                            prefix:
                              type: string
                              description: Name prefix
                            suffix:
                              type: string
                              description: Name suffix
                            address:
                              type: object
                              description: Address of the driver
                              properties:
                                addr1:
                                  type: string
                                  description: Address Line 1
                                addr2:
                                  type: string
                                  description: Address Line 2
                                city:
                                  type: string
                                  description: City
                                state:
                                  type: string
                                  description: State
                                zipcode:
                                  type: string
                                  description: Zipcode
                                country:
                                  type: object
                                  description: Country details
                                  properties:
                                    name:
                                      type: string
                                      description: Country name
                                    a2_code:
                                      type: string
                                      description: Alpha-2 code of country
                            phone_number:
                              type: string
                              description: Phone number of the driver
                            email:
                              type: string
                              description: Email address of the driver
                            gender:
                              type: string
                              description: Gender of the driver
                            nationality:
                              type: string
                              description: Nationality of the driver
                            ssn:
                              type: string
                              description: SSN of the driver
                            date_of_birth:
                              type: string
                              description: Date of birth of the driver
                            marital_status:
                              type: string
                              description: Marital status of the driver
                            driving_license:
                              type: string
                              description: Driving license details of the driver
                            date_licensed:
                              type: string
                              description: Driving license date
                            license_state:
                              type: string
                              description: State in which the driver's license was issued.
                            relationship_to_insured:
                              type: string
                              enum:
                                - SELF
                                - SPOUSE
                                - CHILD
                                - PARENT
                                - SIBLING
                                - OTHER
                              description: >-
                                Relationship of the driver to the primary
                                insured.
                            age:
                              type: number
                              description: Age of the driver.
                            age_on_date:
                              type: string
                              description: Driver's age on a specific date.
                            education:
                              type: string
                              enum:
                                - LESS-THAN-HIGH-SCHOOL
                                - HIGH-SCHOOL-DIPLOMA
                                - ASSOCIATE
                                - BACHELORS
                                - MASTERS
                                - MASTERS-RESEARCH
                                - DOCTORAL
                                - CERTIFICATE
                                - DIPLOMA
                                - NON-DEGREE
                                - PROFESSIONAL
                                - UNDERGRADUATE
                              description: >-
                                Highest level of education completed by the
                                driver.
                            occupation:
                              type: string
                              description: Occupation or professional role of the driver.
                            age_licensed:
                              type: integer
                              description: Age at which the driver was issued a license.
                            is_excluded:
                              type: boolean
                              description: >-
                                Indicates whether this driver is excluded from
                                the insurance policy.
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - BODILY_INJURY
                                - PROPERTY_DAMAGE
                                - UNINSURED_MOTORIST_BODILY_INJURY
                                - UNINSURED_MOTORIST_PROPERTY_DAMAGE
                                - UNDERINSURED_MOTORIST_BODILY_INJURY
                                - UNDERINSURED_MOTORIST_PROPERTY_DAMAGE
                                - UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY
                                - >-
                                  UNINSURED_UNDERINSURED_MOTORIST_PROPERTY_DAMAGE
                                - >-
                                  UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE
                                - MEDICAL_PAYMENTS
                                - PERSONAL_INJURY_PROTECTION
                                - COMPREHENSIVE_COVERAGE
                                - COLLISION_COVERAGE
                                - AUTOMOBILE_DEATH_INDEMNITY
                                - EMERGENCY_TRANSPORTATION
                                - MECHANICAL_BREAKDOWN
                                - ROADSIDE_ASSISTANCE
                                - COMBINED_ADDITIONAL_COVERAGES
                                - FUNERAL_EXPENSE_BENEFITS
                                - WITNESS_EXPENSE
                                - REWARD_COVERAGE
                                - PROOF_OF_LOSS
                                - LOSS_OF_USE
                                - CUSTOM_PARTS_EQUIPMENTS
                                - TOWING_AND_LABOR
                                - RENTAL_REIMBURSEMENT
                                - WORK_LOSS_BENEFITS
                                - PERSONAL_UMBRELLA
                                - COMBINED_SINGLE_LIMIT
                                - OPTIONAL_BODILY_INJURY_OTHERS
                                - OPTIONAL_BASIC_ECONOMIC_LOSS
                                - ADDITIONAL_PERSONAL_INJURY_PROTECTION
                                - ESSENTIAL_SERVICES
                                - DEATH_BENEFITS
                                - SURVIVOR_BENEFITS
                                - REPLACEMENT_SERVICES
                                - ATTENDANT_CARE
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage item.
                                  enum:
                                    - BI
                                    - PD
                                    - FEB
                                    - UMISG
                                    - UMIPD
                                    - COMP
                                    - COLL
                                    - LUSE
                                    - TL
                                    - RREIM
                                    - WLB
                                    - PLC
                                    - PIP
                                    - UNDSG
                                    - UNDPD
                                    - ADDA
                                    - CSL
                                    - OBI
                                    - OBEL
                                    - APIP
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            premium_amount:
                              type: object
                              description: Premium amount for the coverage item
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                                  is_waiver:
                                    description: Specifies if the deductible is waived.
                                    type: boolean
                  - title: Home
                    type: object
                    description: Home coverage details
                    properties:
                      property_info:
                        type: object
                        description: Details of the insured property
                        properties:
                          name:
                            type: string
                            description: Name of the property
                          address:
                            type: object
                            description: Address of the property
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - FIRST_MORTGAGEE
                                    - SECOND_MORTGAGEE
                                    - THIRD_MORTGAGEE
                                    - SERVICING_AGENT
                                    - LIEN_HOLDER
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - HOMEOWNERS_ASSOCIATION
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - DWELLING
                                - PERSONAL_PROPERTY
                                - BUILDING_ADDITIONS_ALTERATIONS
                                - BUILDING_ORDINANCE
                                - LOSS_ASSESSMENT
                                - PERSONAL_LIABILITY
                                - ADDITIONAL_PREMISES_LIABILITY_EXTENSION
                                - MEDICAL_PAYMENTS
                                - WORKERS_COMPENSATION
                                - REPLACEMENT_COST_CONTENTS
                                - HOME_COMPUTERS
                                - SEWER_DRAINS
                                - JEWELRY
                                - EARTHQUAKE
                                - BUSINESS_PROPERTY
                                - LOSS_OF_USE
                                - ALL_PERILS
                                - NAMED_PERILS
                                - ALL_OTHER_PERILS
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage item.
                                  enum:
                                    - Dwell
                                    - PP
                                    - BAA
                                    - BOLAW
                                    - LAC
                                    - PPTC
                                    - ADDRL
                                    - MEDPM
                                    - WCFIN
                                    - RCC
                                    - PC
                                    - SEWER
                                    - UNJWP
                                    - ERQK
                                    - BUSPR
                                    - LUSE
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            perils:
                              type: array
                              description: Named perils present on the policy
                              properties:
                                items:
                                  description: Named perils present on the policy
                                  type: string
                                  enum:
                                    - FIRE
                                    - LIGHTNING
                                    - EXPLOSION
                                    - WINDSTORM
                                    - HAIL
                                    - SMOKE
                                    - AIRCRAFT
                                    - VEHICLES
                                    - RIOT
                                    - CIVIL_COMMOTION
                                    - VANDALISM
                                    - SPRINKLER_LEAKAGE
                                    - SINKHOLE_COLLAPSE
                                    - VOLCANIC_ACTIVITY
                                    - BURGLARY_BREAK_IN
                                    - FALLING_OBJECTS
                                    - WEIGHT_OF_ICE
                                    - SNOW
                                    - SLEET
                                    - WATER_DAMAGE
                                    - COLLAPSE
                                    - ORDINANCE_OF_LAW
                                    - EARTHQUAKE
                                    - FLOOD
                                    - POWER_FAILURE
                                    - NEGLECT
                                    - WAR
                                    - NUCLEAR_HAZARD
                                    - INTENTIONAL_ACTS
                            premium_amount:
                              type: object
                              description: Premium amount for the coverage item
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                  - title: Renters
                    type: object
                    description: Rent coverage details
                    properties:
                      property_info:
                        type: object
                        description: Details of the insured property
                        properties:
                          name:
                            type: string
                            description: Name of the property
                          address:
                            type: object
                            description: Address of the property
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - FIRST_MORTGAGEE
                                    - SECOND_MORTGAGEE
                                    - THIRD_MORTGAGEE
                                    - SERVICING_AGENT
                                    - LIEN_HOLDER
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - HOMEOWNERS_ASSOCIATION
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - DWELLING
                                - PERSONAL_PROPERTY
                                - BUILDING_ADDITIONS_ALTERATIONS
                                - BUILDING_ORDINANCE
                                - LOSS_ASSESSMENT
                                - PERSONAL_LIABILITY
                                - ADDITIONAL_PREMISES_LIABILITY_EXTENSION
                                - MEDICAL_PAYMENTS
                                - WORKERS_COMPENSATION
                                - REPLACEMENT_COST_CONTENTS
                                - HOME_COMPUTERS
                                - SEWER_DRAINS
                                - JEWELRY
                                - EARTHQUAKE
                                - BUSINESS_PROPERTY
                                - LOSS_OF_USE
                                - ALL_PERILS
                                - NAMED_PERILS
                                - ALL_OTHER_PERILS
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage item.
                                  enum:
                                    - Dwell
                                    - PP
                                    - BAA
                                    - BOLAW
                                    - LAC
                                    - PPTC
                                    - ADDRL
                                    - MEDPM
                                    - WCFIN
                                    - RCC
                                    - PC
                                    - SEWER
                                    - UNJWP
                                    - ERQK
                                    - BUSPR
                                    - LUSE
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            perils:
                              type: array
                              description: Named perils present in the policy
                              items:
                                type: string
                                enum:
                                  - FIRE
                                  - LIGHTNING
                                  - EXPLOSION
                                  - WINDSTORM
                                  - HAIL
                                  - SMOKE
                                  - AIRCRAFT
                                  - VEHICLES
                                  - RIOT
                                  - CIVIL_COMMOTION
                                  - VANDALISM
                                  - SPRINKLER_LEAKAGE
                                  - SINKHOLE_COLLAPSE
                                  - VOLCANIC_ACTIVITY
                                  - BURGLARY_BREAK_IN
                                  - FALLING_OBJECTS
                                  - WEIGHT_OF_ICE
                                  - SNOW
                                  - SLEET
                                  - WATER_DAMAGE
                                  - COLLAPSE
                                  - ORDINANCE_OF_LAW
                                  - EARTHQUAKE
                                  - FLOOD
                                  - POWER_FAILURE
                                  - NEGLECT
                                  - WAR
                                  - NUCLEAR_HAZARD
                                  - INTENTIONAL_ACTS
                            premium_amount:
                              type: object
                              description: Premium amount for the coverage item
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                  - title: Personal Umbrella
                    type: object
                    description: Personal umbrella coverage details
                    properties:
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item.
                            type:
                              type: string
                              description: >-
                                Type of the coverage items. e.g.
                                `PERSONAL_UMBRELLA`
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: >-
                                    X12 standard code of the coverage item. e.g.
                                    `PLC`
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            premium_amount:
                              type: object
                              description: Premium amount for coverage
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
    M1_AUTO_INSURANCE_CLAIM_RECORD:
      title: M1_AUTO_INSURANCE_CLAIM_RECORD Schema
      type: object
      description: |
        Representation of the Auto Insurance claim record for an individual
      properties:
        as_of_date:
          type: string
          description: Date on which the record was generated
        auto_insurance_claims:
          type: array
          items:
            type: object
            properties:
              claim_date:
                type: string
                description: The date when the insurance claim was made.
              claim_number:
                type: string
                description: Unique identifier for the insurance claim.
              policy_number:
                type: string
                description: Policy number
              vehicle_info:
                type: object
                properties:
                  vin:
                    type: string
                    description: >-
                      Vehicle Identification Number (VIN) of the insured
                      vehicle.
                  model:
                    type: string
                    description: The model of the insured vehicle.
                  make:
                    type: string
                    description: The make or manufacturer of the insured vehicle.
                  year:
                    type: number
                    description: The year of manufacture of the insured vehicle.
                description: Information about the insured vehicle.
              policy_holders:
                type: array
                description: List of policy holders associated with the claim.
              insurance_provider:
                type: object
                description: Details of insurance provider
                properties:
                  name:
                    type: string
                    description: Name of the insurance provider
                  phone_number:
                    type: string
                    description: Phone number of the insurance provider
                  address:
                    type: object
                    description: Address of the insurance provider
                    properties:
                      addr1:
                        type: string
                        description: Address Line 1
                      addr2:
                        type: string
                        description: Address Line 2
                      city:
                        type: string
                        description: City
                      state:
                        type: string
                        description: State
                      zipcode:
                        type: string
                        description: Zipcode
                      country:
                        type: object
                        description: Country details
                        properties:
                          name:
                            type: string
                            description: Country name
                          a2_code:
                            type: string
                            description: Alpha-2 code of country
              adjuster:
                type: object
                properties:
                  name:
                    type: string
                    description: Name of the adjuster handling the insurance claim
                  phone_number:
                    type: string
                    description: Phone number of the adjuster
                  email:
                    type: string
                    description: Email address of the adjuster
                  address:
                    type: object
                    properties:
                      addr1:
                        type: string
                        description: Address Line 1
                      addr2:
                        type: string
                        description: Address Line 2
                      city:
                        type: string
                        description: City
                      state:
                        type: string
                        description: State
                      zipcode:
                        type: string
                        description: Zipcode
                      country:
                        type: object
                        description: Country details
                        properties:
                          name:
                            type: string
                            description: Country name
                          a2_code:
                            type: string
                            description: Alpha-2 code of country
              incident_location:
                type: object
                description: >-
                  Location where the incident leading to the insurance claim
                  occurred.
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
              claim_description:
                type: string
                description: Description of the insurance claim
              claim_disposition:
                type: string
                description: >-
                  The status or disposition of the insurance claim. Enum
                  `OPEN`,`CLOSED`
              vehicle_operator:
                type: object
                properties:
                  first_name:
                    type: string
                    description: First name of the vehicle operator
                  middle_name:
                    type: string
                    description: Middle name of the vehicle operator
                  last_name:
                    type: string
                    description: Last name of the vehicle operator
                  full_name:
                    type: string
                    description: Full name of the vehicle operator
                  prefix:
                    type: string
                    description: Prefix of the vehicle operator's name
                  suffix:
                    type: string
                    description: Suffix of the vehicle operator's name
                  address:
                    type: object
                    description: Address information of the vehicle operator
                    properties:
                      addr1:
                        type: string
                        description: Address Line 1
                      addr2:
                        type: string
                        description: Address Line 2
                      city:
                        type: string
                        description: City
                      state:
                        type: string
                        description: State
                      zipcode:
                        type: string
                        description: Zipcode
                      country:
                        type: object
                        description: Country details
                        properties:
                          name:
                            type: string
                            description: Country name
                          a2_code:
                            type: string
                            description: Alpha-2 code of country
                  phone_number:
                    type: string
                    description: Phone number of the vehicle operator
                  email:
                    type: string
                    description: Email address of the vehicle operator
                  gender:
                    type: string
                    description: Gender of the vehicle operator
                  nationality:
                    type: string
                    description: Nationality of the vehicle operator
                  ssn:
                    type: string
                    description: Social Security Number (SSN) of the vehicle operator
                  date_of_birth:
                    type: string
                    description: Date of birth of the vehicle operator
                  marital_status:
                    type: string
                    description: Marital status of the vehicle operator
                  driving_license:
                    type: string
                    description: Driving license details of the vehicle operator
                  date_licensed:
                    type: string
                    description: Date at which driving license
              total_claim_paid:
                type: object
                description: Total claim paid
                properties:
                  currency:
                    type: string
                    description: Currency of claim amount. e.g. `USD`, `CAD`
                  amount:
                    type: number
                    description: Claim amount
              claim_breakup:
                type: array
                description: Information about the amount claimed for the insurance claim
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the claimant or insured individual
                    type:
                      type: string
                      description: >-
                        Type of insurance claim.  Enum `BODILY_INJURY`,
                        `PROPERTY_DAMAGE`, `COLLISION`, `COMPREHENSIVE`,`
                        MEDICAL_PAYMENTS`,`UIM`, `UM`,
                        `PERSONAL_INJURY_PROTECTION`
                    x12_info:
                      type: object
                      properties:
                        code:
                          type: string
                          description: >-
                            X12 standard code of the coverage item. e.g. `BI`,
                            `MEDPM`, `UMISG`
                        desc:
                          type: string
                          description: Description associated with the X12 information.
                      description: X12 standard description of coverage item
                    amount_claimed:
                      type: object
                      properties:
                        currency:
                          type: string
                          description: Currency of claim amount. e.g. `USD`, `CAD`
                        amount:
                          type: number
                          description: Claim amount
                    deductible:
                      type: object
                      properties:
                        currency:
                          type: string
                          description: Currency in which the deductible amount is stated.
                        amount:
                          type: number
                          description: Deductible amount for the insurance claim.
                      description: Information about the deductible for the insurance claim
                    amount_paid:
                      type: object
                      properties:
                        currency:
                          type: string
                          description: Currency in which the amount paid is stated
                        amount:
                          type: number
                          description: Total amount paid for the insurance claim
                      description: >-
                        Information about the amount paid for the insurance
                        claim
                    date_paid:
                      type: string
                      description: Date when the insurance claim was paid
                    paid_to:
                      type: string
                      description: Recipient or payee of the insurance claim payment
                    disposition:
                      type: string
                      description: >-
                        Disposition or status of the insurance claim. Enum
                        `OPEN`, `CLOSED`
    M1_STUDENT_ID_RECORD:
      title: M1_STUDENT_ID_RECORD Schema
      summary: M1_STUDENT_ID_RECORD SCHEMA
      type: object
      properties:
        valid_from:
          type: string
          description: Student ID valid from
        valid_upto:
          type: string
          description: Student ID valid upto
        student:
          type: object
          description: Object with information about the Student, as provided on Student ID
          properties:
            student_id:
              type: string
              description: Unique, school-provided Student ID
            first_name:
              type: string
              description: First name of the student
            last_name:
              type: string
              description: Last name of the student
            middle_name:
              type: string
              description: Middle name of the student
            prefix:
              type: string
              description: Prefix to the name
            suffix:
              type: string
              description: Suffix to the name
            full_name:
              type: string
              description: Full name of the student
            former_first_name:
              type: string
              description: Former first name
            former_middle_name:
              type: string
              description: Former middle name
            former_last_name:
              type: string
              description: Former last name
            former_full_name:
              type: string
              description: Former full name
            former_suffix:
              type: string
              description: Suffix to the former name
            former_prefix:
              type: string
              description: Prefix to the former name
            date_of_birth:
              type: string
              description: Birthdate of the student
            govt_id:
              type: object
              description: Government id of the student
              properties:
                id:
                  type: string
                type:
                  type: string
            email:
              type: string
              description: Email address of the student, as provided on the Student ID
            phone_number:
              type: string
              description: Phone number of the student, as provided on the Student ID
            address:
              type: object
              description: Student's Address information as provided on the Student ID
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  description: Country information
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        teaching_institution:
          type: object
          description: Object with information about the teaching institution
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: Type of ID used to identify given institution Enum `AISHE`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        degree_awarding_institution:
          type: object
          description: Object with information about the degree awarding institution
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        degrees:
          type: array
          description: List of degrees found in Student ID
          items:
            type: object
            properties:
              description:
                type: string
              type:
                type: string
                description: >-
                  Level of the degree. Enum  `HIGH-SCHOOL-DIPLOMA`, `ASSOCIATE`,
                  `BACHELORS`, `MASTERS`, `MASTERS-RESEARCH`, `DOCTORAL`,
                  `CERTIFICATE`, `DIPLOMA`, `NON-DEGREE`, `PROFESSIONAL`,
                  `UNDERGRADUATE`, `UNKNOWN`
              field_of_study:
                type: array
                description: List of objects with information about the field of study
                items:
                  properties:
                    type:
                      type: string
                      description: Type of study. Enum `MAJOR`,`MINOR`,`CONCENTRATION`
                    description:
                      type: string
                      description: Name of the field of study
                    code_type:
                      type: string
                      description: >-
                        Type of the code used for identifying the field of study
                        E.g. CIP, HEGIS, OTHER
                    code:
                      type: string
                      description: Specifies the code for the field of study
    M1_PROCEEDS_1099_B:
      title: M1_Realized gains Schema
      type: object
      description: |
        Representation of the 1099 B
      properties:
        as_of_date:
          type: number
          description: timestamp when this record was generated
        account_number:
          type: string
          description: Account Number as presented on the datasource
        recipient:
          type: object
          description: Details of the recipient
          properties:
            name:
              type: string
              description: Name of the recipient
            phone_number:
              type: string
              description: Phone number of the recipient
            tin:
              type: string
              description: Tax identification number of the recipient
            address:
              type: object
              description: Address of the recipient
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        payer:
          type: object
          description: Details of the payer
          properties:
            tin:
              type: string
              description: Tax identification number of the payer
            name:
              type: string
              description: Name of the payer
            phone_number:
              type: string
              description: Phone number of the payer
            address:
              type: object
              description: Address of the payer
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        transactions:
          type: array
          description: List of transactions
          items:
            properties:
              gain_type:
                type: string
                enum:
                  - SHORT_TERM
                  - LONG_TERM
                description: Type of the gain
              quantity_sold:
                type: number
                description: Quantity sold
              asset_details:
                type: object
                description: Details of the asset
                properties:
                  type:
                    type: string
                    enum:
                      - SECURITY
                      - CRYPTO
                      - REAL_ESTATE
                      - OTHER
                    description: Type of asset
                  description:
                    type: string
                    description: Description of property
                  cusip:
                    type: string
                    description: CUSIP number
                  ticker:
                    type: string
                    description: Ticker
              acquired_date:
                type: number
                description: Date acquired
              sell_date:
                type: number
                description: Date sold or disposed
              proceeds:
                type: object
                description: Proceeds
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of the proceed
                  value:
                    type: number
                    description: value of the proceed
              cost:
                type: object
                description: Cost or other Basis
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of the cost
                  value:
                    type: number
                    description: Value of cost or basis
              accrued_market_discount:
                type: object
                description: Accrued Market Discount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of accrued market discount
                  value:
                    type: number
                    description: Value
              wash_sale_disallowed:
                type: object
                description: Wash Sale disallowed amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: Wash Sale Loss Disallowed Value
              gain:
                type: object
                description: gain Amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: gain Amount
              additional_information:
                type: string
                description: Additional Information
              proceed_type:
                type: string
                enum:
                  - GROSS
                  - NET
              basis_reported_to_irs:
                type: boolean
                description: Basis Reported to the IRS
              non_covered_security:
                type: boolean
                description: Covered/Non-covered Security (Box 5)
        totals:
          type: object
          description: Realized gain totals
          properties:
            short_term_gains:
              type: object
              description: Total short term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
            long_term_gains:
              type: object
              description: Total long term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
    m1_form_1099_DIV_consolidated:
      title: M1_FORM_1099_DIV Schema
      type: object
      description: |
        Representation of the 1099 DIV 
      properties:
        second_tin_not:
          type: boolean
          examples:
            - false
        total_ordinary_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        asset_details:
          type: object
          description: Details of the asset
          properties:
            description:
              type: string
              description: Description of property
            cusip:
              type: string
              description: CUSIP number
            pay_date:
              type: string
              description: Pay date of the transaction
        qualified_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        total_capital_gain_distribution:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        unrecap_sec_1250_gain:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        sec_1202_gain:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        collection_gain:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        sec_897_ordinary_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        sec_897_capital_gain:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        non_dividend_distributions:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        federal_income_tax_withheld:
          description: Federal income tax withheld
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        section_199A_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        investment_expenses:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        foreign_tax_paid:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        foreign_country_or_us_possession:
          type: string
          examples:
            - string
        cash_liquidation_distributions:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        noncash_liquidation_distributions:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        exempt_interest_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        specified_private_activity_bond_interest_dividends:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_tax_withheld:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_no:
          type: string
          examples:
            - string
        state:
          type: string
          examples:
            - string
    m1_form_1099_INT_consolidated:
      title: M1_FORM_1099_INT Schema
      type: object
      description: |
        Representation of the 1099 INT 
      properties:
        second_tin_not:
          type: boolean
          examples:
            - false
        interest_income:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        asset_details:
          type: object
          description: Details of the asset
          properties:
            description:
              type: string
              description: Description of property
            cusip:
              type: string
              description: CUSIP number
            pay_date:
              type: string
              description: Pay date of the transaction
        early_withdrawal_penalty:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        interest_on_us_savings_bonds_and_treasury_obligations:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        federal_income_tax_withheld:
          description: Federal income tax withheld
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        investment_expenses:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        foreign_tax_paid:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        foreign_country_or_us_territory:
          type: string
          examples:
            - string
        tax_exempt_interest:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        specified_private_activity_bond_interest:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        market_discount:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        bond_premium:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        bond_premium_on_treasury_obligations:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        bond_premium_on_tax_exempt_bond:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        tax_exempt_and_tax_credit_bond_cusip_no:
          type: number
          examples:
            - 0
        state_tax_withheld:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_no:
          type: string
          examples:
            - string
        state:
          type: string
          examples:
            - string
    m1_form_1099_MISC_consolidated:
      title: M1_FORM_1099_MISC Schema
      type: object
      description: |
        Representation of the 1099 MISC 
      properties:
        second_tin_not:
          type: boolean
          examples:
            - false
        rents:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        royalties:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        other_income:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        federal_income_tax_withheld:
          description: Federal income tax withheld
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        fishing_boat_proceeds:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        medical_and_health_care_payments:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        payer_made_direct_sales:
          type: boolean
          examples:
            - false
        substitute_payments_in_lieu_of_dividends_or_interest:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        crop_insurance_proceeds:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        gross_proceeds_paid_to_an_attorney:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        fish_purchased_for_resale:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        section_409a_deferrals:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        excess_golden_parachute_payments:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        nonqualified_deferred_compensation:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_tax_withheld:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_no:
          type: string
          examples:
            - string
        state_income:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
    m1_form_1099_NEC_consolidated:
      title: M1_FORM_1099_NEC Schema
      type: object
      description: |
        Representation of the 1099 NEC 
      properties:
        second_tin_not:
          type: boolean
        non_employee_compensation:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        payer_made_direct_sales:
          type: boolean
        excess_golden_parachute_payments:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        federal_income_tax_withheld:
          description: Federal income tax withheld
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_tax_withheld:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_no:
          type: string
        state_income:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
    m1_form_1099_OID_consolidated:
      title: M1_FORM_1099_OID Schema
      type: object
      description: |
        Representation of the 1099 OID
      properties:
        second_tin_not:
          type: boolean
          examples:
            - false
        original_issue_discount_for_the_year:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        other_periodic_interest:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        early_withdrawal_penalty:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        federal_income_tax_withheld:
          description: Federal income tax withheld
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        market_discount:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        acquisition_premium:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        description:
          type: string
          examples:
            - string
        original_issue_discount_on_us_treasury_obligations:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        investment_expenses:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        bond_premium:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        tax-exempt_oid:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_tax_withheld:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        state_no:
          type: string
          examples:
            - string
        state:
          type: string
          examples:
            - string
    m1_form_1099_B_consolidated:
      title: M1_FORM_1099_B Schema
      type: object
      description: |
        Representation of the 1099 B 
      properties:
        transactions:
          type: array
          description: List of transactions
          items:
            properties:
              cusip:
                type: string
                description: CUSIP number
              second_tin_not:
                type: boolean
                examples:
                  - false
              gain_type:
                type: string
                enum:
                  - SHORT_TERM
                  - LONG_TERM
                description: Type of the gain
              quantity_sold:
                type: number
                description: Quantity sold
              asset_details:
                type: object
                description: Details of the asset
                properties:
                  type:
                    type: string
                    enum:
                      - SECURITY
                      - CRYPTO
                      - REAL_ESTATE
                      - OTHER
                    description: Type of asset
                  description:
                    type: string
                    description: Description of property
                  cusip:
                    type: string
                    description: CUSIP number
                  ticker:
                    type: string
                    description: Ticker
              acquired_date:
                type: number
                description: Date acquired
              sell_date:
                type: number
                description: Date sold or disposed
              proceeds:
                type: object
                description: Proceeds
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of the proceed
                  value:
                    type: number
                    description: value of the proceed
              cost:
                type: object
                description: Cost or other Basis
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of the cost
                  value:
                    type: number
                    description: Value of cost or basis
              accrued_market_discount:
                type: object
                description: Accrued Market Discount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency of accrued market discount
                  value:
                    type: number
                    description: Value
              wash_sale_disallowed:
                type: object
                description: Wash Sale disallowed amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: Wash Sale Loss Disallowed Value
              gain:
                type: object
                description: gain Amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: gain Amount
              additional_information:
                type: string
                description: Additional Information
              proceed_type:
                type: string
                enum:
                  - GROSS
                  - NET
              basis_reported_to_irs:
                type: boolean
                description: Basis Reported to the IRS
              non_covered_security:
                type: boolean
                description: Covered/Non-covered Security (Box 5)
        totals:
          type: object
          description: Realized gain totals
          properties:
            short_term_gains:
              type: object
              description: Total short term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
            long_term_gains:
              type: object
              description: Total long term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
    M1_FORM_1099_CONSOLIDATED:
      title: M1_1099_RECORD schema
      type: object
      description: |
        Representation of the 1099 Tax records
      properties:
        record_year:
          type: number
          description: Year on which the record was generated
          format: YYYY
          examples:
            - 2024
        record_date:
          type: string
          description: Date on which the record was generated
          format: MM/DD/YYYY
        document_id:
          type: string
          examples:
            - string
        account_number:
          type: string
          description: Account Number as presented on the datasource
        fatca_filing_requirement:
          type: boolean
          description: Used to show FATCA filing requirement value
        void:
          type: boolean
          description: Marks the form as void
        corrected:
          type: boolean
          description: Marks the form as corrected
        recipient:
          type: object
          description: Details of the recipient
          properties:
            tin:
              type: string
              description: Tax identification number of the recipient
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  examples:
                    - string
                country:
                  type: object
                  properties:
                    a2_code:
                      type: string
                      examples:
                        - string
                    name:
                      type: string
                      examples:
                        - string
                addr2:
                  type: string
                  examples:
                    - string
                addr1:
                  type: string
                  examples:
                    - string
                city:
                  type: string
                  examples:
                    - string
                state:
                  type: string
                  examples:
                    - string
            gender:
              type: string
              examples:
                - string
            prefix:
              type: string
              examples:
                - string
            date_of_birth:
              type: string
              examples:
                - string
            last_name:
              type: string
              examples:
                - string
            middle_name:
              type: string
              examples:
                - string
            suffix:
              type: string
              examples:
                - string
            ssn:
              type: string
              examples:
                - string
            marital_status:
              type: string
              examples:
                - string
            full_name:
              type: string
              examples:
                - string
            nationality:
              type: string
              examples:
                - string
            phone_number:
              type: string
              examples:
                - string
            first_name:
              type: string
              examples:
                - string
            email:
              type: string
              examples:
                - string
        payer:
          type: object
          description: Details of the payer
          properties:
            tin:
              type: string
              description: Tax identification number of the payer
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  examples:
                    - string
                country:
                  type: object
                  properties:
                    a2_code:
                      type: 'null'
                    name:
                      type: 'null'
                addr2:
                  type: string
                  examples:
                    - string
                addr1:
                  type: string
                  examples:
                    - string
                city:
                  type: string
                  examples:
                    - string
                state:
                  type: string
                  examples:
                    - string
            name:
              type: string
              examples:
                - string
            phone_number:
              type: string
              examples:
                - string
        form_1099_div:
          type: object
          properties:
            transactions:
              type: array
              items:
                $ref: '#/components/schemas/m1_form_1099_DIV_consolidated'
            totals:
              $ref: '#/components/schemas/m1_form_1099_DIV_consolidated'
        form_1099_int:
          type: object
          properties:
            transactions:
              type: array
              items:
                $ref: '#/components/schemas/m1_form_1099_INT_consolidated'
            totals:
              $ref: '#/components/schemas/m1_form_1099_INT_consolidated'
        form_1099_misc:
          type: object
          properties:
            transactions:
              type: array
              items:
                $ref: '#/components/schemas/m1_form_1099_MISC_consolidated'
            totals:
              $ref: '#/components/schemas/m1_form_1099_MISC_consolidated'
        form_1099_nec:
          type: object
          properties:
            transactions:
              type: array
              items:
                $ref: '#/components/schemas/m1_form_1099_NEC_consolidated'
            totals:
              $ref: '#/components/schemas/m1_form_1099_NEC_consolidated'
        form_1099_oid:
          type: object
          properties:
            transactions:
              type: array
              items:
                $ref: '#/components/schemas/m1_form_1099_OID_consolidated'
            totals:
              $ref: '#/components/schemas/m1_form_1099_OID_consolidated'
        form_1099_B:
          $ref: '#/components/schemas/m1_form_1099_B_consolidated'
    m1_form_1098:
      title: M1_FORM_1098 Schema
      type: object
      description: |
        Representation of the 1098
      properties:
        mortgage_interest_received:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        outstanding_mortgage_principal:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        mortgage_origination_date:
          type: string
          examples:
            - string
        refund_of_overpaid_interest:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        mortgage_insurance_premiums:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        points_paid_on_purchase_of_principal_residence:
          type: object
          properties:
            currency:
              type: string
              enum:
                - USD
              description: Currency
            value:
              type: number
              description: Amount
        address_of_property_same_as_payers:
          type: boolean
          examples:
            - false
        property_address:
          type: object
          properties:
            zipcode:
              type: string
              examples:
                - string
            country:
              type: object
              properties:
                a2_code:
                  type: string
                  examples:
                    - string
                name:
                  type: string
                  examples:
                    - string
            addr2:
              type: string
              examples:
                - string
            addr1:
              type: string
              examples:
                - string
            city:
              type: string
              examples:
                - string
            state:
              type: string
              examples:
                - string
        number_of_properties_securing_the_mortgage:
          type: number
          examples:
            - 0
        other:
          type: object
          properties:
            amount:
              type: number
              examples:
                - 0
            currency:
              type: string
              enum:
                - USD
              description: Currency
        mortgage_acquisition_date:
          type: string
          examples:
            - string
    M1_FORM_1098_MORTGAGE_INTEREST:
      title: M1_1098_RECORD Schema
      type: object
      description: |
        Representation of the 1098 MORTGAGE_INTEREST
      properties:
        record_year:
          type: number
          description: Year on which the record was generated
          format: YYYY
          examples:
            - 2024
        record_date:
          type: string
          description: Date on which the record was generated
          format: MM/DD/YYYY
        void:
          type: boolean
          description: Marks the form as void
        corrected:
          type: boolean
          description: Marks the form as corrected
        recipient:
          type: object
          description: Details of the recipient
          properties:
            tin:
              type: string
              description: Tax identification number of the payer
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  examples:
                    - string
                country:
                  type: object
                  properties:
                    a2_code:
                      type: 'null'
                    name:
                      type: 'null'
                addr2:
                  type: string
                  examples:
                    - string
                addr1:
                  type: string
                  examples:
                    - string
                city:
                  type: string
                  examples:
                    - string
                state:
                  type: string
                  examples:
                    - string
            name:
              type: string
              examples:
                - string
            phone_number:
              type: string
              examples:
                - string
        payer:
          type: object
          description: Details of the payer
          properties:
            tin:
              type: string
              description: Tax identification number of the recipient
            address:
              type: object
              properties:
                zipcode:
                  type: string
                  examples:
                    - string
                country:
                  type: object
                  properties:
                    a2_code:
                      type: string
                      examples:
                        - string
                    name:
                      type: string
                      examples:
                        - string
                addr2:
                  type: string
                  examples:
                    - string
                addr1:
                  type: string
                  examples:
                    - string
                city:
                  type: string
                  examples:
                    - string
                state:
                  type: string
                  examples:
                    - string
            gender:
              type: string
              examples:
                - string
            prefix:
              type: string
              examples:
                - string
            date_of_birth:
              type: string
              examples:
                - string
            last_name:
              type: string
              examples:
                - string
            middle_name:
              type: string
              examples:
                - string
            suffix:
              type: string
              examples:
                - string
            ssn:
              type: string
              examples:
                - string
            marital_status:
              type: string
              examples:
                - string
            full_name:
              type: string
              examples:
                - string
            name:
              type: string
              examples:
                - string
            nationality:
              type: string
              examples:
                - string
            phone_number:
              type: string
              examples:
                - string
            first_name:
              type: string
              examples:
                - string
            email:
              type: string
              examples:
                - string
        account_number:
          type: string
          examples:
            - string
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/m1_form_1098'
        totals:
          $ref: '#/components/schemas/m1_form_1098'
    M1_INSURANCE_ADDITIONAL_DETAILS_RECORD_SCHEMA:
      title: >-
        POLICY_LISTING | POLICY_DETAILS | VEHICLE_LISTING | VEHICLE DETAILS 
        Schema
      type: object
      properties:
        insurance_records:
          type: array
          items:
            $ref: '#/components/schemas/M1_INSURANCE_RECORD'
    Item:
      title: Item Object
      type: object
      required:
        - source_data
        - source_data_type
        - datasource_id
      properties:
        id:
          type: string
          readOnly: true
          description: Unique ID of the item identified by MeasureOne
        individual_id:
          type: string
          deprecated: true
          description: >-
            MeasureOne generated unique identifier linked to the item. If this
            is not provided, MeasureOne will generate a new individual_id for
            given item. This attribute is deprecated
        datarequest_id:
          type: string
          description: >-
            MeasureOne generated unique datarequest identifier linked to the
            item. If this is not provided, MeasureOne will generate a new
            datarequest for given item.
        external_id:
          type: string
          description: A customer generated unique identifier linked to the item
        datasource_id:
          type: string
          description: >-
            Unique identifier of the datasource. This attribute is non-mandatory
            `M1_DIGEST` source_data_type
        source_data_type:
          type: string
          description: The type of the source_data
          enum:
            - M1_ACADEMIC_RECORD
            - M1_DIGEST
            - TRANSCRIPT_FILE
            - PAYSTUB_FILE
            - W2_FILE
            - INSURANCE_POLICY (Deprecated)
            - AUTO_INSURANCE_POLICY
            - HOME_INSURANCE_POLICY
            - RENTERS_INSURANCE_POLICY
            - UNINSURED_MOTORIST_FORM
            - AUTO_INSURANCE_CLAIM
            - INSURANCE_CARD
            - STUDENT_ID_CARD
            - PROCEEDS_1099_B
            - TWN_EDR
            - FORM_1099_B
            - FORM_1099_CONSOLIDATED
            - FORM_1099_INT
            - FORM_1099_DIV
            - FORM_1099_OID
            - FORM_1099_MISC
            - FORM_1099_NEC
            - FORM_1098
            - POLICY_LISTING
            - POLICY_DETAILS
            - VEHICLE_LISTING
            - VEHICLE_DETAILS
          x-enumDescriptions:
            M1_ACADEMIC_RECORD: JSON payload constituting the academic Record of the Individual
            M1_DIGEST: JSON payload for Digest of the academic record
            TRANSCRIPT_FILE: PDF, HTML or Image of the academic transcript
            PAYSTUB_FILE: PDF or HTML of the paystub
            W2_FILE: PDF of the W-2
            INSURANCE_POLICY (Deprecated): >-
              PDF, HTML or Image of the insurance policy (Deprecated). Use
              AUTO_INSURANCE_POLICY or HOME_INSURANCE_POLICY
            AUTO_INSURANCE_POLICY: PDF, HTML or Image of the auto insurance policy
            HOME_INSURANCE_POLICY: PDF, HTML or Image of the home insurance policy
            RENTERS_INSURANCE_POLICY: PDF, HTML or Image of the renters insurance policy
            UNINSURED_MOTORIST_FORM: PDF of  uninsured motorist form
            AUTO_INSURANCE_CLAIM: JSON payload constituting the auto insurance claim record
            INSURANCE_CARD: PDF or Image of the insurance card
            STUDENT_ID_CARD: PDF or Image of the Student ID
            PROCEEDS_1099_B: PDF of 1099-B
            TWN_EDR: PDF of TWN Employment Data Report
            FORM_1099_B: PDF or Image of the 1099 B
            FORM_1099_CONSOLIDATED: PDF or Image of the Consolidated tax statement
            FORM_1099_INT: PDF or Image of the 1099 INT
            FORM_1099_DIV: PDF or Image of the 1099 DIV
            FORM_1099_OID: PDF or Image of the 1099 OID
            FORM_1099_MISC: PDF or Image of the 1099 MISC
            FORM_1099_NEC: PDF or Image of the 1099 NEC
            FORM_1098: PDF or Image of the 1098
            POLICY_LISTING: PDF, HTML or JSON of insurance policy
            POLICY_DETAILS: PDF, HTML or JSON of insurance policy
            VEHICLE_LISTING: PDF, HTML or JSON of insurance vehicle
            VEHICLE_DETAILS: PDF, HTML or JSON of insurance vehicle
        media_type:
          type: string
          description: |
            Media type of the source data document
          oneOf:
            - title: TRANSCRIPT_FILE
              type: string
              description: Media type supported for TRANSCRIPT_FILE
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: PAYSTUB_FILE
              type: string
              description: Media type supported for PAYSTUB_FILE
              enum:
                - application/pdf
                - image/pdf
                - text/html
            - title: W2_FILE
              type: string
              description: Media type supported for W2_FILE
              enum:
                - application/pdf
                - image/pdf
            - title: INSURANCE_POLICY (Deprecated)
              type: string
              description: Media type supported for INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: AUTO_INSURANCE_POLICY
              type: string
              description: Media type supported for AUTO_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: HOME_INSURANCE_POLICY
              type: string
              description: Media type supported for HOME_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: RENTERS_INSURANCE_POLICY
              type: string
              description: Media type supported for RENTERS_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: UNINSURED_MOTORIST_FORM
              type: string
              description: Media type supported for UNINSURED_MOTORIST_FORM
              enum:
                - application/pdf
                - image/pdf
            - title: INSURANCE_CARD
              type: string
              description: Media type supported for INSURANCE_CARD
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
            - title: STUDENT_ID_CARD
              type: string
              description: Media type supported for STUDENT_ID_CARD
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
            - title: PROCEEDS_1099_B
              type: string
              description: Media type supported for PROCEEDS_1099_B
              enum:
                - application/pdf
                - image/pdf
            - title: TWN_EDR
              type: string
              description: Media type supported for TWN_EDR
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_B
              type: string
              description: Media type supported for FORM_1099_B
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_CONSOLIDATED
              type: string
              description: Media type supported for FORM_1099_CONSOLIDATED
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_INT
              type: string
              description: Media type supported for FORM_1099_INT
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_DIV
              type: string
              description: Media type supported for FORM_1099_DIV
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_OID
              type: string
              description: Media type supported for FORM_1099_OID
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_MISC
              type: string
              description: Media type supported for FORM_1099_MISC
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_NEC
              type: string
              description: Media type supported for FORM_1099_NEC
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1098
              type: string
              description: Media type supported for FORM_1098
              enum:
                - application/pdf
                - image/pdf
            - title: POLICY_LISTING
              type: string
              description: Media type supported for POLICY_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: POLICY_LISTING
              type: string
              description: Media type supported for POLICY_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: VEHICLE_LISTING
              type: string
              description: Media type supported for VEHICLE_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: VEHICLE_DETAILS
              type: string
              description: Media type supported for VEHICLE_DETAILS
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
        duplicates:
          readOnly: true
          type: array
          description: List of item IDs which are duplicate of this item in the datarequest
          items:
            type: string
        refresh_id:
          type: string
          description: Unique ID of a scheduled refresh identified by MeasureOne
        source_data:
          type: array
          items:
            $ref: '#/components/schemas/SourceData'
          description: >-
            Source data object contains one complete academic record. Multiple
            source data objects containing `source_data_value` will result in an
            error
        processing_status:
          type: string
          readOnly: true
          enum:
            - IN_PROGRESS
            - COMPLETED
            - UNPROCESSABLE
          description: Processing status of the item
        data:
          type: object
          readOnly: true
          oneOf:
            - $ref: '#/components/schemas/M1_ACADEMIC_RECORD'
            - $ref: '#/components/schemas/M1_DIGEST'
            - $ref: '#/components/schemas/M1_INCOME_EMPLOYMENT_RECORD'
            - $ref: '#/components/schemas/M1_W2_RECORD'
            - $ref: '#/components/schemas/M1_INSURANCE_RECORD'
            - $ref: '#/components/schemas/M1_AUTO_INSURANCE_CLAIM_RECORD'
            - $ref: '#/components/schemas/M1_STUDENT_ID_RECORD'
            - $ref: '#/components/schemas/M1_PROCEEDS_1099_B'
            - $ref: '#/components/schemas/M1_FORM_1099_CONSOLIDATED'
            - $ref: '#/components/schemas/M1_FORM_1098_MORTGAGE_INTEREST'
            - $ref: >-
                #/components/schemas/M1_INSURANCE_ADDITIONAL_DETAILS_RECORD_SCHEMA
        check_signals:
          readOnly: true
          description: >-
            Identified check signals. More information on **[Check
            Signals](#tag/CheckSignalsIntroduction)**
          properties:
            signals:
              type: array
              description: List of signals
              items:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - METADATA_MISMATCH
                      - FONT_MISMATCH
                      - GROSS_PAY_CALC_MISMATCH
                      - NET_PAY_GREATER_THAN_GROSS
                      - W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                      - W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                      - W2_INVALID_MEDICARE_TAX_WITHHELD
                      - W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                      - OTHER
                    description: Code identifying the type of signal
                  description:
                    type: string
                    description: Human-readable description of the signal
                  context:
                    oneOf:
                      - title: GROSS_PAY_CALC_MISMATCH
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: NET_PAY_GREATER_THAN_GROSS
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_INVALID_MEDICARE_TAX_WITHHELD
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: OTHER
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
        confidence:
          description: >
            The confidence object represents attributes of an item that the
            system could not extract with high confidence.  The confidence
            object will be presented in the response when the item's file format
            is unstructured. E.g images or scanned PDF files.

            The confidence object is presented flat, as dot (.) separated JSON
            attributes of the item.  
          type: object
          properties: {}
          readOnly: true
        created_at:
          type: integer
          readOnly: true
          description: Timestamp for when the item was created
        updated_at:
          type: integer
          readOnly: true
          description: Timestamp for when the item was last updated
    uploadfiles:
      title: Upload Files
      type: object
      properties:
        files:
          type: array
          items:
            type: string
            description: Path to files being uploaded
    Item_get:
      title: Item Object
      type: object
      required:
        - source_data
        - source_data_type
        - datasource_id
      properties:
        id:
          type: string
          readOnly: true
          description: Unique ID of the item identified by MeasureOne
        individual_id:
          type: string
          deprecated: true
          description: >-
            MeasureOne generated unique identifier linked to the item. If this
            is not provided, MeasureOne will generate a new individual_id for
            given item. This attribute is deprecated
        datarequest_id:
          type: string
          description: >-
            MeasureOne generated unique datarequest identifier linked to the
            item. If this is not provided, MeasureOne will generate a new
            datarequest for given item.
        external_id:
          type: string
          description: A customer generated unique identifier linked to the item
        datasource_id:
          type: string
          description: >-
            Unique identifier of the datasource. This attribute is non-mandatory
            `M1_DIGEST` source_data_type
        source_data_type:
          type: string
          description: The type of the source_data
          enum:
            - M1_ACADEMIC_RECORD
            - M1_DIGEST
            - TRANSCRIPT_FILE
            - PAYSTUB_FILE
            - W2_FILE
            - INSURANCE_POLICY (Deprecated)
            - AUTO_INSURANCE_POLICY
            - HOME_INSURANCE_POLICY
            - RENTERS_INSURANCE_POLICY
            - UNINSURED_MOTORIST_FORM
            - AUTO_INSURANCE_CLAIM
            - INSURANCE_CARD
            - STUDENT_ID_CARD
            - PROCEEDS_1099_B
            - TWN_EDR
            - FORM_1099_B
            - FORM_1099_CONSOLIDATED
            - FORM_1099_INT
            - FORM_1099_DIV
            - FORM_1099_OID
            - FORM_1099_MISC
            - FORM_1099_NEC
            - FORM_1098
            - POLICY_LISTING
            - POLICY_DETAILS
            - VEHICLE_LISTING
            - VEHICLE_DETAILS
          x-enumDescriptions:
            M1_ACADEMIC_RECORD: JSON payload constituting the academic Record of the Individual
            M1_DIGEST: JSON payload for Digest of the academic record
            TRANSCRIPT_FILE: PDF, HTML or Image of the academic transcript
            PAYSTUB_FILE: PDF or HTML of the paystub
            W2_FILE: PDF of the W-2
            INSURANCE_POLICY (Deprecated): >-
              PDF, HTML or Image of the insurance policy (Deprecated). Use
              AUTO_INSURANCE_POLICY or HOME_INSURANCE_POLICY
            AUTO_INSURANCE_POLICY: PDF, HTML or Image of the auto insurance policy
            HOME_INSURANCE_POLICY: PDF, HTML or Image of the home insurance policy
            RENTERS_INSURANCE_POLICY: PDF, HTML or Image of the renters insurance policy
            UNINSURED_MOTORIST_FORM: PDF of  uninsured motorist form
            AUTO_INSURANCE_CLAIM: JSON payload constituting the auto insurance claim record
            INSURANCE_CARD: PDF or Image of the insurance card
            STUDENT_ID_CARD: PDF or Image of the Student ID
            PROCEEDS_1099_B: PDF of 1099-B
            TWN_EDR: PDF of TWN Employment Data Report
            FORM_1099_B: PDF or Image of the 1099 B
            FORM_1099_CONSOLIDATED: PDF or Image of the Consolidated tax statement
            FORM_1099_INT: PDF or Image of the 1099 INT
            FORM_1099_DIV: PDF or Image of the 1099 DIV
            FORM_1099_OID: PDF or Image of the 1099 OID
            FORM_1099_MISC: PDF or Image of the 1099 MISC
            FORM_1099_NEC: PDF or Image of the 1099 NEC
            FORM_1098: PDF or Image of the 1098
            POLICY_LISTING: PDF, HTML or JSON of insurance policy
            POLICY_DETAILS: PDF, HTML or JSON of insurance policy
            VEHICLE_LISTING: PDF, HTML or JSON of insurance vehicle
            VEHICLE_DETAILS: PDF, HTML or JSON of insurance vehicle
        media_type:
          type: string
          description: |
            Media type of the source data document
          oneOf:
            - title: TRANSCRIPT_FILE
              type: string
              description: Media type supported for TRANSCRIPT_FILE
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: PAYSTUB_FILE
              type: string
              description: Media type supported for PAYSTUB_FILE
              enum:
                - application/pdf
                - image/pdf
                - text/html
            - title: W2_FILE
              type: string
              description: Media type supported for W2_FILE
              enum:
                - application/pdf
                - image/pdf
            - title: INSURANCE_POLICY (Deprecated)
              type: string
              description: Media type supported for INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: AUTO_INSURANCE_POLICY
              type: string
              description: Media type supported for AUTO_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: HOME_INSURANCE_POLICY
              type: string
              description: Media type supported for HOME_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: RENTERS_INSURANCE_POLICY
              type: string
              description: Media type supported for RENTERS_INSURANCE_POLICY
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
                - text/html
            - title: UNINSURED_MOTORIST_FORM
              type: string
              description: Media type supported for UNINSURED_MOTORIST_FORM
              enum:
                - application/pdf
                - image/pdf
            - title: INSURANCE_CARD
              type: string
              description: Media type supported for INSURANCE_CARD
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
            - title: STUDENT_ID_CARD
              type: string
              description: Media type supported for STUDENT_ID_CARD
              enum:
                - application/pdf
                - image/jpeg
                - image/jpg
                - image/png
                - image/tif
                - image/tiff
                - image/bmp
                - image/pdf
            - title: PROCEEDS_1099_B
              type: string
              description: Media type supported for PROCEEDS_1099_B
              enum:
                - application/pdf
                - image/pdf
            - title: TWN_EDR
              type: string
              description: Media type supported for TWN_EDR
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_B
              type: string
              description: Media type supported for FORM_1099_B
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_CONSOLIDATED
              type: string
              description: Media type supported for FORM_1099_CONSOLIDATED
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_INT
              type: string
              description: Media type supported for FORM_1099_INT
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_DIV
              type: string
              description: Media type supported for FORM_1099_DIV
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_OID
              type: string
              description: Media type supported for FORM_1099_OID
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_MISC
              type: string
              description: Media type supported for FORM_1099_MISC
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1099_NEC
              type: string
              description: Media type supported for FORM_1099_NEC
              enum:
                - application/pdf
                - image/pdf
            - title: FORM_1098
              type: string
              description: Media type supported for FORM_1098
              enum:
                - application/pdf
                - image/pdf
            - title: POLICY_LISTING
              type: string
              description: Media type supported for POLICY_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: POLICY_LISTING
              type: string
              description: Media type supported for POLICY_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: VEHICLE_LISTING
              type: string
              description: Media type supported for VEHICLE_LISTING
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
            - title: VEHICLE_DETAILS
              type: string
              description: Media type supported for VEHICLE_DETAILS
              enum:
                - application/pdf
                - image/pdf
                - text/html
                - application/json
        duplicates:
          readOnly: true
          type: array
          description: List of item IDs which are duplicate of this item in the datarequest
          items:
            type: string
        refresh_id:
          type: string
          description: Unique ID of a scheduled refresh identified by MeasureOne
        source_data:
          type: array
          items:
            $ref: '#/components/schemas/SourceData'
          description: >-
            Source data object contains one complete academic record. Multiple
            source data objects containing `source_data_value` will result in an
            error
        processing_status:
          type: string
          readOnly: true
          enum:
            - IN_PROGRESS
            - COMPLETED
            - UNPROCESSABLE
          description: Processing status of the item
        data:
          type: object
          readOnly: true
          oneOf:
            - $ref: '#/components/schemas/M1_ACADEMIC_RECORD'
            - $ref: '#/components/schemas/M1_DIGEST'
            - $ref: '#/components/schemas/M1_INCOME_EMPLOYMENT_RECORD'
            - $ref: '#/components/schemas/M1_W2_RECORD'
            - $ref: '#/components/schemas/M1_INSURANCE_RECORD'
            - $ref: '#/components/schemas/M1_AUTO_INSURANCE_CLAIM_RECORD'
            - $ref: '#/components/schemas/M1_STUDENT_ID_RECORD'
            - $ref: '#/components/schemas/M1_PROCEEDS_1099_B'
            - $ref: '#/components/schemas/M1_FORM_1099_CONSOLIDATED'
            - $ref: '#/components/schemas/M1_FORM_1098_MORTGAGE_INTEREST'
            - $ref: >-
                #/components/schemas/M1_INSURANCE_ADDITIONAL_DETAILS_RECORD_SCHEMA
        check_signals:
          readOnly: true
          description: >-
            Identified check signals. More information on **[Check
            Signals](#tag/CheckSignalsIntroduction)**
          properties:
            signals:
              type: array
              description: List of signals
              items:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - METADATA_MISMATCH
                      - FONT_MISMATCH
                      - GROSS_PAY_CALC_MISMATCH
                      - NET_PAY_GREATER_THAN_GROSS
                      - W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                      - W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                      - W2_INVALID_MEDICARE_TAX_WITHHELD
                      - W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                      - OTHER
                    description: Code identifying the type of signal
                  description:
                    type: string
                    description: Human-readable description of the signal
                  context:
                    oneOf:
                      - title: GROSS_PAY_CALC_MISMATCH
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: NET_PAY_GREATER_THAN_GROSS
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_SOCIAL_SECURITY_WAGE_OVERLIMIT
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_INVALID_SOCIAL_SECURITY_TAX_WITHHELD
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_INVALID_MEDICARE_TAX_WITHHELD
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: W2_WAGES_GREATER_THAN_MEDICARE_WAGES
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                      - title: OTHER
                        type: object
                        properties:
                          attributes:
                            type: array
                            description: List of attributes
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
        confidence:
          description: >
            The confidence object represents attributes of an item that the
            system could not extract with high confidence.  The confidence
            object will be presented in the response when the item's file format
            is unstructured. E.g images or scanned PDF files.

            The confidence object is presented flat, as dot (.) separated JSON
            attributes of the item.  
          type: object
          properties: {}
          readOnly: true
        created_at:
          type: integer
          readOnly: true
          description: Timestamp for when the item was created
        updated_at:
          type: integer
          readOnly: true
          description: Timestamp for when the item was last updated
    ServiceContextParent:
      title: service_context_id
      type: object
      required:
        - service_context_id
      properties:
        service_context_id:
          type: string
          description: Unique ID of the service context identified by MeasureOne
    TransactionParent:
      title: transaction_id
      type: object
      description: >-
        Service APIs calls with datarequest_id and individual are asynchronous
        in nature. You can initiate a service by calling service API with
        datarequest_id and individual. Call Service APIs with transaction_id to
        get the results.
      deprecated: true
      required:
        - transaction_id
      properties:
        transaction_id:
          type: string
          description: Unique ID of the Transaction identified by MeasureOne
    DataRequestParent:
      title: datarequest_id
      type: object
      description: >-
        Service APIs calls with datarequest_id and individual are asynchronous
        in nature. You can initiate a service by calling service API with
        datarequest_id and individual. Call Service APIs with transaction_id to
        get the results.
      required:
        - datarequest_id
      properties:
        datarequest_id:
          type: string
          description: Unique ID of the Data Request identified by MeasureOne
        metadata:
          type: object
          description: >-
            metadata can be used for storing additional information in a
            structured format. metadata will be sent in webhooks and report
            response.
    Student:
      title: Student
      type: object
      properties:
        first_name:
          type: string
          description: First name of the Individual
        middle_name:
          type: string
          description: Middle name of the Individual
        last_name:
          type: string
          description: Last Name of the Individual
        prefix:
          type: string
          description: Name prefix
        suffix:
          type: string
          description: Name suffix
        full_name:
          type: string
          description: Full name of the Individual
        former_first_name:
          type: string
          description: Former first name of the Individual
        former_middle_name:
          type: string
          description: Former middle name of the Individual
        former_last_name:
          type: string
          description: Former last Name of the Individual
        former_prefix:
          type: string
          description: Former name prefix
        former_suffix:
          type: string
          description: Former name suffix
        former_full_name:
          type: string
          description: Former full name of the Individual
        date_of_birth:
          type: string
          description: Date of Birth of the Individual in MM/DD/YYYY format.
        ssn:
          type: string
          description: Social Security Number of the Individual
        email:
          type: string
          description: Email address of the Individual
        address:
          type: object
          properties:
            addr1:
              type: string
            addr2:
              type: string
            city:
              type: string
            state:
              type: string
            zipcode:
              type: string
            country:
              type: object
              properties:
                name:
                  type: string
        phone_number:
          type: string
          description: Phone number of the Individual
    Degree:
      title: Degree
      type: object
      properties:
        type:
          type: string
          description: >-
            Level of the degree. Enum  `ASSOCIATE`, `BACHELORS`, `MASTERS`,
            `MASTERS-RESEARCH`, `DOCTORAL`, `CERTIFICATE`, `DIPLOMA`,
            `NON-DEGREE`, `PROFESSIONAL`, `UNDERGRADUATE`, `UNKNOWN`
        description:
          type: string
          description: Name of the degree
        status:
          type: string
          description: >-
            Status of the degree. Enum `AWARDED`, `ENROLLED`, `WITHDRAWN`,
            `TERMINATED`, `UNKNOWN`
        awarded_date:
          type: string
          description: Degree awarded date (applicable to graduates only)
        years_of_study:
          type: number
          description: Number of years of study for the given degree
        majors:
          type: array
          description: List of enrolled majors for the given degree
          items:
            type: string
        concentrations:
          type: array
          description: List of enrolled concentrations for the given degree
          items:
            type: string
        minors:
          type: array
          description: List of enrolled minors for the given degree
          items:
            type: string
        gpa_range:
          type: object
          description: GPA range for School/University
          properties:
            minimum:
              type: number
              description: value scale for GPA
            maximum:
              type: number
              description: value scale for GPA
        gpa:
          type: number
          description: GPA earned in the degree
        credits:
          type: number
          description: Credits earned in the degree
    AcademicSummary:
      title: Academic Summary
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
            address:
              type: object
              description: Address of datasource
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        student:
          $ref: '#/components/schemas/Student'
        degrees:
          type: array
          description: List of degrees
          items:
            $ref: '#/components/schemas/Degree'
        attendance:
          type: array
          title: Attendance
          items:
            properties:
              start_date:
                type: string
              end_date:
                type: string
        gpa_range:
          type: object
          description: GPA range for School/University
          properties:
            minimum:
              type: number
              description: value scale for GPA
            maximum:
              type: number
              description: value scale for GPA
        gpa:
          type: number
          description: GPA earned
        teaching_institution:
          type: object
          description: >-
            Object with information about the teaching institution for which the
            transcript was issued
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        degree_awarding_institution:
          type: object
          description: >-
            Object with information about the degree awarding institution for
            which the transcript was issued
          properties:
            name:
              type: string
              description: Name of the institution
            id:
              type: string
              description: Unique identifier of the institute
            id_type:
              type: string
              description: >-
                Type of ID used to identify given institution Enum
                `IPEDS`,`CEEB`
            address:
              type: object
              description: >-
                Student's Address information as provided for previous academic
                record
              properties:
                addr1:
                  type: string
                  description: Address line 1
                addr2:
                  type: string
                  description: >-
                    Address line 2. Should be populated only if `addr1` is
                    populated
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode for the address
                country:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the country
                    a2_code:
                      type: string
                      description: Alpha-2 code for the country from ISO 3166
        credits:
          type: number
          description: Credits earned
        enrollment_status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - UNKNOWN
          description: >-
            Enrollment Status of the Individual as presented in the academic
            profile
          readOnly: true
        student_classification:
          type: object
          description: Student level of the Individual
          properties:
            code:
              type: string
              description: >-
                Code identifying the student level. Enum `FRESHMAN`,
                `FIRST_YEAR_GRADUATE`, `FIRST_YEAR_DOCTORAL`, `OTHER`
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the academic summary.
            Helps developer understand how has the academic summary been
            derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  academic summary been derived.
              context:
                type: object
                description: Context to understand where the reason code is applicable
                properties:
                  attribute:
                    type: string
                    description: >-
                      Details of JSON path attribute for which reason code is
                      applicable
                  source_data_type:
                    type: string
                    description: source data type for which reason code is applicable
          readOnly: true
        as_of_date:
          type: number
          description: timestamp in milliseconds
          readOnly: true
        enrollment_type:
          type: string
          enum:
            - FULL_TIME
            - PART_TIME
            - INACTIVE
            - UNKNOWN
          description: Enrollment type of the Individual
          readOnly: true
    EnrollmentStatus:
      title: Enrollment Status
      type: object
      required:
        - individual_id
      properties:
        datasource_id:
          type: string
          description: Unique ID of the datasource identified by MeasureOne
          readOnly: true
        enrollment_status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - INSUFFICIENT_DATA
          description: >-
            Enrollment Status of the individual as presented in the academic
            profile
          readOnly: true
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the enrollment status.
            Helps developer understand how has the enrollment status been
            derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  enrollment status been derived.
          readOnly: true
        as_of_date:
          type: number
          description: Date of status
          readOnly: true
    MeritScore:
      title: MeritScore
      type: object
      properties:
        merit_score:
          type: number
          format: double
          description: MeasureOne's MeritScore for the requested transcript
        aa_code_1:
          type: number
          format: int32
          description: First adverse action code that can be used for decline decisions
        aa_code_2:
          type: number
          format: int32
          description: Second adverse action code that can be used for decline decisions
        aa_code_3:
          type: number
          format: int32
          description: Third adverse action code that can be used for decline decisions
        version:
          type: string
    GradScore:
      title: GradScore
      type: object
      properties:
        grad_score:
          type: number
          description: MeasureOne's GradScore for the requested transcript
        aa_code_1:
          type: number
          description: First adverse action code that can be used for decline decisions
        aa_code_2:
          type: number
          description: Second adverse action code that can be used for decline decisions
        aa_code_3:
          type: number
          description: Third adverse action code that can be used for decline decisions
        version:
          type: string
          description: Version of the MeritScore
    Transcript_without_raw:
      title: Transcript Object
      type: object
      required:
        - source_data_type
      properties:
        id:
          type: string
          readOnly: true
        individual_id:
          type: string
          description: Unique ID of the individual identified by MeasureOne
        external_id:
          type: string
        datarequest_id:
          type: string
        media_type:
          type: string
        datasource_id:
          type: string
        source_data:
          type: array
          items:
            $ref: '#/components/schemas/SourceData'
        source_data_type:
          type: string
          description: The type of the source_data
          enum:
            - M1_ACADEMIC_RECORD
            - M1_DIGEST
            - M1_INCOME_EMPLOYMENT_RECORD
            - M1_INSURANCE_RECORD
            - TRANSCRIPT_FILE
            - PAYSTUB_FILE
            - W2_FILE
            - INSURANCE_POLICY
          x-enumDescriptions:
            M1_ACADEMIC_RECORD: JSON payload constituting the academic Record of the Individual
            M1_DIGEST: JSON payload for Digest of the academic record
            M1_INCOME_EMPLOYMENT_RECORD: >-
              JSON payload constituting the employment/income details of the
              Individual
            M1_INSURANCE_RECORD: JSON Payload for Insurance.
            TRANSCRIPT_FILE: PDF, HTML or Image of the academic transcript
            PAYSTUB_FILE: PDF, HTML or Image of the paystub
            W2_FILE: PDF, HTML or Image of the W-2
            INSURANCE_POLICY: PDF, HTML or Image of the insurance policy
        created_at:
          type: integer
          readOnly: true
        updated_at:
          type: integer
          readOnly: true
        processing_status:
          type: string
          readOnly: true
          enum:
            - IN_PROGRESS
            - COMPLETED
          description: Processing status of the transcript
        data:
          type: object
          readOnly: true
          $ref: '#/components/schemas/M1_DIGEST'
    IncomeSummary:
      title: Income Summary
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
            provider_name:
              type: string
              description: Name of provider
        as_of_date:
          type: number
          description: Timestamp (milliseconds) when this record was generated
        remitter:
          type: object
          description: Remitter information
          properties:
            name:
              type: string
              description: Name of the Remitter
            phone_number:
              type: string
              description: Phone number of the remitter
            ein:
              type: string
              description: Employer identification number
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        beneficiary:
          type: object
          description: Beneficiary information
          properties:
            first_name:
              type: string
              description: First name of the beneficiary
              maxLength: 45
            middle_name:
              type: string
              description: Middle name of the beneficiary
              maxLength: 45
            last_name:
              type: string
              description: Last Name of the beneficiary
              maxLength: 45
            email:
              type: string
              description: Email address of the beneficiary
            prefix:
              type: string
              description: Name prefix
              maxLength: 5
            suffix:
              type: string
              description: Name suffix
              maxLength: 5
            gender:
              type: string
              description: Gender of the beneficiary
              maxLength: 1
            phone_number:
              type: string
              description: Phone number of the beneficiary
            date_of_birth:
              type: string
              description: Date of Birth of the beneficiary in MM/DD/YYYY format.
            ssn:
              type: string
              description: Social Security Number of the the beneficiary
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        earnings:
          type: array
          description: Earning of the beneficiary
          items:
            properties:
              type:
                type: string
                description: type of earning
                enum:
                  - SALARY
                  - WAGE
                  - INVESTMENT
                  - RENTAL
                  - COMMISSION
                  - INTEREST
                  - INVESTMENT
                  - ROYALTY
                  - GIFTS
                  - ALLOWANCE
                  - GOVERNMENT_PAYMENT
                  - DIVIDENDS
                  - RETIREMENT_PENSION
                  - TAX_REFUND
                  - UNEMPLOYMENT
                  - TRANSFER_IN
                  - OTHER_DEPOSITS
                  - NONEMPLOYEE_COMPENSATION
                  - OTHER
              basis:
                type: string
                description: Basis of earnings
                enum:
                  - HOURLY
                  - MONTHLY
                  - SEMI_MONTHLY
                  - WEEKLY
                  - ANNUAL
                  - BI_WEEKLY
                  - OTHER
              pay_date:
                type: string
                description: Payment date timestamp (milliseconds)
              interval:
                type: object
                description: earning interval
                properties:
                  start_date:
                    type: number
                    description: earning start date timestamp (milliseconds)
                  end_date:
                    type: number
                    description: earning end date timestamp (milliseconds)
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Earning currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of amount
                      enum:
                        - GROSS
                        - NET
                        - REGULAR
                        - OVERTIME
                        - BONUS
                        - COMMISSION
                        - OTHER
                        - W2_REPORTED_INCOME
                        - F1099_INT_REPORTED_INCOME
                        - F1099_DIV_REPORTED_INCOME
                        - F1099_B_REPORTED_INCOME
                        - F1099_OID_REPORTED_INCOME
                        - F1099_MISC_REPORTED_INCOME
                    description:
                      type: string
                      description: >-
                        Description of amount. Description would be populated
                        when include_earnings_description is `true` for the
                        request.
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of earning amount
        yearly_earnings:
          type: array
          description: Yearly earnings of the beneficiary
          items:
            properties:
              year:
                type: integer
                description: year of earning
              type:
                type: string
                description: type of earning
                enum:
                  - SALARY
                  - WAGE
                  - INVESTMENT
                  - RENTAL
                  - COMMISSION
                  - INTEREST
                  - INVESTMENT
                  - ROYALTY
                  - GIFTS
                  - ALLOWANCE
                  - GOVERNMENT_PAYMENT
                  - DIVIDENDS
                  - RETIREMENT_PENSION
                  - TAX_REFUND
                  - UNEMPLOYMENT
                  - TRANSFER_IN
                  - OTHER_DEPOSITS
                  - NONEMPLOYEE_COMPENSATION
                  - OTHER
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Earning currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of amount
                      enum:
                        - GROSS
                        - NET
                        - REGULAR
                        - OVERTIME
                        - BONUS
                        - COMMISSION
                        - OTHER
                        - F1099_NEC_REPORTED_INCOME
                        - W2_REPORTED_INCOME
                        - F1099_INT_REPORTED_INCOME
                        - F1099_DIV_REPORTED_INCOME
                        - F1099_B_REPORTED_INCOME
                        - F1099_OID_REPORTED_INCOME
                        - F1099_MISC_REPORTED_INCOME
                    description:
                      type: string
                      description: >-
                        Description of amount. Description would be populated
                        when include_earnings_description is `true` for the
                        request.
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of earning amount
        account_holders:
          type: array
          description: >-
            List of account holders associated with the connected bank account.
            **This attribute will be populated only when the summary is
            generated through bank account connection**
          items:
            properties:
              name:
                type: string
                description: Name of the account holder
              email:
                type: string
                description: Email of the account holder
              phone_number:
                type: string
                description: Phone number of the account holder
              addresss:
                type: object
                description: Address of the account holder
                properties:
                  addr1:
                    type: string
                  addr2:
                    type: string
                  city:
                    type: string
                  state_name:
                    type: string
                  zipcode:
                    type: string
                  country:
                    type: object
                    properties:
                      name:
                        type: string
        reference_items:
          type: array
          description: Array of item ids used for determining the income summary.
          items:
            type: string
            example: itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the income summary. Helps
            developer understand how has the summary been derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  summary been derived.
    EmploymentSummary:
      title: Employment Summary
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
            provider_name:
              type: string
              description: Name of provider
        as_of_date:
          type: number
          description: Timestamp (milliseconds) when this record was generated
        employer:
          type: object
          description: employer information
          properties:
            name:
              type: string
              description: Name of the employer
            phone_number:
              type: string
              description: Phone number of the employer
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        employee:
          type: object
          properties:
            service_details:
              type: object
              properties:
                employee_id:
                  type: string
                  description: employee_id provided by the employer
                hire_date:
                  type: number
                  description: Hire date of the employee (timestamp in milliseconds)
                status:
                  type: string
                  description: Status of employee with the employee
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - TERMINATED
                    - UNKNOWN
                salary:
                  type: number
                  description: Salary of the employee
                salary_basis:
                  type: string
                  description: Basis of salary
                  enum:
                    - HOURLY
                    - MONTHLY
                    - SEMI_MONTHLY
                    - WEEKLY
                    - BI_WEEKLY
                    - ANNUAL
                    - OTHER
                termination_date:
                  type: number
                  description: Termination date of the employee (timestamp in milliseconds)
                termination_reason:
                  type: string
                  description: Termination reason
            first_name:
              type: string
              description: First name of the employee
              maxLength: 45
            middle_name:
              type: string
              description: Middle name of the employee
              maxLength: 45
            last_name:
              type: string
              description: Last Name of the employee
              maxLength: 45
            email:
              type: string
              description: Email address of the employee
            prefix:
              type: string
              description: Name prefix
              maxLength: 5
            suffix:
              type: string
              description: Name suffix
              maxLength: 5
            gender:
              type: string
              description: Gender of the employee
              maxLength: 1
            phone_number:
              type: string
              description: Phone number of the employee
            date_of_birth:
              type: string
              description: Date of Birth of the employee in MM/DD/YYYY format.
            ssn:
              type: string
              description: Social Security Number of the the employee
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        roles:
          type: array
          description: Array of objects representing Employment of an Individual
          items:
            properties:
              position:
                type: object
                properties:
                  name:
                    type: string
                    description: Name of the position
                  title:
                    type: string
                    description: Title of the position
              type:
                type: string
                description: type of position
                enum:
                  - FULL_TIME
                  - PART_TIME
                  - CONTRACT
                  - OTHER
              supervisor:
                type: string
                description: Name of supervisor
              interval:
                type: object
                properties:
                  start_date:
                    type: number
                    description: Start date timestamp (milliseconds) of the deployment
                  end_date:
                    type: number
                    description: End date timestamp (milliseconds) of the deployment
              location:
                type: object
                properties:
                  name:
                    type: string
                    description: Location name
                  address:
                    type: object
                    properties:
                      addr1:
                        type: string
                      addr2:
                        type: string
                      city:
                        type: string
                      state_name:
                        type: string
                      zipcode:
                        type: string
                      country:
                        type: object
                        properties:
                          name:
                            type: string
              department:
                type: string
                description: Department during the deployment
        reference_items:
          type: array
          description: Array of item ids used for determining the employment summary.
          items:
            type: string
            example: itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the employment summary.
            Helps developer understand how has the summary been derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  summary been derived.
    VOIESummary:
      title: Income Employment Details
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
            provider_name:
              type: string
              description: Name of provider
        as_of_date:
          type: number
          description: Timestamp (milliseconds) when this record was generated
        datarequest_id:
          type: string
          description: Unique ID of the Data Request identified by MeasureOne
        employer:
          type: object
          description: Employer information
          properties:
            name:
              type: string
              description: Name of the employer
            phone_number:
              type: string
              description: Phone number of the employer
            ein:
              type: string
              description: Employer identification number
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        employee:
          type: object
          properties:
            service_details:
              type: object
              properties:
                employee_id:
                  type: string
                  description: employee_id provided by the employer
                hire_date:
                  type: number
                  description: Hire date of the employee (timestamp in milliseconds)
                status:
                  type: string
                  description: Status of employee with the employer
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - TERMINATED
                    - UNKNOWN
                salary:
                  type: number
                  description: Salary of the employee
                salary_basis:
                  type: string
                  description: Basis of salary
                  enum:
                    - HOURLY
                    - MONTHLY
                    - SEMI_MONTHLY
                    - WEEKLY
                    - BI_WEEKLY
                    - ANNUAL
                    - OTHER
                termination_date:
                  type: number
                  description: Termination date of the employee (timestamp in milliseconds)
                termination_reason:
                  type: string
                  description: Termination reason
            first_name:
              type: string
              description: First name of the employee
              maxLength: 45
            middle_name:
              type: string
              description: Middle name of the employee
              maxLength: 45
            last_name:
              type: string
              description: Last Name of the employee
              maxLength: 45
            email:
              type: string
              description: Email address of the employee
            prefix:
              type: string
              description: Name prefix
              maxLength: 5
            suffix:
              type: string
              description: Name suffix
              maxLength: 5
            gender:
              type: string
              description: Gender of the employee
              maxLength: 1
            phone_number:
              type: string
              description: Phone number of the employee
            date_of_birth:
              type: string
              description: Date of Birth of the employee in MM/DD/YYYY format.
            ssn:
              type: string
              description: Social Security Number of the the employee
            address:
              type: object
              properties:
                addr1:
                  type: string
                addr2:
                  type: string
                city:
                  type: string
                state_name:
                  type: string
                zipcode:
                  type: string
                country:
                  type: object
                  properties:
                    name:
                      type: string
        roles:
          type: array
          description: Array of objects representing Employment of an Individual
          items:
            properties:
              position:
                type: object
                properties:
                  name:
                    type: string
                    description: Name of the position
                  title:
                    type: string
                    description: Title of the position
              type:
                type: string
                description: Type of position
                enum:
                  - FULL_TIME
                  - PART_TIME
                  - CONTRACT
                  - OTHER
              supervisor:
                type: string
                description: Name of supervisor
              interval:
                type: object
                properties:
                  start_date:
                    type: number
                    description: Start date timestamp (milliseconds) of the deployment
                  end_date:
                    type: number
                    description: End date timestamp (milliseconds) of the deployment
              location:
                type: object
                properties:
                  name:
                    type: string
                    description: Location name
                  address:
                    type: object
                    properties:
                      addr1:
                        type: string
                      addr2:
                        type: string
                      city:
                        type: string
                      state_name:
                        type: string
                      zipcode:
                        type: string
                      country:
                        type: object
                        properties:
                          name:
                            type: string
              department:
                type: string
                description: Department during the deployment
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the income employment
            details. Helps developer understand how has the details been
            derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  details been derived.
        earnings:
          type: array
          description: Earnings of the employee
          items:
            properties:
              type:
                type: string
                description: Type of earning
                enum:
                  - SALARY
                  - WAGE
                  - INVESTMENT
                  - RENTAL
                  - COMMISSION
                  - INTEREST
                  - INVESTMENT
                  - ROYALTY
                  - GIFTS
                  - ALLOWANCE
                  - GOVERNMENT_PAYMENT
                  - DIVIDENDS
                  - RETIREMENT_PENSION
                  - TAX_REFUND
                  - UNEMPLOYMENT
                  - TRANSFER_IN
                  - OTHER_DEPOSITS
                  - NONEMPLOYEE_COMPENSATION
                  - OTHER
              basis:
                type: string
                description: Basis of earnings
                enum:
                  - HOURLY
                  - MONTHLY
                  - SEMI_MONTHLY
                  - WEEKLY
                  - ANNUAL
                  - BI_WEEKLY
                  - OTHER
              pay_date:
                type: string
                description: Payment date timestamp (milliseconds)
              interval:
                type: object
                description: Earning interval
                properties:
                  start_date:
                    type: number
                    description: Start date timestamp (milliseconds) of the earning
                  end_date:
                    type: number
                    description: End date timestamp (milliseconds) of the earning
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Earning currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of amount
                      enum:
                        - GROSS
                        - NET
                        - REGULAR
                        - OVERTIME
                        - BONUS
                        - COMMISSION
                        - OTHER
                        - W2_REPORTED_INCOME
                        - F1099_INT_REPORTED_INCOME
                        - F1099_DIV_REPORTED_INCOME
                        - F1099_B_REPORTED_INCOME
                        - F1099_OID_REPORTED_INCOME
                        - F1099_MISC_REPORTED_INCOME
                    description:
                      type: string
                      description: >-
                        Description of amount. Description would be populated
                        when include_earnings_description is `true` for the
                        request.
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of earning amount
                    rate:
                      type: number
                      description: Pay rate of the employee
                    hours:
                      type: number
                      description: Number of hours worked
        yearly_earnings:
          type: array
          description: Yearly earnings of the employee
          items:
            properties:
              year:
                type: integer
                description: year of earning
              type:
                type: string
                description: type of earning
                enum:
                  - SALARY
                  - WAGE
                  - INVESTMENT
                  - RENTAL
                  - COMMISSION
                  - INTEREST
                  - INVESTMENT
                  - ROYALTY
                  - GIFTS
                  - ALLOWANCE
                  - GOVERNMENT_PAYMENT
                  - DIVIDENDS
                  - RETIREMENT_PENSION
                  - TAX_REFUND
                  - UNEMPLOYMENT
                  - TRANSFER_IN
                  - OTHER_DEPOSITS
                  - NONEMPLOYEE_COMPENSATION
                  - OTHER
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Earning currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of amount
                      enum:
                        - GROSS
                        - NET
                        - REGULAR
                        - OVERTIME
                        - BONUS
                        - COMMISSION
                        - OTHER
                        - F1099_NEC_REPORTED_INCOME
                        - W2_REPORTED_INCOME
                        - F1099_INT_REPORTED_INCOME
                        - F1099_DIV_REPORTED_INCOME
                        - F1099_B_REPORTED_INCOME
                        - F1099_OID_REPORTED_INCOME
                        - F1099_MISC_REPORTED_INCOME
                    description:
                      type: string
                      description: >-
                        Description of amount. Description would be populated
                        when include_earnings_description is `true` for the
                        request.
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of earning amount
        account_holders:
          type: array
          description: >-
            List of account holders associated with the connected bank account.
            **This attribute will be populated only when the summary is
            generated through bank account connection**
          items:
            properties:
              name:
                type: string
                description: Name of the account holder
              email:
                type: string
                description: Email of the account holder
              phone_number:
                type: string
                description: Phone number of the account holder
              addresss:
                type: object
                description: Address of the account holder
                properties:
                  addr1:
                    type: string
                  addr2:
                    type: string
                  city:
                    type: string
                  state_name:
                    type: string
                  zipcode:
                    type: string
                  country:
                    type: object
                    properties:
                      name:
                        type: string
        deductions:
          type: array
          description: Deductions of the employee
          items:
            properties:
              type:
                type: string
                description: Type of deduction
                enum:
                  - OTHER
              interval:
                type: object
                description: Deduction interval
                properties:
                  start_date:
                    type: number
                    description: Start date timestamp of the deduction
                  end_date:
                    type: number
                    description: End date timestamp of the deduction
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Deduction currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of deduction
                      enum:
                        - OTHER
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of deduction amount
        benefits:
          type: array
          description: Benefits of the employee
          items:
            properties:
              type:
                type: string
                description: Type of benefit
                enum:
                  - OTHER
              interval:
                type: object
                description: Benefit interval
                properties:
                  start_date:
                    type: number
                    description: Start date timestamp of the benefit
                  end_date:
                    type: number
                    description: End date timestamp of the benefit
              amounts:
                type: array
                items:
                  properties:
                    currency:
                      type: string
                      description: Benefit currency
                      enum:
                        - USD
                        - OTHER
                    type:
                      type: string
                      description: Type of benefit
                      enum:
                        - OTHER
                    ytd_flag:
                      type: boolean
                      description: Indicates if the amount given is year to date
                    value:
                      type: number
                      description: Value of benefit amount
        reference_items:
          type: array
          description: Array of item ids used for determining the VOIE summary.
          items:
            type: string
            example: itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
    InsuranceDetails:
      title: Insurance Details
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
        as_of_date:
          type: number
          description: timestamp when this record was generated
        cancelled_date:
          type: string
          description: Date on which the insurance was cancelled
        pending_cancel_date:
          type: string
          description: Date on which the insurance will be cancelled
        policy_number:
          type: string
          description: Policy number
        status:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
            - PENDING_ACTIVATION
            - PENDING_CANCELLATION
            - PENDING_EXPIRATION
            - CANCELLED
            - UNVERIFIED
            - RESCINDED
            - NOT_AVAILABLE
        policy_types:
          type: array
          items:
            type: string
            enum:
              - AUTO
              - HOME
              - RENTERS
              - PERSONAL_UMBRELLA
        premium_amount:
          type: object
          description: Premium amount of policy
          properties:
            currency:
              type: string
              description: Currency of premium amount. e.g. `USD`, `CAD`
            amount:
              type: number
              description: Premium amount
        payment_frequency:
          type: string
          description: Frequency of payment.
          enum:
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTERLY
            - MONTHLY
            - SEMI_MONTHLY
            - OTHER
        coverage_period:
          type: object
          description: Insurance coverage period
          properties:
            start_date:
              type: string
              description: Start date timestamp of policy coverage
            end_date:
              type: string
              description: End date timestamp of policy coverage
        policy_holders:
          type: array
          description: List of policy holders
          items:
            properties:
              name:
                type: string
                description: Name of the policy holder
              phone_number:
                type: string
                description: Phone number of the policy holder
              address:
                type: object
                description: Address of the policy holder
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
        insurance_provider:
          type: object
          description: Details of insurance provider
          properties:
            name:
              type: string
              description: Name of the insurance provider
            phone_number:
              type: string
              description: Phone number of the insurance provider
            address:
              type: object
              description: Address of the insurance holder
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        remit_to:
          type: object
          description: Details of entity to whom premium is remitted
          properties:
            name:
              type: string
              description: Name of the entity to whom premium is remitted
            phone_number:
              type: string
              description: Phone number of the entity to whom premium is remitted
            address:
              type: object
              description: Address of the entity to whom premium is remitted
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        insurance_agent:
          type: object
          description: Details of insurance agent
          properties:
            name:
              type: string
              description: Name of the insurance agent
            phone_number:
              type: string
              description: Phone number of the insurance agent
            address:
              type: object
              description: Address of the insurance agent
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        coverages:
          type: array
          description: List of policy coverages
          items:
            properties:
              type:
                type: string
                description: Type of coverage.
                enum:
                  - AUTO
                  - HOME
                  - RENTERS
                  - PERSONAL_UMBRELLA
              premium_amount:
                type: object
                description: Premium amount for coverage
                properties:
                  currency:
                    type: string
                    description: Currency of premium amount. e.g. `USD`, `CAD`
                  amount:
                    type: number
                    description: Premium amount
              details:
                oneOf:
                  - title: Auto
                    type: object
                    description: Auto coverage details
                    properties:
                      vehicle_info:
                        type: object
                        description: Details of insured vehicle
                        properties:
                          vin:
                            type: string
                            description: Vehicle identification number
                          model:
                            type: string
                            description: Model of the vehicle
                          make:
                            type: string
                            description: Make of the vehicle
                          year:
                            type: number
                            description: Year when the vehicle was manufactured
                          brand:
                            type: string
                            description: Brand name of the vehicle
                          garaging_address:
                            type: object
                            description: Garaging location
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          current_mileage:
                            oneOf:
                              - title: Range
                                type: object
                                description: Auto yearly mileage as range
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      range:
                                        type: string
                                        description: Mileage in a range
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                              - title: Value
                                type: object
                                description: Auto yearly mileage given as exact value
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      value:
                                        type: number
                                        description: Value of mileage
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                          yearly_mileage:
                            oneOf:
                              - title: Range
                                type: object
                                description: Auto yearly mileage as range
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      range:
                                        type: string
                                        description: Mileage in a range
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                              - title: Value
                                type: object
                                description: Auto yearly mileage given as exact value
                                properties:
                                  type:
                                    type: string
                                    description: Type of mileage.
                                    enum:
                                      - RANGE
                                      - VALUE
                                  details:
                                    type: object
                                    description: Details of mileage
                                    properties:
                                      value:
                                        type: number
                                        description: Value of mileage
                                      unit:
                                        type: string
                                        description: Unit of mileage.
                                        enum:
                                          - MI
                                          - KM
                          fuel_type:
                            type: string
                            description: Fuel type of the vehicle
                          transmission_type:
                            type: string
                            description: Transmission type of the vehicle
                          usage_type:
                            type: string
                            description: Usage type of vehicle.
                            enum:
                              - PERSONAL
                              - BUSINESS
                              - OTHER
                          usage_sub_type:
                            type: string
                            description: Usage sub type of vehicle.
                            enum:
                              - PERSONAL
                              - BUSINESS
                              - PLEASURE
                              - COMMUTE
                              - WORK
                              - SCHOOL
                              - FARM
                              - OTHER
                          purchase_date:
                            type: string
                            description: Date when the vehicle was purchased.
                          ownership_type:
                            type: string
                            enum:
                              - SELF_OR_SPOUSE
                              - CO_OWNED
                              - FINANCED
                              - LEASED
                            description: Ownership status of the vehicle.
                          is_removed:
                            type: boolean
                            description: >-
                              Indicates whether the vehicle has been removed
                              from the policy.
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - LIEN_HOLDER
                                    - SERVICING_AGENT
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      drivers:
                        type: array
                        description: List of drivers
                        items:
                          properties:
                            first_name:
                              type: string
                              description: First name of the driver
                            middle_name:
                              type: string
                              description: Middle name of the driver
                            last_name:
                              type: string
                              description: Last name of the driver
                            full_name:
                              type: string
                              description: Full name of the driver
                            prefix:
                              type: string
                              description: Name prefix
                            suffix:
                              type: string
                              description: Name suffix
                            address:
                              type: object
                              description: Address of the driver
                              properties:
                                addr1:
                                  type: string
                                  description: Address Line 1
                                addr2:
                                  type: string
                                  description: Address Line 2
                                city:
                                  type: string
                                  description: City
                                state:
                                  type: string
                                  description: State
                                zipcode:
                                  type: string
                                  description: Zipcode
                                country:
                                  type: object
                                  description: Country details
                                  properties:
                                    name:
                                      type: string
                                      description: Country name
                                    a2_code:
                                      type: string
                                      description: Alpha-2 code of country
                            phone_number:
                              type: string
                              description: Phone number of the driver
                            email:
                              type: string
                              description: Email address of the driver
                            gender:
                              type: string
                              description: Gender of the driver
                            nationality:
                              type: string
                              description: Nationality of the driver
                            ssn:
                              type: string
                              description: SSN of the driver
                            date_of_birth:
                              type: string
                              description: Date of birth of the driver
                            marital_status:
                              type: string
                              description: Marital status of the driver
                            driving_license:
                              type: string
                              description: Driving license details of the driver
                            date_licensed:
                              type: string
                              description: Driving license date
                            license_state:
                              type: string
                              description: State in which the driver's license was issued.
                            relationship_to_insured:
                              type: string
                              enum:
                                - SELF
                                - SPOUSE
                                - CHILD
                                - PARENT
                                - SIBLING
                                - OTHER
                              description: >-
                                Relationship of the driver to the primary
                                insured.
                            age:
                              type: number
                              description: Age of the driver.
                            age_on_date:
                              type: string
                              description: Driver's age on a specific date.
                            education:
                              type: string
                              enum:
                                - LESS-THAN-HIGH-SCHOOL
                                - HIGH-SCHOOL-DIPLOMA
                                - ASSOCIATE
                                - BACHELORS
                                - MASTERS
                                - MASTERS-RESEARCH
                                - DOCTORAL
                                - CERTIFICATE
                                - DIPLOMA
                                - NON-DEGREE
                                - PROFESSIONAL
                                - UNDERGRADUATE
                              description: >-
                                Highest level of education completed by the
                                driver.
                            occupation:
                              type: string
                              description: Occupation or professional role of the driver.
                            age_licensed:
                              type: integer
                              description: Age at which the driver was issued a license.
                            is_excluded:
                              type: boolean
                              description: >-
                                Indicates whether this driver is excluded from
                                the insurance policy.
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item.
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - BODILY_INJURY
                                - PROPERTY_DAMAGE
                                - UNINSURED_MOTORIST_BODILY_INJURY
                                - UNINSURED_MOTORIST_PROPERTY_DAMAGE
                                - UNDERINSURED_MOTORIST_BODILY_INJURY
                                - UNDERINSURED_MOTORIST_PROPERTY_DAMAGE
                                - UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY
                                - >-
                                  UNINSURED_UNDERINSURED_MOTORIST_PROPERTY_DAMAGE
                                - >-
                                  UNINSURED_UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE
                                - MEDICAL_PAYMENTS
                                - PERSONAL_INJURY_PROTECTION
                                - COMPREHENSIVE_COVERAGE
                                - COLLISION_COVERAGE
                                - AUTOMOBILE_DEATH_INDEMNITY
                                - EMERGENCY_TRANSPORTATION
                                - MECHANICAL_BREAKDOWN
                                - ROADSIDE_ASSISTANCE
                                - COMBINED_ADDITIONAL_COVERAGES
                                - FUNERAL_EXPENSE_BENEFITS
                                - WITNESS_EXPENSE
                                - REWARD_COVERAGE
                                - PROOF_OF_LOSS
                                - LOSS_OF_USE
                                - CUSTOM_PARTS_EQUIPMENTS
                                - TOWING_AND_LABOR
                                - RENTAL_REIMBURSEMENT
                                - WORK_LOSS_BENEFITS
                                - PERSONAL_UMBRELLA
                                - COMBINED_SINGLE_LIMIT
                                - OPTIONAL_BODILY_INJURY_OTHERS
                                - OPTIONAL_BASIC_ECONOMIC_LOSS
                                - ADDITIONAL_PERSONAL_INJURY_PROTECTION
                                - ESSENTIAL_SERVICES
                                - DEATH_BENEFITS
                                - SURVIVOR_BENEFITS
                                - REPLACEMENT_SERVICES
                                - ATTENDANT_CARE
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage items.
                                  enum:
                                    - BI
                                    - PD
                                    - FEB
                                    - UMISG
                                    - UMIPD
                                    - COMP
                                    - COLL
                                    - LUSE
                                    - TL
                                    - RREIM
                                    - WLB
                                    - PLC
                                    - PIP
                                    - UNDSG
                                    - UNDPD
                                    - ADDA
                                    - CSL
                                    - OBI
                                    - OBEL
                                    - APIP
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            premium_amount:
                              type: object
                              description: Premium amount for coverage
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                                  is_waiver:
                                    description: Specifies if the deductible is waived.
                                    type: boolean
                  - title: Home
                    type: object
                    description: Home coverage details
                    properties:
                      property_info:
                        type: object
                        description: Details of insured property
                        properties:
                          name:
                            type: string
                            description: Name of the property
                          address:
                            type: object
                            description: Address of the property
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - FIRST_MORTGAGEE
                                    - SECOND_MORTGAGEE
                                    - THIRD_MORTGAGEE
                                    - SERVICING_AGENT
                                    - LIEN_HOLDER
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - HOMEOWNERS_ASSOCIATION
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - DWELLING
                                - PERSONAL_PROPERTY
                                - BUILDING_ADDITIONS_ALTERATIONS
                                - BUILDING_ORDINANCE
                                - LOSS_ASSESSMENT
                                - PERSONAL_LIABILITY
                                - ADDITIONAL_PREMISES_LIABILITY_EXTENSION
                                - MEDICAL_PAYMENTS
                                - WORKERS_COMPENSATION
                                - REPLACEMENT_COST_CONTENTS
                                - HOME_COMPUTERS
                                - SEWER_DRAINS
                                - JEWELRY
                                - EARTHQUAKE
                                - BUSINESS_PROPERTY
                                - LOSS_OF_USE
                                - ALL_PERILS
                                - NAMED_PERILS
                                - ALL_OTHER_PERILS
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage item.
                                  enum:
                                    - Dwell
                                    - PP
                                    - BAA
                                    - BOLAW
                                    - LAC
                                    - PPTC
                                    - ADDRL
                                    - MEDPM
                                    - WCFIN
                                    - RCC
                                    - PC
                                    - SEWER
                                    - UNJWP
                                    - ERQK
                                    - BUSPR
                                    - LUSE
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            perils:
                              type: array
                              description: Named perils present on the policy
                              items:
                                type: string
                                enum:
                                  - FIRE
                                  - LIGHTNING
                                  - EXPLOSION
                                  - WINDSTORM
                                  - HAIL
                                  - SMOKE
                                  - AIRCRAFT
                                  - VEHICLES
                                  - RIOT
                                  - CIVIL_COMMOTION
                                  - VANDALISM
                                  - SPRINKLER_LEAKAGE
                                  - SINKHOLE_COLLAPSE
                                  - VOLCANIC_ACTIVITY
                                  - BURGLARY_BREAK_IN
                                  - FALLING_OBJECTS
                                  - WEIGHT_OF_ICE
                                  - SNOW
                                  - SLEET
                                  - WATER_DAMAGE
                                  - COLLAPSE
                                  - ORDINANCE_OF_LAW
                                  - EARTHQUAKE
                                  - FLOOD
                                  - POWER_FAILURE
                                  - NEGLECT
                                  - WAR
                                  - NUCLEAR_HAZARD
                                  - INTENTIONAL_ACTS
                            premium_amount:
                              type: object
                              description: Premium amount for coverage
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                  - title: Renters
                    type: object
                    description: Rent coverage details
                    properties:
                      property_info:
                        type: object
                        description: Details of insured property
                        properties:
                          name:
                            type: string
                            description: Name of the property
                          address:
                            type: object
                            description: Address of the property
                            properties:
                              addr1:
                                type: string
                                description: Address Line 1
                              addr2:
                                type: string
                                description: Address Line 2
                              city:
                                type: string
                                description: City
                              state:
                                type: string
                                description: State
                              zipcode:
                                type: string
                                description: Zipcode
                              country:
                                type: object
                                description: Country details
                                properties:
                                  name:
                                    type: string
                                    description: Country name
                                  a2_code:
                                    type: string
                                    description: Alpha-2 code of country
                          interested_parties:
                            type: array
                            description: List of interested parties in the property
                            items:
                              properties:
                                name:
                                  type: string
                                  description: Name of the interested party
                                type:
                                  type: string
                                  description: Type of the interested party.
                                  enum:
                                    - FIRST_MORTGAGEE
                                    - SECOND_MORTGAGEE
                                    - THIRD_MORTGAGEE
                                    - SERVICING_AGENT
                                    - LIEN_HOLDER
                                    - LOSS_PAYEE
                                    - CONTRACTOR
                                    - HOMEOWNERS_ASSOCIATION
                                    - NAMED_ADDITIONAL_INSURED
                                    - LESSOR
                                    - OTHER
                                address:
                                  type: object
                                  description: Address of the interested party
                                  properties:
                                    addr1:
                                      type: string
                                      description: Address Line 1
                                    addr2:
                                      type: string
                                      description: Address Line 2
                                    city:
                                      type: string
                                      description: City
                                    state:
                                      type: string
                                      description: State
                                    zipcode:
                                      type: string
                                      description: Zipcode
                                    country:
                                      type: object
                                      description: Country details
                                      properties:
                                        name:
                                          type: string
                                          description: Country name
                                        a2_code:
                                          type: string
                                          description: Alpha-2 code of country
                                phone_number:
                                  type: string
                                  description: Phone number of the interested party
                                loan_number:
                                  type: string
                                  description: Loan number
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item
                            type:
                              type: string
                              description: Type of the coverage items.
                              enum:
                                - DWELLING
                                - PERSONAL_PROPERTY
                                - BUILDING_ADDITIONS_ALTERATIONS
                                - BUILDING_ORDINANCE
                                - LOSS_ASSESSMENT
                                - PERSONAL_LIABILITY
                                - ADDITIONAL_PREMISES_LIABILITY_EXTENSION
                                - MEDICAL_PAYMENTS
                                - WORKERS_COMPENSATION
                                - REPLACEMENT_COST_CONTENTS
                                - HOME_COMPUTERS
                                - SEWER_DRAINS
                                - JEWELRY
                                - EARTHQUAKE
                                - BUSINESS_PROPERTY
                                - LOSS_OF_USE
                                - ALL_PERILS
                                - NAMED_PERILS
                                - ALL_OTHER_PERILS
                                - OTHER
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: X12 standard code of the coverage item.
                                  enum:
                                    - Dwell
                                    - PP
                                    - BAA
                                    - BOLAW
                                    - LAC
                                    - PPTC
                                    - ADDRL
                                    - MEDPM
                                    - WCFIN
                                    - RCC
                                    - PC
                                    - SEWER
                                    - UNJWP
                                    - ERQK
                                    - BUSPR
                                    - LUSE
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            perils:
                              type: array
                              description: Named perils present on the policy
                              items:
                                type: string
                                description: Named perils present on the policy
                                enum:
                                  - FIRE
                                  - LIGHTNING
                                  - EXPLOSION
                                  - WINDSTORM
                                  - HAIL
                                  - SMOKE
                                  - AIRCRAFT
                                  - VEHICLES
                                  - RIOT
                                  - CIVIL_COMMOTION
                                  - VANDALISM
                                  - SPRINKLER_LEAKAGE
                                  - SINKHOLE_COLLAPSE
                                  - VOLCANIC_ACTIVITY
                                  - BURGLARY_BREAK_IN
                                  - FALLING_OBJECTS
                                  - WEIGHT_OF_ICE
                                  - SNOW
                                  - SLEET
                                  - WATER_DAMAGE
                                  - COLLAPSE
                                  - ORDINANCE_OF_LAW
                                  - EARTHQUAKE
                                  - FLOOD
                                  - POWER_FAILURE
                                  - NEGLECT
                                  - WAR
                                  - NUCLEAR_HAZARD
                                  - INTENTIONAL_ACTS
                            premium_amount:
                              type: object
                              description: Premium amount for coverage
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
                  - title: Personal Umbrella
                    type: object
                    description: Personal umbrella coverage details
                    properties:
                      coverage_items:
                        type: array
                        description: List of coverage items
                        items:
                          properties:
                            name:
                              type: string
                              description: Name of the coverage item.
                            type:
                              type: string
                              description: >-
                                Type of the coverage items. e.g.
                                `PERSONAL_UMBRELLA`
                            x12_info:
                              type: object
                              description: X12 standard details of coverage item
                              properties:
                                code:
                                  type: string
                                  description: >-
                                    X12 standard code of the coverage item. e.g.
                                    `PLC`
                                desc:
                                  type: string
                                  description: X12 standard description of coverage item
                            premium_amount:
                              type: object
                              description: Premium amount for coverage
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency of premium amount. e.g. `USD`,
                                    `CAD`
                                amount:
                                  type: number
                                  description: Premium amount
                            limits:
                              type: array
                              description: Details of limits applies to the coverage item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of limit.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Limit detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the limit
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Limit description
                            deductibles:
                              type: array
                              description: >-
                                Details of deductibles applies to the coverage
                                item
                              items:
                                properties:
                                  type:
                                    type: string
                                    description: Type of Deductible.
                                    enum:
                                      - TEXT
                                      - AMOUNT
                                      - PER_PERSON
                                      - PER_ENDORSEMENT
                                      - PER_POLICY
                                      - PER_ACCIDENT
                                      - PER_DAY
                                      - MAXIMUM
                                      - REASONABLE_EXPENSE
                                      - PER_OCCURRENCE
                                      - PER_DISABLEMENT
                                      - AGGREGATE
                                  value:
                                    description: Deductible detail
                                    oneOf:
                                      - title: Amount
                                        type: object
                                        properties:
                                          amount:
                                            type: number
                                            description: Amount of the deductible
                                          currency:
                                            type: string
                                            description: >-
                                              Currency of the amount. e.g. `USD`,
                                              `CAD`
                                      - title: Descriptive
                                        type: string
                                        description: Deductible description
        reference_items:
          type: array
          description: Array of item ids used for determining the insurance details.
          items:
            type: string
            example: itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the insurance details.
            Helps developer understand how has the insurance details been
            derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  insurance details been derived.
    InsuranceStatus:
      title: Insurance Details
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: MeasureOne datasource identifier
            type:
              type: string
              description: Type of datasource
            name:
              type: string
              description: Name of datasource
        as_of_date:
          type: number
          description: timestamp when this record was generated
        policy_number:
          type: string
          description: Policy number
        status:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
            - PENDING_ACTIVATION
            - PENDING_CANCELLATION
            - PENDING_EXPIRATION
            - CANCELLED
            - UNVERIFIED
            - RESCINDED
            - NOT_AVAILABLE
          description: Policy status
        coverage_period:
          type: object
          description: Insurance coverage period
          properties:
            start_date:
              type: string
              description: Start date timestamp of policy coverage
            end_date:
              type: string
              description: End date timestamp of policy coverage
        policy_holders:
          type: array
          description: List of policy holders
          items:
            properties:
              name:
                type: string
                description: Name of the policy holder
              phone_number:
                type: string
                description: Phone number of the policy holder
              address:
                type: object
                description: Address of the policy holder
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
        insurance_provider:
          type: object
          description: Details of insurance provider
          properties:
            name:
              type: string
              description: Name of the insurance provider
            phone_number:
              type: string
              description: Phone number of the insurance provider
            address:
              type: object
              description: Address of the insurance holder
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        policy_types:
          type: array
          items:
            type: string
            enum:
              - AUTO
              - HOME
              - RENTERS
              - PERSONAL_UMBRELLA
          description: Type of Policy
        reference_items:
          type: array
          description: Array of item ids used for determining the insurance details.
          items:
            type: string
            example: itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
        reason_codes:
          type: array
          description: >-
            Array of reason codes used for determining the insurance details.
            Helps developer understand how has the insurance details been
            derived.
          items:
            properties:
              code:
                type: string
                description: Reason code applicable
              description:
                type: string
                description: >-
                  Description providing details to understand how has the
                  insurance details been derived.
    BrokerageIndividualParent:
      title: individual
      type: object
      description: >-
        Service APIs calls with datarequest_id and individual are asynchronous
        in nature. You can initiate a service by calling service API with
        datarequest_id and individual. Call Service APIs with transaction_id to
        get the results.
      properties:
        individual:
          type: object
          description: Individual Details
          required:
            - individual_id
          properties:
            individual_id:
              type: string
              description: Unique ID of the Individual identified by MeasureOne
            datasources:
              type: array
              items:
                type: string
              description: >-
                List of data sources for which the data needs to be retrieved.
                If the list is empty, the data will be retrieved for all the
                data sources
            account_numbers:
              type: array
              items:
                type: string
              description: >-
                List of account numbers for which the data needs to be
                retrieved. If the list is empty, the data will be retrieved for
                all the available accounts
            tax_years:
              type: array
              items:
                type: string
              description: >-
                List of tax years for which the data needs to be retrieved. If
                the list is empty, the data will be retrieved for all the
                available tax years
        metadata:
          type: object
          description: >-
            metadata can be used for storing additional information in a
            structured format. metadata will be sent in webhooks and report
            response.
    RealizedGains:
      title: Realized Gains
      type: object
      properties:
        datasource:
          type: object
          description: Datasource details
          properties:
            id:
              type: string
              description: Unique ID of the datasource identified by MeasureOne
            type:
              type: string
              description: Type of the datasource
            name:
              type: string
              description: Name of datasource
        as_of_date:
          type: number
          description: timestamp when this record was generated
        account_number:
          type: string
          description: Account Number as presented on the datasource
        recipient:
          type: object
          description: Details of the recipient
          properties:
            name:
              type: string
              description: Name of the recipient
            phone_number:
              type: string
              description: Phone number of the recipient
            tin:
              type: string
              description: Tax identification number of the recipient
            address:
              type: object
              description: Address of the recipient
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        payer:
          type: object
          description: Details of the payer
          properties:
            tin:
              type: string
              description: Tax identification number of the payer
            name:
              type: string
              description: Name of the payer
            phone_number:
              type: string
              description: Phone number of the payer
            address:
              type: object
              description: Address of the payer
              properties:
                addr1:
                  type: string
                  description: Address Line 1
                addr2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  description: City
                state:
                  type: string
                  description: State
                zipcode:
                  type: string
                  description: Zipcode
                country:
                  type: object
                  description: Country details
                  properties:
                    name:
                      type: string
                      description: Country name
                    a2_code:
                      type: string
                      description: Alpha-2 code of country
        fatca_filing_requirement:
          type: boolean
          description: Used to show FATCA filing requirement value
        transactions:
          type: array
          description: List of transactions
          items:
            properties:
              gain_type:
                type: string
                enum:
                  - SHORT_TERM
                  - LONG_TERM
                description: Type of the gain
              quantity_sold:
                type: number
                description: Quantity sold
              asset_details:
                type: object
                description: Details of the asset
                properties:
                  type:
                    type: string
                    enum:
                      - SECURITY
                      - CRYPTO
                      - REAL_ESTATE
                      - OTHER
                    description: Type of asset
                  description:
                    type: string
                    description: Description of property
                  cusip:
                    type: string
                    description: CUSIP number
                  ticker:
                    type: string
                    description: Ticker
              acquired_date:
                type: number
                description: Date acquired
              sell_date:
                type: number
                description: Date sold or disposed
              proceeds:
                type: object
                description: Proceeds
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - CAN
                      - INR
                    description: Currency of the proceed
                  value:
                    type: number
                    description: value of the proceed
              cost:
                type: object
                description: Cost or other Basis
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - CAN
                      - INR
                    description: Currency of the cost
                  value:
                    type: number
                    description: Value of cost or basis
              accrued_market_discount:
                type: object
                description: Accrued Market Discount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - CAN
                      - INR
                    description: Currency of accrued market discount
                  value:
                    type: number
                    description: Value
              wash_sale_disallowed:
                type: object
                description: Wash Sale disallowed amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - CAN
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: Wash Sale Loss Disallowed Value
              gain:
                type: object
                description: gain Amount
                properties:
                  currency:
                    type: string
                    enum:
                      - USD
                      - CAN
                      - INR
                    description: Currency
                  value:
                    type: number
                    description: gain Amount
              additional_information:
                type: string
                description: Additional Information
              proceed_type:
                type: string
                enum:
                  - GROSS
                  - NET
              basis_reported_to_irs:
                type: boolean
                description: Basis Reported to the IRS
              non_covered_security:
                type: boolean
                description: Covered/Non-covered Security (Box 5)
        totals:
          type: object
          description: Realized gain totals
          properties:
            short_term_gains:
              type: object
              description: Total short term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
            long_term_gains:
              type: object
              description: Total long term realized gains
              properties:
                proceeds:
                  type: object
                  description: Proceeds
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Proceeds Value
                cost:
                  type: object
                  description: Cost basis
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Cost basis value
                accrued_market_discount:
                  type: object
                  description: Accrued Market Discount
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Accrued Market Discount Value
                wash_sale_disallowed:
                  type: object
                  description: Wash Sale Loss Disallowed
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: Wash Sale Loss Disallowed Value
                gain:
                  type: object
                  description: Realized gain
                  properties:
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAN
                        - INR
                      description: Currency
                    value:
                      type: number
                      description: >-
                        Realized gain value. The number will be negative incase
                        if loss
    EmptyBody:
      title: EmptyBody
      type: object
    Token:
      title: Access Token
      type: object
      properties:
        access_token:
          type: string
          description: Access token generated for you to access MeasureOne API
          example: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
        token_type:
          type: string
          description: Type of access token. This value is always `bearer`
          example: bearer
        expires_in:
          type: number
          description: Seconds left to expire
          example: 899
        expires_at:
          type: number
          description: Timestamp in milliseconds at which access token will expire
          example: 1681191048000
    DataDeletionToken:
      title: Data Deletion Token
      type: object
      properties:
        access_token:
          type: string
          description: >-
            Data deletion token generated for you to access MeasureOne delete
            API
          example: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
        token_type:
          type: string
          description: Type of data access token. This value is always `bearer`
          example: bearer
        expires_in:
          type: number
          description: Seconds left to expire
          example: 899
        expires_at:
          type: number
          description: Timestamp in milliseconds at which access token will expire
          example: 1681191048000
    AddVehicleAction:
      title: Add Vehicle
      type: object
      description: Add vehicle in auto insurance policy
      required:
        - add_vehicles
      properties:
        policy_number:
          description: Policy number for which details need to be edited
          type: string
        add_vehicles:
          type: array
          description: Vehicles that need to be added to the auto insurance policy
          items:
            required:
              - type
              - vin
              - ownership_type
              - first_owner
              - registered_owner_name
              - registered_state
              - is_customized
              - primary_usage
              - estimated_annual_mileage
              - safety_restraint_device
              - anti_theft_device
              - transaction_date
              - parked_address
              - ownership
            properties:
              type:
                type: string
                description: Type of vehicle
                enum:
                  - PRIVATE_PASSENGER
              vin:
                type: string
                description: Vehicle Identification Number
              ownership_type:
                type: string
                description: Ownership type of the vehicle
                enum:
                  - SELF_OR_SPOUSE
                  - CO_OWNED
                  - FINANCED
                  - LEASED
              first_owner:
                type: boolean
                description: Indicates whether owner is first owner of the vehicle
              registered_owner_name:
                type: string
                description: Name of registered owner of vehicle
              registered_co_owner_name:
                type: string
                description: Name of registered co-owner of vehicle
              registered_state:
                type: string
                description: 2-letter state code where vehicle is registered
                enum:
                  - AL
                  - AK
                  - AZ
                  - AR
                  - AS
                  - CA
                  - CO
                  - CT
                  - DE
                  - DC
                  - FM
                  - FL
                  - GA
                  - GU
                  - HI
                  - ID
                  - IL
                  - IN
                  - IA
                  - KS
                  - KY
                  - LA
                  - ME
                  - MH
                  - MD
                  - MA
                  - MI
                  - MN
                  - MS
                  - MO
                  - MT
                  - NE
                  - NV
                  - NH
                  - NJ
                  - NM
                  - NY
                  - NC
                  - ND
                  - MP
                  - OH
                  - OK
                  - OR
                  - PW
                  - PA
                  - PR
                  - RI
                  - SC
                  - SD
                  - TN
                  - TX
                  - UT
                  - VT
                  - VA
                  - VI
                  - WA
                  - WV
                  - WI
                  - WY
              is_customized:
                type: boolean
                description: Indicates whether vehicle has any customization
              primary_usage:
                type: string
                description: Primary use of the vehicle
                enum:
                  - COMMUTE
                  - SCHOOL
                  - PERSONAL
              days_driven_per_week:
                type: number
                description: Number of days the Insured drives the vehicle per week.
              miles_driven_each_way:
                type: number
                description: No. of miles the Insured drives each way.
              estimated_annual_mileage:
                type: number
                description: Estimated annual mileage of vehicle
              safety_restraint_device:
                type: string
                description: Safety restraint device details of vehicle
                enum:
                  - NO_RESTRAIN
                  - AUTOMATIC_SEAT_BELTS
                  - DRIVER_SIDE_AIR_BAG
                  - FULL_FRONT_AIR_BAG
              anti_theft_device:
                type: string
                description: Anti-theft device details of vehicle
                enum:
                  - UNKNOWN
                  - NONE
                  - ALARM_ONLY_AND_ACTIVE_DISABLING
                  - VRS
                  - VRS_AND_ALARM_OR_ACTIVE_DISABLING
                  - VRS_AND_PASSIVE_DISABLING
                  - PASSIVE_DISABLING
              transaction_date:
                type: string
                format: MM/DD/YYYY
                description: Vehicle purchase or lease date
              parked_address:
                type: object
                description: Address where vehicle will be parked
                required:
                  - addr1
                  - city
                  - state
                  - zipcode
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
              replace_vehicle:
                type: object
                description: Vehicle that need to be replaced in the auto insurance policy
                required:
                  - vin
                  - reason
                properties:
                  vin:
                    type: string
                    description: Vehicle Identification Number
                  make:
                    type: string
                    description: Make of the vehicle
                  model:
                    type: string
                    description: Model of the vehicle
                  year:
                    type: integer
                    description: Year when the vehicle was manufactured
                  reason:
                    type: string
                    description: Reason for replacing the vehicle
                    enum:
                      - SOLD
                      - EXCHANGE
                      - LOST
                      - LEASED_VEHICLE_TURNED_IN
        add_interested_parties:
          type: array
          description: >-
            Interested parties that need to be added to the auto insurance
            policy
          items:
            required:
              - vin
              - name
              - address
              - type
            properties:
              vin:
                type: string
                description: Vehicle Identification Number
              name:
                type: string
                description: Interested party name
              address:
                type: object
                description: Interested party address
                required:
                  - addr1
                  - city
                  - state
                  - zipcode
                properties:
                  addr1:
                    type: string
                    description: Address Line 1
                  addr2:
                    type: string
                    description: Address Line 2
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  zipcode:
                    type: string
                    description: Zipcode
                  country:
                    type: object
                    description: Country details
                    properties:
                      name:
                        type: string
                        description: Country name
                      a2_code:
                        type: string
                        description: Alpha-2 code of country
              type:
                type: string
                enum:
                  - LIEN_HOLDER
                  - SERVICING_AGENT
                  - LOSS_PAYEE
                  - CONTRACTOR
                  - NAMED_ADDITIONAL_INSURED
                  - OTHER
              loan_lease_start_date:
                type: string
                format: MM/DD/YYYY
                description: Loan or Lease start date
              loan_lease_duration:
                type: number
                description: Loan or Lease duration in months
    datarequest_manual_upload_source_data_type:
      title: source_data_type
      type: object
      required:
        - source_data_type
      properties:
        source_data_type:
          type: string
          description: The type of the source_data
          enum:
            - TRANSCRIPT_FILE
            - PAYSTUB_FILE
            - AUTO_INSURANCE_POLICY
            - HOME_INSURANCE_POLICY
            - RENTERS_INSURANCE_POLICY
            - INSURANCE_CARD
            - PROCEEDS_1099_B
            - TWN_EDR
            - W2_FILE
            - STUDENT_ID_CARD
            - FORM_1099_MISC
            - FORM_1099_NEC
            - FORM_1099_B
            - FORM_1099_CONSOLIDATED
            - FORM_1099_INT
            - FORM_1099_DIV
            - FORM_1099_OID
            - FORM_1098
        min_count:
          type: integer
          description: Minimum documents required
          default: 1
        max_count:
          type: integer
          description: Maximum documents required
          default: 1
    link:
      title: Item Object
      type: object
      properties:
        id:
          description: Unique ID of the invitation link identified by MeasureOne
          type: string
          readOnly: true
        uri:
          type: string
          format: scheme:[//authority]/path
          description: URI of the invitation link generated by MeasureOne
          readOnly: true
        expires_at:
          description: >-
            UTC Timestamp at which the invitation link  expires. Upon
            expiration, the status will be `EXPIRED`
          type: number
          readOnly: true
        email_notification:
          type: boolean
          description: >-
            Boolean indicating whether invitation email was sent for the Data
            Request
          readOnly: true
        sms_notification:
          type: boolean
          description: >-
            Boolean indicating whether invitation SMS was sent for the Data
            Request
          readOnly: true
        status:
          description: Status of the invitation link
          type: string
          enum:
            - ACTIVE
            - USED
            - EXPIRED
          readOnly: true
        expiry_reason:
          type: object
          properties:
            code:
              type: string
              description: Reason code for expiration
              enum:
                - NO_MATCH_FOUND
                - INSUFFICIENT_CREDENTIALS
                - LINK_TIMEOUT
                - DATA_NOT_AVAILABLE
                - EXPIRATION_REQUESTED
            description:
              type: string
              description: |
                Reason details for expiration.
                Reason code:
                  * **NO_MATCH_FOUND** - When the Individual is unable to find their Datasource
                  * **INSUFFICIENT_CREDENTIALS** - When the Individual indicates that they do not have valid credentials to complete the Data Request
                  * **LINK_TIMEOUT** - When the invitation link times out and reaches its expiration
                  * **DATA_NOT_AVAILABLE** - When the Individual was able to connect successfully but MeasureOne could not find any data
                  * **EXPIRATION_REQUESTED** - When the expiration of the invitation link is explicitly requested by calling `/expire_link` API.
              maxLength: 127
          description: Reason for expiring the invitation link
        created_at:
          description: Timestamp at which the invitation link was created
          type: number
          readOnly: true
        updated_at:
          description: Timestamp at which the invitation link was updated
          type: number
          readOnly: true
    Updated:
      title: DataRequestUpdated
      type: object
      description: >-
        The attributes in the details object of this event will vary depending
        on the attributes passed in datarequest update request.
      properties:
        autorun_services:
          type: boolean
          description: Whether the services were set to Auto-run
        third_party_requester:
          type: string
          description: >-
            Optional name of the requester on behalf of which you are raising
            this Data Request. This is reflected in all communications to the
            Individual
    LinkGenerated:
      title: LinkGenerated
      type: object
      properties:
        uri:
          type: string
          description: URI of the invitation link generated by MeasureOne
        expires_at:
          type: number
          description: Timestamp at which the invitation link expires
    NotifyUser:
      title: NotifyUser
      type: object
      properties:
        email_notification:
          type: string
          description: Whether send email to user
        sms_notification:
          type: string
          description: Whether send sms send to user
        additional_message:
          type: string
          maxLength: 1000
          description: >-
            Additional message that you may want to pass to the Individual in
            the invitation email
    LinkExtended:
      title: LinkExtended
      type: object
      properties:
        expires_at:
          type: string
          description: >-
            Timestamp in milliseconds when you want to expire the Data Request
            invitation link
    LinkExpired:
      title: LinkExpired
      type: object
      properties:
        code:
          type: string
          description: Reason code for expiration
        description:
          type: string
          description: Reason details for expiration
    LinkAccessed:
      title: LinkAccessed
      type: object
      properties:
        uri:
          type: string
          description: URI of the invitation link accessed by user
    DatasourceClassified:
      title: DatasourceClassified
      type: object
      properties:
        datasource_id:
          type: string
          description: Unique ID of the datasource identified by MeasureOne
    LoginAttempted:
      title: LoginAttempted
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    InvalidCredentials:
      title: InvalidCredentials
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    DatasourceConnected:
      title: DatasourceConnected
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    ItemCreated:
      title: ItemCreated
      type: object
      properties:
        item_id:
          type: string
          description: Unique ID of the Item identified by MeasureOne
    ItemProcessed:
      title: ItemProcessed
      type: object
      properties:
        item_id:
          type: string
          description: Unique ID of the Item identified by MeasureOne
    ItemUnprocessable:
      title: ItemUnprocessable
      type: object
      properties:
        item_id:
          type: string
          description: Unique ID of the Item identified by MeasureOne
    ExtractionComplete:
      title: ExtractionComplete
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    ExtractionIncomplete:
      title: ExtractionIncomplete
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    UserInterventionRequired:
      title: UserInterventionRequired
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    ReportRequested:
      title: ReportRequested
      type: object
      properties:
        transaction_id:
          type: string
          description: Unique ID of the Transaction identified by MeasureOne
    ReportCompleted:
      title: ReportCompleted
      type: object
      properties:
        transaction_id:
          type: string
          description: Unique ID of the Transaction identified by MeasureOne
    ReportError:
      title: ReportError
      type: object
      properties:
        transaction_id:
          type: string
          description: Unique ID of the Transaction identified by MeasureOne
    refreshInitiated:
      title: RefreshInitiated
      type: object
      properties:
        refresh_id:
          type: string
          description: Unique ID of a scheduled refresh identified by MeasureOne
    refreshFailed:
      title: RefreshFailed
      type: object
      properties:
        refresh_id:
          type: string
          description: Unique ID of a scheduled refresh identified by MeasureOne
    consentUpdated:
      title: ConsentUpdated
      type: object
      properties:
        id:
          type: string
          description: Unique ID of consent
          examples:
            - cs_wf325dgfhhj
        description:
          description: Description of consent
          type: string
        accepted:
          description: >-
            Boolean value indicating whether individual has given accepted the
            consent
          type: boolean
          examples:
            - true
        recorded_at:
          type: integer
          description: Timestamp at which user has given accepted the consent
          examples:
            - 1696675463535
    SessionLoggedOut:
      title: SessionLoggedOut
      type: object
      properties:
        session_id:
          type: string
          description: Unique ID of the Session identified by MeasureOne
    StaticDataRequest:
      title: Pre-configured
      type: object
      description: >
        <br/><br/>

        This approach is useful when you want to use standard reports made
        available by MeasureOne. The table below depicts the documents and the
        reports MeasureOne creates for the type of DataRequest created.


        | Type | Documents | Service API & Report |

        |--- |----------- |-- |

        | ACADEMIC_SUMMARY | Education related documents including Student
        Transcripts, Grade Reports, Degree Audit Reports & Student Profile |
        get_academic_summary

        | ENROLLMENT_STATUS | Enrollment related documents including Student
        Transcripts, Grade Reports, Degree Audit Reports & Student Profile |
        get_enrollment_status

        | INCOME_EMPLOYMENT_DETAILS | Income and Employment related documents
        such as Paystubs, Employee Profile  | get_income_employment_details

        | EMPLOYMENT_SUMMARY | Employment related documents such as Paystubs &
        Employee Profile | get_employment_summary

        | INCOME_SUMMARY | Income related documents including Paystubs &
        Employee Profile | get_income_summary

        | HOME_INSURANCE_DETAILS | Current & Historic Home Insurance Policies  |
        get_insurance_details

        | AUTO_INSURANCE_DETAILS | Current & Historic Auto Insurance Policies |
        get_insurance_details

        | RENTERS_INSURANCE_DETAILS | Current & Historic Renters Insurance
        Policies | get_insurance_details

        | REALIZED_GAINS | 1099_B Composite form | get_realized_gains


        <br/><br/>
      required:
        - individual_id
        - type
      properties:
        id:
          type: string
          description: Unique ID of the Data Request identified by MeasureOne
          readOnly: true
        individual_id:
          type: string
          description: Unique ID of the Individual identified by MeasureOne
          example: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
        type:
          type: string
          description: Type of the datarequest
          enum:
            - ACADEMIC_SUMMARY
            - ENROLLMENT_STATUS
            - EMPLOYMENT_SUMMARY
            - INCOME_SUMMARY
            - HOME_INSURANCE_DETAILS
            - AUTO_INSURANCE_DETAILS
            - RENTERS_INSURANCE_DETAILS
            - INCOME_EMPLOYMENT_DETAILS
            - REALIZED_GAINS
        actions:
          type: array
          readOnly: true
          description: >-
            List of actions need to be performed for Data Request. Actions can
            be used to add vehicle.
          items:
            required:
              - type
            properties:
              type:
                type: string
                description: >-
                  Type of action. Type 'GET' will be populated as default when
                  `source_data_types` is provided.
                enum:
                  - ADD_VEHICLE
                x-enumDescriptions:
                  ADD_VEHICLE: >-
                    Use this action to add Vehicle to existing auto insurance
                    policy
              details:
                type: object
                description: Action details. Mandatory for `ADD_VEHICLE` action type.
                $ref: '#/components/schemas/AddVehicleAction'
        source_data_types:
          type: object
          readOnly: true
          description: Details of source data types you need to complete this request.
          properties:
            direct_connections:
              type: array
              description: >-
                List of source data types you need from direct online account
                connection. This field is required when
                `enable_direct_connection` is true.
              items:
                type: string
                enum:
                  - EMPLOYMENT
                  - INCOME
                  - AUTO_INSURANCE
                  - HOME_INSURANCE
                  - RENTERS_INSURANCE
                  - EDUCATION
                  - PROCEEDS_1099_B
                  - TRANSCRIPT_FILE
                  - PAYSTUB_FILE
                  - AUTO_INSURANCE_POLICY
                  - HOME_INSURANCE_POLICY
                  - RENTERS_INSURANCE_POLICY
                  - INSURANCE_CARD
                  - TWN_EDR
                  - W2_FILE
                  - STUDENT_ID_CARD
                  - UNINSURED_MOTORIST_FORM
                  - AUTO_INSURANCE_CLAIM
                  - POLICY_DETAILS
                  - POLICY_LISTING
                  - VEHICLE_LISTING
                  - VEHICLE_DETAILS
                  - FORM_1099_B
                  - FORM_1099_CONSOLIDATED
                  - FORM_1099_INT
                  - FORM_1099_DIV
                  - FORM_1099_OID
                  - FORM_1099_MISC
                  - FORM_1099_NEC
                  - FORM_1098
                  - UNINSURED_MOTORIST_FORM
                  - AUTO_INSURANCE_CLAIM
            manual_uploads:
              description: >
                Configuration for the source_data_types you want to allow for
                the user to upload. 

                You can use JSON query operators to define the acceptable
                conditions for the user to upload the document.

                The currently supported operators are: '`and` and `or`'. This
                field is required when `enable_manual_upload` is true.


                Below are the examples that you can configure for manual upload

                - Allow user to upload only one type of document

                - Allow user to upload any one of the document type

                - Allow user to upload all of the document type          


                Example: Prompt the user to upload only one type of document

                ```

                {
                  "source_data_type": "PAYSTUB_FILE",
                  "min_count": 2,
                  "max_count": 2
                }

                ```


                Example: Prompt the user to upload any one of the document types
                with different quantities

                ```

                {
                  "$or": [{
                          "source_data_type": "PAYSTUB_FILE",
                          "min_count": 1,
                          "max_count": 3
                      },
                      {
                          "source_data_type": "W2_FILE",
                          "min_count": 1,
                          "max_count": 1
                      }]
                }  

                ```


                Example: Prompt the user to upload all of the document types
                with different quantities

                ```

                {
                  "$and": [{
                          "source_data_type": "PAYSTUB_FILE",
                          "min_count": 1,
                          "max_count": 3
                      },
                      {
                          "source_data_type": "W2_FILE",
                          "min_count": 1,
                          "max_count": 1
                      }]
                }          

                ```
              oneOf:
                - title: or
                  type: object
                  description: OR operator for specifying the conditions for manual upload
                  properties:
                    $or:
                      type: array
                      description: Required any one to complete this request
                      items:
                        anyOf:
                          - title: and
                            type: object
                            description: Required all to complete this request
                            properties:
                              $and:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - title: or
                            type: object
                            description: Required all to complete this request
                            properties:
                              $or:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - $ref: >-
                              #/components/schemas/datarequest_manual_upload_source_data_type
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
                - title: and
                  type: object
                  description: OR operator for specifying the conditions for manual upload
                  properties:
                    $and:
                      type: array
                      items:
                        anyOf:
                          - title: and
                            type: object
                            description: Required all to complete this request
                            properties:
                              $and:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - title: or
                            type: object
                            description: Required all to complete this request
                            properties:
                              $or:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - $ref: >-
                              #/components/schemas/datarequest_manual_upload_source_data_type
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
                - title: source_data_type
                  description: The source_data_type for manual upload
                  properties:
                    source_data_type:
                      type: string
                      description: The type of the source_data
                      enum:
                        - TRANSCRIPT_FILE
                        - PAYSTUB_FILE
                        - AUTO_INSURANCE_POLICY
                        - HOME_INSURANCE_POLICY
                        - RENTERS_INSURANCE_POLICY
                        - INSURANCE_CARD
                        - PROCEEDS_1099_B
                        - TWN_EDR
                        - W2_FILE
                        - STUDENT_ID_CARD
                        - FORM_1099_B
                        - FORM_1099_CONSOLIDATED
                        - FORM_1099_INT
                        - FORM_1099_DIV
                        - FORM_1099_OID
                        - FORM_1098
                    min_count:
                      type: integer
                      description: Minimum documents required
                      default: 1
                    max_count:
                      type: integer
                      description: Maximum documents required
                      default: 1
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
        experience_id:
          readOnly: true
          description: Experience Id of the LINK experience
          type: string
        created_at:
          description: Timestamp at which the request was created
          type: number
          readOnly: true
        updated_at:
          description: Timestamp at which the request was last updated
          type: number
          readOnly: true
        third_party_requester:
          type: string
          maxLength: 1023
          default: null
          description: >-
            Optional name of the requester on behalf of which you are raising
            this Data Request. This is reflected in all communications to the
            Individual
        requester_name:
          type: string
          maxLength: 1023
          description: >-
            Your display name. This is reflected in all communications to the
            Individual. If not provided, the system will take your application
            display name set in your account preferences.
        requester_logo_url:
          type: string
          description: >-
            URL of the requester logo to be displayed for the widget. If none
            provided then customer default logo will be used for the widget.
        requester_logo_uri:
          type: string
          description: >-
            URI for the logo to be displayed for the widget. If not provided it
            will be taken from the account preferences.
        processing_config:
          type: object
          description: |
            Processing configuration for this request. 
          properties:
            max_latency:
              type: integer
              default: -1
              description: >
                The maximum allowable processing time (in seconds) to complete
                the request. The processing timer starts at the time the
                datasource connection is established or in the case of manual
                upload after all request documents have been submitted. A value
                of `-1` (default) means no maximum allowable processing time. 


                If the processing time exceeds the max_latency, the request will
                be terminated and a session.terminated webhook will be
                triggered. Subscribe to the <a
                href="#tag/webhooks/paths/session.terminated/post">session.terminated</a>
                to receive the webhook.
                                
        datasource:
          type: object
          description: >-
            Pre-identified Datasource details for the Individual to connect.
            Either the `id` or the `display_name` should be provided. If both
            are provided, the `display_name` will be ignored.
          properties:
            id:
              type: string
              description: >-
                Unique ID of the datasource identified by MeasureOne. When
                provided, the Individual will be directly prompted to provide
                their credentials for this Datasource.
            display_name:
              type: string
              maxLength: 127
              description: >-
                Name of the datasource for which you want the Individual to
                connect their account. The Individual will be guided to connect
                to the provided name.
            enable_override:
              type: boolean
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used.
              default: true
            connection_method:
              type: string
              readOnly: true
              enum:
                - DIRECT_CONNECTION
                - MANUAL_UPLOAD
              description: Connection method using which user has connected the account.
            last_connected_at:
              type: number
              readOnly: true
              description: Timestamp (milliseconds) at which last connection was attempted.
            last_connection_status:
              type: string
              readOnly: true
              enum:
                - NOT_CONNECTED
                - CONNECTED
              description: >-
                Status of last connection details. For details check
                `event_logs` section in response.
        enable_direct_connection:
          type: boolean
          description: >-
            Whether to enable direct connection for the Data Request. If none
            specified then customer default preference will be used.
        enable_manual_upload:
          type: boolean
          description: >-
            Whether to enable manual upload of document for the Data Request. If
            none specified then customer default preference will be used.
        show_connect_method_options:
          type: boolean
          description: >-
            When multiple connect options such as direct connection, manual
            upload, bank account connection are enabled for datarequest then
            user can be presented with all the options upfront in the widget. If
            none specified then customer default preference will be used.
        countries:
          type: array
          items:
            type: string
            enum:
              - US
              - CA
          description: >-
            Pre-identified country code. Providing a value will allow user to
            search the datasources only from selected country.
        request_details:
          type: object
          default: null
          description: >-
            Details of the data request that you can provide while creation.
            This helps in driving the the workflow and the end user experience
            on MeasureOne Link.
          properties:
            datasource:
              type: object
              deprecated: true
              description: >-
                Pre-identified Datasource details for the Individual to connect.
                Either the `id` or the `display_name` should be provided. If
                both are provided, the `display_name` will be ignored.
              properties:
                id:
                  type: string
                  description: >-
                    Unique ID of the datasource identified by MeasureOne. When
                    provided, the Individual will be directly prompted to
                    provide their credentials for this Datasource.
                display_name:
                  type: string
                  maxLength: 127
                  description: >-
                    Name of the datasource for which you want the Individual to
                    connect their account. The Individual will be guided to
                    connect to the provided name.
            countries:
              type: array
              deprecated: true
              items:
                type: string
                enum:
                  - US
                  - CA
              description: >-
                Pre-identified country code. Providing a value will allow user
                to search the datasources only from selected country.
            enable_manual_upload:
              type: boolean
              deprecated: true
              description: >-
                Whether to enable manual upload of document for the Data
                Request. If none specified then customer default preference will
                be used.
            enable_datasource_override:
              type: boolean
              deprecated: true
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used. `This attribute is deprecated.
                Refer to datasource.enable_override in the parent object
            show_connect_method_options:
              type: boolean
              deprecated: true
              description: >-
                When multiple connect options such as direct connection, manual
                upload, bank account connection are enabled for datarequest then
                user can be presented with all the options upfront in the
                widget. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            student_type:
              type: string
              description: >-
                Type of the student. **This attribute is used only when the
                request is being used for the purposes of Education
                Verification**
              enum:
                - CURRENT_STUDENT
                - ALUMNI
            employment_status:
              type: string
              description: >-
                Pre-identified employment status . **This attribute is used only
                when the request is being used for the purposes of Employment
                Verification**
              enum:
                - CURRENT
                - FORMER
            employment_type:
              type: string
              description: >-
                Type of the Employee.  **This attribute is used only when the
                request is being used for the purposes of Employment
                Verification**
              enum:
                - EMPLOYEE
                - GIG_WORKER
                - CONTRACTOR
            tax_year:
              type: number
              example: 1994
              description: >-
                An annual accounting year for tax calculation. e.g 2022. **This
                attribute is required only when the request is being used for
                the purposes of brokerage data request**
            earnings_period_type:
              type: string
              description: >-
                Earnings period type. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
              enum:
                - CURRENT
                - HISTORIC
            get_yearly_earnings:
              type: boolean
              description: >-
                Include yearly earnings CY + last 2 years in the VOIE/Income
                Summary report. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
            enable_bank_income:
              type: boolean
              description: >-
                Whether to enable bank account connect option for the Data
                Request. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            use_legacy_insurance:
              type: boolean
              default: false
              description: >-
                Flag to support legacy INSURANCE_POLICY source_data_type. **This
                attribute is used only when the request is being used for the
                purposes of Auto or Home Insurance Verification**
            institution_type:
              type: array
              items:
                type: string
              description: |
                Datasource categories for which you want to filter in M1Link.

                `COLLEGE`: To search for academic institutions<br>
                `EMPLOYER`: To search for employers<br>
                `PAYROLL_PROCESSOR`: To search for payroll providers<br>
                `HOMEINSURANCE`: To search for home insurance providers<br>
                `AUTOINSURANCE`: To search for auto insurance providers<br>
                `BROKERAGE_ACCOUNT`: To search for brokerage firms<br>
                `BANK_ACCOUNT`: To search for Banks<br>
        reports:
          type: array
          readOnly: true
          description: List of reports that are required for the Data Request
          items:
            type: object
            properties:
              uri:
                type: string
                description: The type of the report
                enum:
                  - m1_report://EMPLOYMENT_SUMMARY
                  - m1_report://INCOME_SUMMARY
                  - m1_report://INCOME_EMPLOYMENT_DETAILS
                  - m1_report://INSURANCE_DETAILS
                  - m1_report://INSURANCE_STATUS
                  - m1_report://ACADEMIC_SUMMARY
                  - m1_report://ENROLLMENT_STATUS
                  - m1_report://REALIZED_GAINS
              params:
                type: object
                description: >
                  Parameters for the report. Refer to the details of each report
                  in the [Services](#tag/Education) section
              metadata:
                type: object
                description: >-
                  metadata can be used for storing additional information in a
                  structured format. metadata will be sent in webhooks and
                  report response.
        delivery_details:
          type: array
          description: >-
            List of endpoints to which the [webhooks](#tag/webhooks) should be
            delivered
          items:
            required:
              - event_type
              - url
            properties:
              event_type:
                type: string
                description: >-
                  Event for which you want a notification. If not provided, it
                  will be taken from the default account preference. Refer to
                  Webhooks section to see the list of all events supported
                enum:
                  - datarequest.items_available
                  - datarequest.items_processed
                  - datarequest.no_items
                  - datarequest.report_available
                  - datarequest.report_error
                  - datarequest.acquisition_completed
                  - datarequest.updates_available
                  - datarequest.refresh_failed
                  - datasource.connected
                  - transaction.processed
                  - unprocessable.entity
                  - session.rejected
                  - session.terminated
                  - session.no_login
                  - item.created
                  - item.processed
                  - item.unavailable
              url:
                description: URL to which the webhook should be delivered
                type: string
                format: url
              headers:
                type: object
                description: >-
                  Additional http headers that you may want to pass. MeasureOne
                  will send the data with content-type as `application/json`
                example:
                  content-type: application/json
              x_auth_token_credentials:
                description: >-
                  MeasureOne will generate the authorization token with provided
                  auth token credentials and use the generated token while
                  delivering webhooks. `x_auth_token_credentials` details can be
                  provided when a fresh authorization token needs to be used
                  when MeasureOne delivers webhook.
                type: object
                required:
                  - token_type
                  - http_method
                  - url
                properties:
                  token_type:
                    type: string
                    description: Type of token
                    enum:
                      - JWT
                  http_method:
                    type: string
                    description: Type of HTTP method
                    enum:
                      - POST
                  url:
                    type: string
                    format: url
                    description: Endpoint url to generate auth token
                    examples:
                      - https://sampledomain.com/generate_token
                  key_id:
                    type: string
                    description: >-
                      Unique ID of the Encryption key identified by MeasureOne.
                      `x_auth_token_credentials` holds credentials details. So,
                      `authorization` header and `data` can be provided in
                      encrypted form. When `key_id` is provided then
                      `authorization` header and attributes value in `data`
                      object will be treated as encrypted. Please reach out to
                      us on support@mesureone.com to get your encryption key_id
                      setup.
                  headers:
                    type: object
                    description: >
                      Request body headers that you may want to pass while
                      calling endpoint.


                      MeasureOne supports two content-type `application/json`
                      and `application/x-www-form-urlencoded` for generate auth
                      token endpoint. An unspecified content-type will default
                      to `application/json`
                  data:
                    type: object
                    description: >-
                      Data that we need to pass in body while calling endpoint.
                      attribute's value can be pass in encrypted form when
                      `key_id` is provided.
                  response_token_path:
                    type: string
                    description: >-
                      Path from response for token attribute. When
                      `response_token_path` is unspecified then complete
                      response will be used as auth token.
                    examples:
                      - access_token.token
        refresh_policy:
          type: object
          description: Refresh Policy details to auto refresh data periodically
          properties:
            enabled:
              type: boolean
              description: >-
                Indicates whether auto-refresh is enabled for the Data Request.
                Set to `true` if wants to use auto-refresh for the Data Request.
                If `schedule` is provided then `enabled` should be `true`.
            schedule:
              oneOf:
                - title: Daily
                  type: object
                  required:
                    - frequency
                  description: |
                    Refresh schedule to auto refresh data daily

                    Example: refresh daily
                    ```
                    {
                      "frequency": "DAILY"
                    }
                    ``` 
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                - title: Weekly
                  type: object
                  required:
                    - frequency
                    - by_weekday
                  description: |
                    Refresh schedule to auto refresh data Weekly

                    Example: refresh every week on Monday
                    ```
                    {
                      "frequency": "WEEKLY",
                      "by_weekday": ["MO"]              
                    }
                    ``` 
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_weekday:
                      type: array
                      description: >
                        List of days of the week. `SU` indicates Sunday; `MO`
                        indicates Monday; `TU` indicates Tuesday; `WE` indicates
                        Wednesday; `TH` indicates Thursday; `FR` indicates
                        Friday; and `SA` indicates Saturday.
                      items:
                        type: string
                        enum:
                          - SU
                          - MO
                          - TU
                          - WE
                          - TH
                          - FR
                          - SA
                - title: Monthly
                  type: object
                  required:
                    - frequency
                    - by_monthday
                  description: |
                    Refresh schedule to auto refresh data Monthly

                    Example: refresh every month on 15th
                    ```
                    {
                      "frequency": "MONTHLY",
                      "by_monthday": [15]
                    }
                    ``` 
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_monthday:
                      type: array
                      description: |
                        List of days of the month. Valid values are 1 to 31
                      items:
                        type: number
            effective_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should start
            end_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should end
            last_refresh_at:
              type: number
              description: >-
                Timestamp (milliseconds) when the last refresh was executed for
                the datarequest
              readOnly: true
            next_refresh_at:
              type: number
              description: >-
                Timestamp (milliseconds) when the next refresh is scheduled for
                the datarequest
              readOnly: true
        consent:
          type: object
          description: Consent details for this datarequest
          readOnly: true
          properties:
            id:
              type: string
              description: Unique ID of consent
              examples:
                - cs_wf325dgfhhj
            description:
              description: Description of consent
              type: string
            recorded_at:
              type: integer
              description: Timestamp at which user has given accepted the consent
              examples:
                - 1696675463535
        invitation_links:
          type: array
          description: >-
            List of invitation links associated with datarequest. Only 1
            invitation link is active at any given time.
          readOnly: true
          items:
            $ref: '#/components/schemas/link'
        last_activity_type:
          type: string
          description: Last activity recorded for the Data Request
          enum:
            - CREATED
            - INVITATION_CREATED
            - AVAILABLE
            - COMPLETE
            - FAILED
          readOnly: true
        last_activity_at:
          type: number
          description: Timestamp at which the last activity recorded for the Data Request
          readOnly: true
        event_logs:
          type: array
          description: >
            Events generated for this data request. Below is the table
            describing the meaning of each of the events for a Data Request


            |event|Description|

            |--- |--- |

            |DATAREQUEST_CREATED| Data Request created|

            |DATAREQUEST_UPDATED| Updated the details of data request|

            |DATAREQUEST_LINK_GENERATED| Data Request invitation link generated|

            |NOTIFY_USER_REQUESTED| Email and/or SMS notification sent to user|

            |DATAREQUEST_LINK_EXTENDED| Link expiry time extended|

            |DATAREQUEST_LINK_EXPIRED| Link for data request expired|

            |DATAREQUEST_LINK_ACCESSED| Data Request Link accessed by user|

            |WIDGET_INITIATED| Widget initiated for datarequest

            |DATASOURCE_CLASSIFIED| Individual landed on login screen|

            |LOGIN_ATTEMPTED| Individual tried to login|

            |INVALID_CREDENTIALS| Credentials provided by user are invalid|

            |DATASOURCE_CONNECTED| Individual entered valid credentials and
            datasource is connected|

            |INSUFFICIENT_CREDENTIALS| Individual was not able to provide
            credentials|

            |ITEM_CREATED| Item was downloaded and stored database|

            |ITEM_PROCESSED| Data extracted and formatted|

            |ITEM_UNPROCESSABLE| Unable to process an item|

            |ITEMS_AVAILABLE| Data Extraction is completed with some items |

            |NO_ITEMS| Data Extraction is completed without an item|

            |USER_INTERVENTION_REQUIRED| Individual re-login required |

            |DATASOURCE_NOT_FOUND| Individual was unable to find datasource|

            |PLAID_INITIATED| Plaid flow initiated|

            |PLAID_CONNECTION_SUCCESSFUL| Plaid connection successful|

            |PLAID_CONNECTION_UNSUCCESSFUL| Plaid connection unsuccessful|

            |REPORT_REQUESTED| Report requested by customer|

            |REPORT_AVAILABLE| Report data is available|

            |REPORT_ERROR| Error occurred during generating report|

            |UPDATES_AVAILABLE| Updated data for Data Request is available|

            |REFRESH_INITIATED| A scheduled refresh is initiated for Data
            Request|      

            |REFRESH_FAILED| A scheduled refresh is failed for Data
            Request|      

            |CONSENT_REGISTERED| Consent registered for Data Request|  

            |CONSENT_DEREGISTER| Consent deregistered for Data Request| 

            |SESSION_TERMINATED| A session is terminated for Data Request|

            |SESSION_LOGGED_OUT| A session is logged out for Data Request|
          readOnly: true
          items:
            properties:
              type:
                type: string
                description: >
                  Events relating to data requests. The following are the event
                  types supported


                  ###  Data Request status events 
                enum:
                  - DATAREQUEST_CREATED
                  - DATAREQUEST_UPDATED
                  - DATAREQUEST_LINK_GENERATED
                  - DATAREQUEST_IGNORED
                  - NOTIFY_USER_REQUESTED
                  - DATAREQUEST_LINK_EXTENDED
                  - DATAREQUEST_LINK_EXPIRED
                  - DATAREQUEST_LINK_ACCESSED
                  - DATAREQUEST_LINK_USED
                  - WIDGET_INITIATED
                  - DATASOURCE_CLASSIFIED
                  - LOGIN_ATTEMPTED
                  - INVALID_CREDENTIALS
                  - DATASOURCE_CONNECTED
                  - INSUFFICIENT_CREDENTIALS
                  - ITEM_CREATED
                  - ITEM_PROCESSED
                  - ITEM_UNPROCESSABLE
                  - ITEMS_AVAILABLE
                  - NO_ITEMS
                  - USER_INTERVENTION_REQUIRED
                  - DATASOURCE_NOT_FOUND
                  - PLAID_INITIATED
                  - PLAID_CONNECTION_SUCCESSFUL
                  - PLAID_CONNECTION_UNSUCCESSFUL
                  - REPORT_REQUESTED
                  - REPORT_AVAILABLE
                  - REPORT_ERROR
                  - UPDATES_AVAILABLE
                  - REFRESH_INITIATED
                  - REFRESH_FAILED
                  - CONSENT_REGISTERED
                  - CONSENT_DEREGISTER
                  - SESSION_TERMINATED
                  - SESSION_LOGGED_OUT
              created_at:
                readOnly: true
                description: Timestamp at which the event was created
                type: number
              details:
                default: null
                description: Data Request event details
                oneOf:
                  - $ref: '#/components/schemas/Updated'
                  - $ref: '#/components/schemas/LinkGenerated'
                  - $ref: '#/components/schemas/NotifyUser'
                  - $ref: '#/components/schemas/LinkExtended'
                  - $ref: '#/components/schemas/LinkExpired'
                  - $ref: '#/components/schemas/LinkAccessed'
                  - $ref: '#/components/schemas/DatasourceClassified'
                  - $ref: '#/components/schemas/LoginAttempted'
                  - $ref: '#/components/schemas/InvalidCredentials'
                  - $ref: '#/components/schemas/DatasourceConnected'
                  - $ref: '#/components/schemas/ItemCreated'
                  - $ref: '#/components/schemas/ItemProcessed'
                  - $ref: '#/components/schemas/ItemUnprocessable'
                  - $ref: '#/components/schemas/ExtractionComplete'
                  - $ref: '#/components/schemas/ExtractionIncomplete'
                  - $ref: '#/components/schemas/UserInterventionRequired'
                  - $ref: '#/components/schemas/ReportRequested'
                  - $ref: '#/components/schemas/ReportCompleted'
                  - $ref: '#/components/schemas/ReportError'
                  - $ref: '#/components/schemas/refreshInitiated'
                  - $ref: '#/components/schemas/refreshFailed'
                  - $ref: '#/components/schemas/consentUpdated'
                  - $ref: '#/components/schemas/SessionLoggedOut'
    CustomDataRequest:
      title: Custom
      description: >
        <br/><br/>

        Use this approach when you want want to customize your data request with
        specific to your needs. Custom Data Requests are used when you want
        specific document types and reports to be executed.

        Example, when you want to only fetch a specific document like W2 from
        the payroll system


        The table below depicts the source_data_type that you can use to create
        a custom data request


        | Source Data Types  | Documents  | Compatible services endpoints |

        |--- |--- |-- |

        | EMPLOYMENT  | PAYSTUB_FILE, EMPLOYMENT_PROFILE  |
        get_employment_summary, get_income_employment_details

        | INCOME  | PAYSTUB_FILE  | get_income_summary,
        get_income_employment_details

        | AUTO_INSURANCE  | AUTO_INSURANCE_POLICY, INSURANCE_PROFILE  |
        get_insurance_details

        | HOME_INSURANCE  | HOME_INSURANCE_POLICY, INSURANCE_PROFILE  |
        get_insurance_details

        | RENTERS_INSURANCE | RENTERS_INSURANCE_POLICY, INSURANCE_PROFILE |
        get_insurance_details

        | EDUCATION  | TRANSCRIPT_FILE, GRADE_REPORT, DEGREE_AUDIT_REPORT,
        GRADUATION_STATUS_REPORT, ACADEMIC_PROFILE  | get_academic_summary,
        get_enrollment_status

        | ADDITIONAL_INSURANCE_DETAILS | POLICY_LISTING, POLICY_DETAILS,
        VEHICLE_LISTING, VEHICLE_DETAILS  | get_insurance_details

        | PROCEEDS_1099_B  | PROCEEDS_1099_B  | get_realized_gains

        | TRANSCRIPT_FILE  | TRANSCRIPT_FILE  | get_academic_summary,
        get_enrollment_status

        | PAYSTUB_FILE  | PAYSTUB_FILE  | get_income_summary,
        get_income_employment_details

        | AUTO_INSURANCE_POLICY  | AUTO_INSURANCE_POLICY  |
        get_insurance_details

        | HOME_INSURANCE_POLICY  | HOME_INSURANCE_POLICY  |
        get_insurance_details

        | RENTERS_INSURANCE_POLICY | RENTERS_INSURANCE_POLICY |
        get_insurance_details

        | INSURANCE_CARD  | INSURANCE_CARD  | get_insurance_details  

        | POLICY_LISTING | POLICY_LISTING  | get_insurance_details

        | POLICY_DETAILS | POLICY_DETAILS  | get_insurance_details

        | VEHICLE_LISTING | VEHICLE_LISTING  | get_insurance_details

        | VEHICLE_DETAILS | VEHICLE_DETAILS  | get_insurance_details

        | TWN_EDR  | TWN_EDR  | get_employment_summary

        | W2_FILE  | W2_FILE  | 

        | STUDENT_ID_CARD  | STUDENT_ID_CARD  | 

        | UNINSURED_MOTORIST_FORM  | UNINSURED_MOTORIST_FORM  | 

        | AUTO_INSURANCE_CLAIM  | AUTO_INSURANCE_CLAIM  | 

        | FORM_1099_B | FORM_1099_B |

        | FORM_1099_CONSOLIDATED | FORM_1099_CONSOLIDATED |

        | FORM_1099_INT | FORM_1099_INT |

        | FORM_1099_DIV | FORM_1099_DIV |

        | FORM_1099_OID | FORM_1099_OID |

        | FORM_1099_MISC | FORM_1099_MISC |

        | FORM_1099_NEC | FORM_1099_NEC |

        | FORM_1098 | FORM_1098 |


        <br/><br/>

        <hr/>
      type: object
      required:
        - individual_id
        - type
        - experience_id
      properties:
        id:
          type: string
          description: Unique ID of the Data Request identified by MeasureOne
          readOnly: true
        individual_id:
          type: string
          description: Unique ID of the Individual identified by MeasureOne
          example: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
        type:
          type: string
          description: Type of the datarequest
          enum:
            - CUSTOM
        actions:
          type: array
          description: >-
            List of actions need to be performed for Data Request. Actions can
            be used to add vehicle.
          items:
            required:
              - type
            properties:
              type:
                type: string
                description: >-
                  Type of action. Type 'GET' will be populated as default when
                  `source_data_types` is provided.
                enum:
                  - ADD_VEHICLE
                x-enumDescriptions:
                  ADD_VEHICLE: >-
                    Use this action to add Vehicle to existing auto insurance
                    policy
              details:
                type: object
                description: Action details. Mandatory for `ADD_VEHICLE` action type.
                $ref: '#/components/schemas/AddVehicleAction'
        source_data_types:
          type: object
          description: Details of source data types you need to complete this request.
          properties:
            direct_connections:
              type: array
              description: >-
                List of source data types you need from direct online account
                connection. This field is required when
                `enable_direct_connection` is true.
              items:
                type: string
                enum:
                  - EMPLOYMENT
                  - INCOME
                  - AUTO_INSURANCE
                  - HOME_INSURANCE
                  - RENTERS_INSURANCE
                  - EDUCATION
                  - PROCEEDS_1099_B
                  - TRANSCRIPT_FILE
                  - PAYSTUB_FILE
                  - AUTO_INSURANCE_POLICY
                  - HOME_INSURANCE_POLICY
                  - RENTERS_INSURANCE_POLICY
                  - INSURANCE_CARD
                  - TWN_EDR
                  - W2_FILE
                  - STUDENT_ID_CARD
                  - UNINSURED_MOTORIST_FORM
                  - AUTO_INSURANCE_CLAIM
                  - POLICY_DETAILS
                  - POLICY_LISTING
                  - VEHICLE_LISTING
                  - VEHICLE_DETAILS
                  - FORM_1099_B
                  - FORM_1099_CONSOLIDATED
                  - FORM_1099_INT
                  - FORM_1099_DIV
                  - FORM_1099_OID
                  - FORM_1099_MISC
                  - FORM_1099_NEC
                  - FORM_1098
                  - UNINSURED_MOTORIST_FORM
                  - AUTO_INSURANCE_CLAIM
            manual_uploads:
              description: >
                Configuration for the source_data_types you want to allow for
                the user to upload. 

                You can use JSON query operators to define the acceptable
                conditions for the user to upload the document.

                The currently supported operators are: '`and` and `or`'. This
                field is required when `enable_manual_upload` is true.


                Below are the examples that you can configure for manual upload

                - Allow user to upload only one type of document

                - Allow user to upload any one of the document type

                - Allow user to upload all of the document type          


                Example: Prompt the user to upload only one type of document

                ```

                {
                  "source_data_type": "PAYSTUB_FILE",
                  "min_count": 2,
                  "max_count": 2
                }

                ```


                Example: Prompt the user to upload any one of the document types
                with different quantities

                ```

                {
                  "$or": [{
                          "source_data_type": "PAYSTUB_FILE",
                          "min_count": 1,
                          "max_count": 3
                      },
                      {
                          "source_data_type": "W2_FILE",
                          "min_count": 1,
                          "max_count": 1
                      }]
                }  

                ```


                Example: Prompt the user to upload all of the document types
                with different quantities

                ```

                {
                  "$and": [{
                          "source_data_type": "PAYSTUB_FILE",
                          "min_count": 1,
                          "max_count": 3
                      },
                      {
                          "source_data_type": "W2_FILE",
                          "min_count": 1,
                          "max_count": 1
                      }]
                }          

                ```
              oneOf:
                - title: or
                  type: object
                  description: OR operator for specifying the conditions for manual upload
                  properties:
                    $or:
                      type: array
                      description: Required any one to complete this request
                      items:
                        anyOf:
                          - title: and
                            type: object
                            description: Required all to complete this request
                            properties:
                              $and:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - title: or
                            type: object
                            description: Required all to complete this request
                            properties:
                              $or:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - $ref: >-
                              #/components/schemas/datarequest_manual_upload_source_data_type
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
                - title: and
                  type: object
                  description: AND operator for specifying the conditions for manual upload
                  properties:
                    $and:
                      type: array
                      items:
                        anyOf:
                          - title: and
                            type: object
                            description: Required all to complete this request
                            properties:
                              $and:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - title: or
                            type: object
                            description: Required all to complete this request
                            properties:
                              $or:
                                type: array
                                items:
                                  $ref: >-
                                    #/components/schemas/datarequest_manual_upload_source_data_type
                          - $ref: >-
                              #/components/schemas/datarequest_manual_upload_source_data_type
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
                - title: source_data_type
                  description: The source_data_type for manual upload
                  properties:
                    source_data_type:
                      type: string
                      description: The type of the source_data
                      enum:
                        - TRANSCRIPT_FILE
                        - PAYSTUB_FILE
                        - AUTO_INSURANCE_POLICY
                        - HOME_INSURANCE_POLICY
                        - RENTERS_INSURANCE_POLICY
                        - INSURANCE_CARD
                        - PROCEEDS_1099_B
                        - TWN_EDR
                        - W2_FILE
                        - STUDENT_ID_CARD
                        - FORM_1099_B
                        - FORM_1099_CONSOLIDATED
                        - FORM_1099_INT
                        - FORM_1099_DIV
                        - FORM_1099_OID
                        - FORM_1099_MISC
                        - FORM_1099_NEC
                        - FORM_1098
                    min_count:
                      type: integer
                      description: Minimum documents required
                      default: 1
                    max_count:
                      type: integer
                      description: Maximum documents required
                      default: 1
                    media_types:
                      type: array
                      description: >
                        Specifies the allowed media types for manual document
                        uploads. If none specified then customer default
                        preference will be used.


                        To ensure support for both structured and non-structured
                        PDFs, include both `application/pdf` and `image/pdf`.
                      items:
                        type: string
                        enum:
                          - application/pdf
                          - image/pdf
                          - image/jpeg
                          - image/jpg
                          - image/png
                          - image/tif
                          - image/tiff
                          - image/bmp
        experience_id:
          description: >-
            Experience Id of the LINK experience. Please reach out to us at
            support@measureone.com to get experience_id for CUSTOM Data Request.
          type: string
        created_at:
          description: Timestamp at which the request was created
          type: number
          readOnly: true
        updated_at:
          description: Timestamp at which the request was last updated
          type: number
          readOnly: true
        third_party_requester:
          type: string
          maxLength: 1023
          default: null
          description: >-
            Optional name of the requester on behalf of which you are raising
            this Data Request. This is reflected in all communications to the
            Individual
        requester_name:
          type: string
          maxLength: 1023
          description: >-
            Your display name. This is reflected in all communications to the
            Individual. If not provided, the system will take your application
            display name set in your account preferences.
        requester_logo_url:
          type: string
          description: >-
            URL of the requester logo to be displayed for the widget. If none
            provided then customer default logo will be used for the widget.
        requester_logo_uri:
          type: string
          description: >-
            URI for the logo to be displayed for the widget. If not provided it
            will be taken from the account preferences
        processing_config:
          type: object
          description: |
            Processing configuration for this request. 
          properties:
            max_latency:
              type: integer
              default: -1
              description: >
                The maximum allowable processing time (in seconds) to complete
                the request. The processing timer starts at the time the
                datasource connection is established or in the case of manual
                upload after all request documents have been submitted. A value
                of `-1` (default) means no maximum allowable processing time. 


                If the processing time exceeds the max_latency, the request will
                be terminated and a session.terminated webhook will be
                triggered. Subscribe to the <a
                href="#tag/webhooks/paths/session.terminated/post">session.terminated</a>
                to receive the webhook.
                           
        datasource:
          type: object
          description: >-
            Pre-identified Datasource details for the Individual to connect.
            Either the `id` or the `display_name` should be provided. If both
            are provided, the `display_name` will be ignored.
          properties:
            id:
              type: string
              description: >-
                Unique ID of the datasource identified by MeasureOne. When
                provided, the Individual will be directly prompted to provide
                their credentials for this Datasource.
            display_name:
              type: string
              maxLength: 127
              description: >-
                Name of the datasource for which you want the Individual to
                connect their account. The Individual will be guided to connect
                to the provided name.
            enable_override:
              type: boolean
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used.
              default: true
            connection_method:
              type: string
              readOnly: true
              enum:
                - DIRECT_CONNECTION
                - MANUAL_UPLOAD
              description: Connection method using which user has connected the account.
            last_connected_at:
              type: number
              readOnly: true
              description: Timestamp (milliseconds) at which last connection was done.
            last_connection_status:
              type: string
              readOnly: true
              enum:
                - NOT_CONNECTED
                - CONNECTED
              description: >-
                Status of last connection details. For details check
                `event_logs` section in response.
        enable_direct_connection:
          type: boolean
          description: >-
            Whether to enable direct connection for the Data Request. If none
            specified then customer default preference will be used.
        enable_manual_upload:
          type: boolean
          description: >-
            Whether to enable manual upload of document for the Data Request. If
            none specified then customer default preference will be used.
        show_connect_method_options:
          type: boolean
          description: >-
            When multiple connect options such as direct connection, manual
            upload, bank account connection are enabled for datarequest then
            user can be presented with all the options upfront in the widget. If
            none specified then customer default preference will be used.
        countries:
          type: array
          items:
            type: string
            enum:
              - US
              - CA
          description: >-
            Pre-identified country code. Providing a value will allow user to
            search the datasources only from selected country.
        request_details:
          type: object
          default: null
          description: >-
            Details of the data request that you can provide while creation.
            This helps in driving the the workflow and the end user experience
            on MeasureOne Link.
          properties:
            datasource:
              type: object
              deprecated: true
              description: >-
                Pre-identified Datasource details for the Individual to connect.
                Either the `id` or the `display_name` should be provided. If
                both are provided, the `display_name` will be ignored.
              properties:
                id:
                  type: string
                  description: >-
                    Unique ID of the datasource identified by MeasureOne. When
                    provided, the Individual will be directly prompted to
                    provide their credentials for this Datasource.
                display_name:
                  type: string
                  maxLength: 127
                  description: >-
                    Name of the datasource for which you want the Individual to
                    connect their account. The Individual will be guided to
                    connect to the provided name.
            countries:
              type: array
              deprecated: true
              items:
                type: string
                enum:
                  - US
                  - CA
              description: >-
                Pre-identified country code. Providing a value will allow user
                to search the datasources only from selected country.
            enable_manual_upload:
              type: boolean
              deprecated: true
              description: >-
                Whether to enable manual upload of document for the Data
                Request. If none specified then customer default preference will
                be used.
            enable_datasource_override:
              type: boolean
              deprecated: true
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used. `This attribute is deprecated.
                Refer to datasource.enable_override in the parent object
            show_connect_method_options:
              type: boolean
              deprecated: true
              description: >-
                When multiple connect options such as direct connection, manual
                upload, bank account connection are enabled for datarequest then
                user can be presented with all the options upfront in the
                widget. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            student_type:
              type: string
              description: >-
                Type of the student. **This attribute is used only when the
                request is being used for the purposes of Education
                Verification**
              enum:
                - CURRENT_STUDENT
                - ALUMNI
            employment_status:
              type: string
              description: >-
                Pre-identified employment status . **This attribute is used only
                when the request is being used for the purposes of Employment
                Verification**
              enum:
                - CURRENT
                - FORMER
            employment_type:
              type: string
              description: >-
                Type of the Employee.  **This attribute is used only when the
                request is being used for the purposes of Employment
                Verification**
              enum:
                - EMPLOYEE
                - GIG_WORKER
                - CONTRACTOR
            tax_year:
              type: number
              example: 1994
              description: >-
                An annual accounting year for tax calculation. e.g 2022. **This
                attribute is required only when the request is being used for
                the purposes of brokerage data request**
            earnings_period_type:
              type: string
              description: >-
                Earnings period type. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
              enum:
                - CURRENT
                - HISTORIC
            get_yearly_earnings:
              type: boolean
              description: >-
                Include yearly earnings CY + last 2 years in the VOIE/Income
                Summary report. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
            enable_bank_income:
              type: boolean
              description: >-
                Whether to enable bank account connect option for the Data
                Request. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            use_legacy_insurance:
              type: boolean
              default: false
              description: >-
                Flag to support legacy INSURANCE_POLICY source_data_type. **This
                attribute is used only when the request is being used for the
                purposes of Auto or Home Insurance Verification**
            institution_type:
              type: array
              items:
                type: string
              description: |
                Datasource categories for which you want to filter in M1Link.

                `COLLEGE`: To search for academic institutions<br>
                `EMPLOYER`: To search for employers<br>
                `PAYROLL_PROCESSOR`: To search for payroll providers<br>
                `HOMEINSURANCE`: To search for home insurance providers<br>
                `AUTOINSURANCE`: To search for auto insurance providers<br>
                `BROKERAGE_ACCOUNT`: To search for brokerage firms<br>
                `BANK_ACCOUNT`: To search for Banks<br>
        reports:
          type: array
          description: List of reports that are required for the Data Request
          items:
            type: object
            properties:
              uri:
                type: string
                description: The type of the report
                enum:
                  - m1_report://EMPLOYMENT_SUMMARY
                  - m1_report://INCOME_SUMMARY
                  - m1_report://INCOME_EMPLOYMENT_DETAILS
                  - m1_report://INSURANCE_DETAILS
                  - m1_report://INSURANCE_STATUS
                  - m1_report://ACADEMIC_SUMMARY
                  - m1_report://ENROLLMENT_STATUS
                  - m1_report://REALIZED_GAINS
              params:
                type: object
                description: >
                  Parameters for the report. Refer to the details of each report
                  in the [Services](#tag/Education) section
              metadata:
                type: object
                description: >-
                  metadata can be used for storing additional information in a
                  structured format. metadata will be sent in webhooks and
                  report response.
        delivery_details:
          type: array
          description: >-
            List of endpoints to which the [webhooks](#tag/webhooks) should be
            delivered
          items:
            required:
              - event_type
              - url
            properties:
              event_type:
                type: string
                description: >-
                  Event for which you want a notification. If not provided, it
                  will be taken from the default account preference. Refer to
                  Webhooks section to see the list of all events supported
                enum:
                  - datarequest.items_available
                  - datarequest.items_processed
                  - datarequest.no_items
                  - datarequest.report_available
                  - datarequest.report_error
                  - datarequest.acquisition_completed
                  - datarequest.updates_available
                  - datarequest.refresh_failed
                  - datasource.connected
                  - transaction.processed
                  - unprocessable.entity
                  - session.rejected
                  - session.terminated
                  - session.no_login
                  - item.created
                  - item.processed
                  - item.unavailable
              url:
                description: URL to which the webhook should be delivered
                type: string
                format: url
              headers:
                type: object
                description: >-
                  Additional http headers that you may want to pass. MeasureOne
                  will send the data with content-type as `application/json`
                example:
                  content-type: application/json
              x_auth_token_credentials:
                description: >-
                  MeasureOne will generate the authorization token with provided
                  auth token credentials and use the generated token while
                  delivering webhooks. `x_auth_token_credentials` details can be
                  provided when a fresh authorization token needs to be used
                  when MeasureOne delivers webhook.
                type: object
                required:
                  - token_type
                  - http_method
                  - url
                properties:
                  token_type:
                    type: string
                    description: Type of token
                    enum:
                      - JWT
                  http_method:
                    type: string
                    description: Type of HTTP method
                    enum:
                      - POST
                  url:
                    type: string
                    format: url
                    description: Endpoint url to generate auth token
                    examples:
                      - https://sampledomain.com/generate_token
                  key_id:
                    type: string
                    description: >-
                      Unique ID of the Encryption key identified by MeasureOne.
                      `x_auth_token_credentials` holds credentials details. So,
                      `authorization` header and `data` can be provided in
                      encrypted form. When `key_id` is provided then
                      `authorization` header and attributes value in `data`
                      object will be treated as encrypted. Please reach out to
                      us on support@mesureone.com to get your encryption key_id
                      setup.
                  headers:
                    type: object
                    description: >
                      Request body headers that you may want to pass while
                      calling endpoint.


                      MeasureOne supports two content-type `application/json`
                      and `application/x-www-form-urlencoded` for generate auth
                      token endpoint. An unspecified content-type will default
                      to `application/json`
                  data:
                    type: object
                    description: >-
                      Data that we need to pass in body while calling endpoint.
                      attribute's value can be pass in encrypted form when
                      `key_id` is provided.
                  response_token_path:
                    type: string
                    description: >-
                      Path from response for token attribute. When
                      `response_token_path` is unspecified then complete
                      response will be used as auth token.
                    examples:
                      - access_token.token
        refresh_policy:
          type: object
          description: Refresh Policy details to auto refresh data periodically
          properties:
            enabled:
              type: boolean
              description: >-
                Indicates whether auto-refresh is enabled for the Data Request.
                Set to `true` if wants to use auto-refresh for the Data Request.
                If `schedule` is provided then `enabled` should be `true`.
            schedule:
              oneOf:
                - title: Daily
                  type: object
                  required:
                    - frequency
                  description: |
                    Refresh schedule to auto refresh data daily

                    Example: refresh daily
                    ```
                    {
                      "frequency": "DAILY"
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                - title: Weekly
                  type: object
                  required:
                    - frequency
                    - by_weekday
                  description: |
                    Refresh schedule to auto refresh data Weekly

                    Example: refresh every week on Monday
                    ```
                    {
                      "frequency": "WEEKLY",
                      "by_weekday": ["MO"]              
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_weekday:
                      type: array
                      description: >
                        List of days of the week. `SU` indicates Sunday; `MO`
                        indicates Monday; `TU` indicates Tuesday; `WE` indicates
                        Wednesday; `TH` indicates Thursday; `FR` indicates
                        Friday; and `SA` indicates Saturday.
                      items:
                        type: string
                        enum:
                          - SU
                          - MO
                          - TU
                          - WE
                          - TH
                          - FR
                          - SA
                - title: Monthly
                  type: object
                  required:
                    - frequency
                    - by_monthday
                  description: |
                    Refresh schedule to auto refresh data Monthly

                    Example: refresh every month on 15th
                    ```
                    {
                      "frequency": "MONTHLY",
                      "by_monthday": [15]
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_monthday:
                      type: array
                      description: |
                        List of days of the month. Valid values are 1 to 31
                      items:
                        type: number
            effective_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should start
            end_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should end
            last_refresh_at:
              type: number
              description: >-
                Timestamp (milliseconds) when the last refresh was executed for
                the datarequest
              readOnly: true
            next_refresh_at:
              type: number
              description: >-
                Timestamp (milliseconds) when the next refresh is scheduled for
                the datarequest
              readOnly: true
        consent:
          type: object
          description: Consent details for this datarequest
          readOnly: true
          properties:
            id:
              type: string
              description: Unique ID of consent
              examples:
                - cs_wf325dgfhhj
            description:
              description: Description of consent
              type: string
            recorded_at:
              type: integer
              description: Timestamp at which user has given accepted the consent
              examples:
                - 1696675463535
        invitation_links:
          type: array
          description: >-
            List of invitation links associated with datarequest. Only 1
            invitation link is active at any given time.
          readOnly: true
          items:
            $ref: '#/components/schemas/link'
        last_activity_type:
          type: string
          description: Last activity recorded for the Data Request
          enum:
            - CREATED
            - INVITATION_CREATED
            - AVAILABLE
            - COMPLETE
            - FAILED
          readOnly: true
        last_activity_at:
          type: number
          description: Timestamp at which the last activity recorded for the Data Request
          readOnly: true
        event_logs:
          type: array
          description: >
            Events generated for this data request. Below is the table
            describing the meaning of each of the events for a Data Request


            |event|Description|

            |--- |--- |

            |DATAREQUEST_CREATED| Data Request created|

            |DATAREQUEST_UPDATED| Updated the details of data request|

            |DATAREQUEST_LINK_GENERATED| Data Request invitation link generated|

            |NOTIFY_USER_REQUESTED| Email and/or SMS notification sent to user|

            |DATAREQUEST_LINK_EXTENDED| Link expiry time extended|

            |DATAREQUEST_LINK_EXPIRED| Link for data request expired|

            |DATAREQUEST_LINK_ACCESSED| Data Request Link accessed by user|

            |WIDGET_INITIATED| Widget initiated for datarequest

            |DATASOURCE_CLASSIFIED| Individual landed on login screen|

            |LOGIN_ATTEMPTED| Individual tried to login|

            |INVALID_CREDENTIALS| Credentials provided by user are invalid|

            |DATASOURCE_CONNECTED| Individual entered valid credentials and
            datasource is connected|

            |INSUFFICIENT_CREDENTIALS| Individual was not able to provide
            credentials|

            |ITEM_CREATED| Item was downloaded and stored database|

            |ITEM_PROCESSED| Data extracted and formatted|

            |ITEM_UNPROCESSABLE| Unable to process an item|

            |ITEMS_AVAILABLE| Data Extraction is completed with some items |

            |NO_ITEMS| Data Extraction is completed without an item|

            |USER_INTERVENTION_REQUIRED| Individual re-login required |

            |DATASOURCE_NOT_FOUND| Individual was unable to find datasource|

            |PLAID_INITIATED| Plaid flow initiated|

            |PLAID_CONNECTION_SUCCESSFUL| Plaid connection successful|

            |PLAID_CONNECTION_UNSUCCESSFUL| Plaid connection unsuccessful|

            |REPORT_REQUESTED| Report requested by customer|

            |REPORT_AVAILABLE| Report data is available|

            |REPORT_ERROR| Error occurred during generating report|

            |UPDATES_AVAILABLE| Updated data for Data Request is available|

            |REFRESH_INITIATED| A scheduled refresh is initiated for Data
            Request|      

            |REFRESH_FAILED| A scheduled refresh is failed for Data
            Request|      

            |CONSENT_REGISTERED| Consent registered for Data Request|  

            |CONSENT_DEREGISTER| Consent deregistered for Data Request| 

            |SESSION_TERMINATED| A session is terminated for Data Request| 

            |SESSION_LOGGED_OUT| A session is logged out for Data Request|
          readOnly: true
          items:
            properties:
              type:
                type: string
                description: >
                  Events relating to data requests. The following are the event
                  types supported


                  ###  Data Request status events
                enum:
                  - DATAREQUEST_CREATED
                  - DATAREQUEST_UPDATED
                  - DATAREQUEST_LINK_GENERATED
                  - DATAREQUEST_IGNORED
                  - NOTIFY_USER_REQUESTED
                  - DATAREQUEST_LINK_EXTENDED
                  - DATAREQUEST_LINK_EXPIRED
                  - DATAREQUEST_LINK_ACCESSED
                  - DATAREQUEST_LINK_USED
                  - WIDGET_INITIATED
                  - DATASOURCE_CLASSIFIED
                  - LOGIN_ATTEMPTED
                  - INVALID_CREDENTIALS
                  - DATASOURCE_CONNECTED
                  - INSUFFICIENT_CREDENTIALS
                  - ITEM_CREATED
                  - ITEM_PROCESSED
                  - ITEM_UNPROCESSABLE
                  - ITEMS_AVAILABLE
                  - NO_ITEMS
                  - USER_INTERVENTION_REQUIRED
                  - DATASOURCE_NOT_FOUND
                  - PLAID_INITIATED
                  - PLAID_CONNECTION_SUCCESSFUL
                  - PLAID_CONNECTION_UNSUCCESSFUL
                  - REPORT_REQUESTED
                  - REPORT_AVAILABLE
                  - REPORT_ERROR
                  - UPDATES_AVAILABLE
                  - REFRESH_INITIATED
                  - REFRESH_FAILED
                  - CONSENT_REGISTERED
                  - CONSENT_DEREGISTER
                  - SESSION_TERMINATED
                  - SESSION_LOGGED_OUT
              created_at:
                readOnly: true
                description: Timestamp at which the event was created
                type: number
              details:
                default: null
                description: Data Request event details
                oneOf:
                  - $ref: '#/components/schemas/Updated'
                  - $ref: '#/components/schemas/LinkGenerated'
                  - $ref: '#/components/schemas/NotifyUser'
                  - $ref: '#/components/schemas/LinkExtended'
                  - $ref: '#/components/schemas/LinkExpired'
                  - $ref: '#/components/schemas/LinkAccessed'
                  - $ref: '#/components/schemas/DatasourceClassified'
                  - $ref: '#/components/schemas/LoginAttempted'
                  - $ref: '#/components/schemas/InvalidCredentials'
                  - $ref: '#/components/schemas/DatasourceConnected'
                  - $ref: '#/components/schemas/ItemCreated'
                  - $ref: '#/components/schemas/ItemProcessed'
                  - $ref: '#/components/schemas/ItemUnprocessable'
                  - $ref: '#/components/schemas/ExtractionComplete'
                  - $ref: '#/components/schemas/ExtractionIncomplete'
                  - $ref: '#/components/schemas/UserInterventionRequired'
                  - $ref: '#/components/schemas/ReportRequested'
                  - $ref: '#/components/schemas/ReportCompleted'
                  - $ref: '#/components/schemas/ReportError'
                  - $ref: '#/components/schemas/refreshInitiated'
                  - $ref: '#/components/schemas/refreshFailed'
                  - $ref: '#/components/schemas/consentUpdated'
                  - $ref: '#/components/schemas/SessionLoggedOut'
    DatarequestUpdate:
      title: Data Request
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique ID of the Data Request identified by MeasureOne
        request_details:
          type: object
          default: null
          description: >-
            Details of the data request that you can provide while creation.
            This helps in driving the the workflow and the end user experience
            on MeasureOne Link.
          properties:
            datasource:
              type: object
              deprecated: true
              description: >-
                Pre-identified Datasource details for the Individual to connect.
                Either the `id` or the `display_name` should be provided. If
                both are provided, the `display_name` will be ignored.
              properties:
                id:
                  type: string
                  description: >-
                    Unique ID of the datasource identified by MeasureOne. When
                    provided, the Individual will be directly prompted to
                    provide their credentials for this Datasource.
                display_name:
                  type: string
                  maxLength: 127
                  description: >-
                    Name of the datasource for which you want the Individual to
                    connect their account. The Individual will be guided to
                    connect to the provided name.
            countries:
              type: array
              deprecated: true
              items:
                type: string
                enum:
                  - US
                  - CA
              description: >-
                Pre-identified country code. Providing a value will allow user
                to search the datasources only from selected country.
            enable_manual_upload:
              type: boolean
              deprecated: true
              description: >-
                Whether to enable manual upload of document for the Data
                Request. If none specified then customer default preference will
                be used.
            enable_datasource_override:
              type: boolean
              deprecated: true
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used. `This attribute is deprecated.
                Refer to datasource.enable_override in the parent object
            show_connect_method_options:
              type: boolean
              deprecated: true
              description: >-
                When multiple connect options such as direct connection, manual
                upload, bank account connection are enabled for datarequest then
                user can be presented with all the options upfront in the
                widget. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            student_type:
              type: string
              description: >-
                Type of the student. **This attribute is used only when the
                request is being used for the purposes of Education
                Verification**
              enum:
                - CURRENT_STUDENT
                - ALUMNI
            employment_status:
              type: string
              description: >-
                Pre-identified employment status . **This attribute is used only
                when the request is being used for the purposes of Employment
                Verification**
              enum:
                - CURRENT
                - FORMER
            employment_type:
              type: string
              description: >-
                Type of the Employee.  **This attribute is used only when the
                request is being used for the purposes of Employment
                Verification**
              enum:
                - EMPLOYEE
                - GIG_WORKER
                - CONTRACTOR
            tax_year:
              type: number
              example: 1994
              description: >-
                An annual accounting year for tax calculation. e.g 2022. **This
                attribute is required only when the request is being used for
                the purposes of brokerage data request**
            earnings_period_type:
              type: string
              description: >-
                Earnings period type. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
              enum:
                - CURRENT
                - HISTORIC
            get_yearly_earnings:
              type: boolean
              description: >-
                Include yearly earnings CY + last 2 years in the VOIE/Income
                Summary report. If none specified then customer default
                preference will be used.  **This attribute is used only when the
                request is being used for the purposes of Income and Employment
                Verification or Income Verification**
            enable_bank_income:
              type: boolean
              description: >-
                Whether to enable bank account connect option for the Data
                Request. If none specified then customer default preference will
                be used.  **This attribute is used only when the request is
                being used for the purposes of Income and Employment
                Verification or Income Verification**
            use_legacy_insurance:
              type: boolean
              default: false
              description: >-
                Flag to support legacy INSURANCE_POLICY source_data_type. **This
                attribute is used only when the request is being used for the
                purposes of Auto or Home Insurance Verification**
            institution_type:
              type: array
              items:
                type: string
              description: |
                Datasource categories for which you want to filter in M1Link.

                `COLLEGE`: To search for academic institutions<br>
                `EMPLOYER`: To search for employers<br>
                `PAYROLL_PROCESSOR`: To search for payroll providers<br>
                `HOMEINSURANCE`: To search for home insurance providers<br>
                `AUTOINSURANCE`: To search for auto insurance providers<br>
                `BROKERAGE_ACCOUNT`: To search for brokerage firms<br>
                `BANK_ACCOUNT`: To search for Banks<br>
        datasource:
          type: object
          description: >-
            Pre-identified Datasource details for the Individual to connect.
            Either the `id` or the `display_name` should be provided. If both
            are provided, the `display_name` will be ignored.
          properties:
            id:
              type: string
              description: >-
                Unique ID of the datasource identified by MeasureOne. When
                provided, the Individual will be directly prompted to provide
                their credentials for this Datasource.
            display_name:
              type: string
              maxLength: 127
              description: >-
                Name of the datasource for which you want the Individual to
                connect their account. The Individual will be guided to connect
                to the provided name.
            enable_override:
              type: boolean
              description: >-
                Override widget deeplink flow. If none specified then customer
                default preference will be used.
              default: true
        enable_direct_connection:
          type: boolean
          description: >-
            Whether to enable direct connection for the Data Request. If none
            specified then customer default preference will be used.
        enable_manual_upload:
          type: boolean
          description: >-
            Whether to enable manual upload of document for the Data Request. If
            none specified then customer default preference will be used.
        show_connect_method_options:
          type: boolean
          description: >-
            When multiple connect options such as direct connection, manual
            upload, bank account connection are enabled for datarequest then
            user can be presented with all the options upfront in the widget. If
            none specified then customer default preference will be used.
        countries:
          type: array
          items:
            type: string
            enum:
              - US
              - CA
          description: >-
            Pre-identified country code. Providing a value will allow user to
            search the datasources only from selected country.
        third_party_requester:
          type: string
          default: null
          maxLength: 1023
          description: >-
            Name of the third party requester. This name will be reflected in
            the communications to the Individual.
        requester_name:
          type: string
          maxLength: 1023
          description: >-
            Display name of the requester.  This name will be reflected in the
            communications to the Individual. If not provided, the system will
            take your application display name set in your account preferences.
        requester_logo_uri:
          type: string
          description: >-
            URI for the logo to be displayed for the widget. If not provided it
            will be taken from the account preferences
        processing_config:
          type: object
          description: |
            Processing configuration for this request. 
          properties:
            max_latency:
              type: integer
              default: -1
              description: >
                The maximum allowable processing time (in seconds) to complete
                the request. The processing timer starts at the time the
                datasource connection is established or in the case of manual
                upload after all request documents have been submitted. A value
                of `-1` (default) means no maximum allowable processing time. 


                If the processing time exceeds the max_latency, the request will
                be terminated and a session.terminated webhook will be
                triggered. Subscribe to the <a
                href="#tag/webhooks/paths/session.terminated/post">session.terminated</a>
                to receive the webhook.
                           
        delivery_details:
          type: array
          description: >-
            List of endpoints to which the [webhooks](#tag/webhooks) should be
            delivered
          items:
            required:
              - event_type
              - url
            properties:
              event_type:
                type: string
                description: >-
                  Event for which you want a notification. If not provided, it
                  will be taken from the default account preference. Refer to
                  Webhooks section to see the list of all events supported
                enum:
                  - datarequest.items_available
                  - datarequest.items_processed
                  - datarequest.no_items
                  - datarequest.report_available
                  - datarequest.report_error
                  - datarequest.acquisition_completed
                  - datarequest.updates_available
                  - datarequest.refresh_failed
                  - datasource.connected
                  - transaction.processed
                  - unprocessable.entity
                  - session.rejected
                  - session.terminated
                  - session.no_login
                  - item.created
                  - item.processed
                  - item.unavailable
              url:
                description: URL to which the webhook should be delivered
                type: string
                format: url
              headers:
                type: object
                description: >-
                  Additional http headers that you may want to pass. MeasureOne
                  will send the data with content-type as `application/json`
                example:
                  content-type: application/json
              x_auth_token_credentials:
                description: >-
                  MeasureOne will generate the authorization token with provided
                  auth token credentials and use the generated token while
                  delivering webhooks. `x_auth_token_credentials` details can be
                  provided when a fresh authorization token needs to be used
                  when MeasureOne delivers webhook.
                type: object
                required:
                  - token_type
                  - http_method
                  - url
                properties:
                  token_type:
                    type: string
                    description: Type of token
                    enum:
                      - JWT
                  http_method:
                    type: string
                    description: Type of HTTP method
                    enum:
                      - POST
                  url:
                    type: string
                    format: url
                    description: Endpoint url to generate auth token
                    examples:
                      - https://sampledomain.com/generate_token
                  key_id:
                    type: string
                    description: >-
                      Unique ID of the Encryption key identified by MeasureOne.
                      `x_auth_token_credentials` holds credentials details. So,
                      `authorization` header and `data` can be provided in
                      encrypted form. When `key_id` is provided then
                      `authorization` header and attributes value in `data`
                      object will be treated as encrypted. Please reach out to
                      us on support@mesureone.com to get your encryption key_id
                      setup.
                  headers:
                    type: object
                    description: >
                      Request body headers that you may want to pass while
                      calling endpoint.


                      MeasureOne supports two content-type `application/json`
                      and `application/x-www-form-urlencoded` for generate auth
                      token endpoint. An unspecified content-type will default
                      to `application/json`
                  data:
                    type: object
                    description: >-
                      Data that we need to pass in body while calling endpoint.
                      attribute's value can be pass in encrypted form when
                      `key_id` is provided.
                  response_token_path:
                    type: string
                    description: >-
                      Path from response for token attribute. When
                      `response_token_path` is unspecified then complete
                      response will be used as auth token.
                    examples:
                      - access_token.token
        refresh_policy:
          type: object
          description: Refresh Policy details to auto refresh data periodically
          properties:
            enabled:
              type: boolean
              description: >-
                Indicates whether auto-refresh is enabled for the Data Request.
                Set to `true` if wants to use auto-refresh for the Data Request.
                If `schedule` is provided then `enabled` should be `true`.
            schedule:
              oneOf:
                - title: Daily
                  type: object
                  required:
                    - frequency
                  description: |
                    Refresh schedule to auto refresh data daily

                    Example: refresh daily
                    ```
                    {
                      "frequency": "DAILY"
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                - title: Weekly
                  type: object
                  required:
                    - frequency
                    - by_weekday
                  description: |
                    Refresh schedule to auto refresh data Weekly

                    Example: refresh every week on Monday
                    ```
                    {
                      "frequency": "WEEKLY",
                      "by_weekday": ["MO"]              
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_weekday:
                      type: array
                      description: >
                        List of days of the week. `SU` indicates Sunday; `MO`
                        indicates Monday; `TU` indicates Tuesday; `WE` indicates
                        Wednesday; `TH` indicates Thursday; `FR` indicates
                        Friday; and `SA` indicates Saturday.
                      items:
                        type: string
                        enum:
                          - SU
                          - MO
                          - TU
                          - WE
                          - TH
                          - FR
                          - SA
                - title: Monthly
                  type: object
                  required:
                    - frequency
                    - by_monthday
                  description: |
                    Refresh schedule to auto refresh data Monthly

                    Example: refresh every month on 15th
                    ```
                    {
                      "frequency": "MONTHLY",
                      "by_monthday": [15]
                    }
                    ```
                  properties:
                    frequency:
                      type: string
                      description: Type of recurrence
                      enum:
                        - DAILY
                        - WEEKLY
                        - MONTHLY
                    by_monthday:
                      type: array
                      description: |
                        List of days of the month. Valid values are 1 to 31
                      items:
                        type: number
            effective_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should start
            end_date:
              type: number
              description: Timestamp (milliseconds) when the refresh should end
  examples:
    v3@invitations@new:
      summary: Submitting invitation new with Institution name
      description: Submitting invitation new with Institution name
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        validity: 259200
        link_only: false
        requester_name: string value
        additional_message: Please use this invitation for University of Michigan Ann Arbor
        institution_name: University of Michigan Ann Arbor
        query_type:
          - ACADEMIC_SUMMARY
    v3@invitationsWithDatasource@new:
      summary: Create a new Invitation with datasource
      description: Example payload when creating an Invitation
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        validity: 259200
        link_only: false
        requestor_name: string value
        additional_message: Please use this invitation for University of Michigan Ann Arbor
        query_type:
          - ACADEMIC_SUMMARY
        datasource:
          datasource_id: ins_1yRlM42Nzzi5s63B3a2KdGrCoyw
          datasource_name: New Jersey Institute Of Technology
    v3@errors@400:
      summary: Bad Request
      description: Example payload Bad Requests
      value:
        timestamp: 1585747802495
        error_code: BAD_REQUEST
        http_code: 400
        error_message: Invalid JSON
    v3@errors@500:
      summary: Internal Error
      description: Example payload Internal Error
      value:
        timestamp: 1585747802495
        error_code: INTERNAL_ERROR
        http_code: 500
        error_message: Could not execute request
    v3@invitations@get_by_id:
      value:
        id: 1xkaiwio21ksdj135
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        updated_at: 1596268104941
        url: https://transcriptlink.measureone.com/xkaslieirwqae/1xkaiwio21ksdj135
        created_at: 1596268104941
        expires_at: 1596468135586
        completed_at: 1596468135586
        status: USED
        link_only: false
        requester_name: string value
        additional_message: Please use this invitation for University of Michigan Ann Arbor
        institution_name: University of Michigan Ann Arbor
        query_type:
          - ACADEMIC_SUMMARY
        expiry_reason: LINK_EXPIRED
        datasource:
          datasource_id: ins_1yRlM42Nzzi5s63B3a2KdGrCoyw
          datasource_name: New Jersey Institute Of Technology
    v3@individuals@new:
      summary: Create a new individual
      description: Example payload when creating an individual
      value:
        external_id: ABCDEF
        first_name: John
        last_name: Doe
        email: john.doe@example.com
        date_of_birth: 10/24/1992
        name_prefix: Mr.
        name_suffix: Jr.
        gender: M
        address:
          addr1: Street 1
          addr2: Street 2
          city: Ann Arbor
          state_name: Michigan
          country:
            name: United States
    v3@individuals@new-2:
      summary: Successful Individual Creation Response
      value:
        id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@individuals@get_by_id:
      summary: Get individual's Details by ID
      value:
        id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@individuals@get_by_id-2:
      summary: Get Details of an Individual by ID
      description: Example payload when retrieving individual details by  ID
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        external_id: ABCDEF
        first_name: John
        last_name: Doe
        email: john.doe@example.com
        date_of_birth: 10/24/1992
        name_prefix: Mr.
        name_suffix: Jr.
        gender: M
        address:
          addr1: Street 1
          addr2: Street 2
          city: Ann Arbor
          state_name: Michigan
          country:
            name: United States
        last_activity_at: 9287384728347
    v3@errors@404:
      summary: NOT FOUND
      description: Example payload NOT FOUND
      value:
        timestamp: 1585747802495
        error_code: NOT_FOUND
        http_code: 404
        error_message: Cannot find the requested resource
    v3@individuals@get_items:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
    v3@services@get_transaction_by_datarequest_id:
      value:
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
    v3@individuals@get_items-2:
      summary: Get List of items for an Individual
      description: Example payload
      value:
        individual:
          individual_id: idv_Cevp4JewCIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
        items:
          - id: itm_Cevp4JweIsEeNjpgAAjy2EZt3R
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp
            created_at: 1673322103030
            updated_at: 1673492103030
            duplicates: []
            refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
          - id: itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp
            created_at: 1673322113030
            updated_at: 1673492153030
            duplicates:
              - itm_2QE8dfq6AK3mE46ogFjtH3L7CZd
            refresh_id: null
          - id: itm_2QE8dfq6AK3mE46ogFjtH3L7CZd
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp
            created_at: 1673322203030
            updated_at: 1673492603030
            duplicates:
              - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
            refresh_id: rfs_1233ks2lkdw4i4j2li342dfdjslfu
    v3@individuals@get_items_datarequest_id:
      summary: Get List of items for a DataRequest ID
      description: Example payload
      value:
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        items:
          - id: itm_Cevp4JweIsEeNjpgAAjy2EZt3R
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            created_at: 1673322103030
            updated_at: 1673492103030
            duplicates: []
            refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
          - id: itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            created_at: 1673322113030
            updated_at: 1673492153030
            duplicates:
              - itm_2QE8dfq6AK3mE46ogFjtH3L7CZd
            refresh_id: null
          - id: itm_2QE8dfq6AK3mE46ogFjtH3L7CZd
            source_data_type: TRANSCRIPT_FILE
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            created_at: 1673322203030
            updated_at: 1673492603030
            duplicates:
              - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
            refresh_id: rfs_1233ks2lkdw4idfg45li342podjslfu
    v3@item@new@m1digest_digital_payload:
      summary: Create a new Item using M1_DIGEST
      description: Example payload when creating a transcript with M1_DIGEST
      value:
        external_id: ABCDECD
        datarequest_id: dr_Cevp4Jw9CIsEeNjpgAAjy2EZt3R"
        source_data_type: M1_DIGEST
        source_data:
          - referrer: USER
            source_data_value:
              degree_type: BACHELORS
              years_in_school: 2
              min_grade: D
              cgpa: 3.3
              last_term_gpa: 3.5
              credits_earned: 65
    v3@item@new@m1_transcript_digital_payload:
      summary: Create a new Item using M1 ACADEMIC RECORD
      description: Example payload when creating a transcript with M1_ACADEMIC_RECORD
      value:
        external_id: ABCDECD
        datarequest_id: dr_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datasource_id: sch_CV8e5NzZXwXhNp3TGnpryEmub2E
        source_data_type: M1_ACADEMIC_RECORD
        source_data:
          - referrer: USER
            source_data_value:
              transcript_date: '2019-12-18'
              student_id: 10112ABCD
              student:
                first_name: John
                last_name: Doe
                middle_name: N.
                prefix: Mr.
                suffix: Jr.
                full_name: Doe,John N.
                former_first_name: Johnny
                former_middle_name: N.
                former_last_name: Doe
                former_full_name: Doe, Johnny N.
                former_suffix: Jr.
                former_prefix: Mr.
                date_of_birth: '1996-03-21'
                ssn: XXX-XX-3436
                email: johndoe@example.com
                address:
                  addr1: 3757  Farland Avenue
                  addr2: Village View Drive
                  city: Liberty Center
                  state: FL
                  zipcode: '33901'
                  country:
                    name: United States
                    a2_code: US
                other_attributes: {}
              previous_academic_record:
                - name: University Of California-Berkeley
                  id_type: IPEDS
                  id: '110635'
                  address:
                    addr1: 200 California Hall
                    addr2: 'null'
                    city: Berkeley
                    state: California
                    zipcode: '94720'
                    country:
                      name: United States
                      a2_code: US
                  start_date: '2014-08-20'
                  end_date: '2015-05-28'
                  degrees:
                    - type: BACHELORS
                      status: WITHDRAWN
                      awarded_date: 'null'
                      description: Bachelors of Science
                      academic_summary:
                        - credit_type: SEMESTER
                          level: INSTITUTION
                          cumulative: 'true'
                          gpa_credits: '27'
                          attempted: '27'
                          earned: '27'
                          gpa: '3.6667'
                          quality_points: '99'
                      field_of_study:
                        - type: MAJOR
                          description: Biology
                          code_type: CIP
                          code: '26'
                      years_of_study: '1'
                      other_attributes: {}
                  other_attributes: {}
              transcript_institution:
                name: California State University-Bakersfield
                id_type: IPEDS
                id: '110486'
                address:
                  addr1: '9001'
                  addr2: Stockdale Hwy
                  city: Bakersfield
                  state: California
                  zipcode: '93311'
                  country:
                    name: United States
                    a2_code: US
                other_attributes:
                  college: 'null'
                  campus: Bakersfield
              academic_summary:
                - credit_type: SEMESTER
                  level: TOTAL
                  cumulative: 'true'
                  gpa_credits: '91'
                  attempted: '127'
                  earned: '127'
                  gpa: '3.74'
                  quality_points: '341'
              academic_sessions:
                - type: SEMESTER
                  name: Fall 2014
                  start_date: '2014-08-20'
                  end_date: '2014-12-22'
                  in_progress: 'false'
                  level: Freshman
                  honors:
                    - Dean's List
                  curriculum_code_type: 'null'
                  curriculum_code: 'null'
                  curriculum_name: 'null'
                  academic_summary:
                    - credit_type: SEMESTER
                      level: TOTAL
                      cumulative: 'true'
                      gpa_credits: '0'
                      attempted: '12'
                      earned: '12'
                      gpa: 'null'
                      quality_points: '0'
                  courses:
                    - credit_basis: TRANSFER
                      honors_course: 'false'
                      repeated: 'false'
                      count_in_gpa: 'null'
                      code_type: 'null'
                      code: 'null'
                      id: ENGL 1101
                      name: English Comp I
                      instructional_setting: 'null'
                      credits:
                        credit_type: SEMESTER
                        gpa_credits: '0'
                        attempted: '3'
                        earned: '3'
                        quality_points: '0'
                        grade_qualifier: 'null'
                        grade: TA
                      start_date: '2014-08-20'
                      end_date: '2014-12-22'
                      other_attributes: {}
                  degrees:
                    - type: BACHELORS
                      status: UNKNOWN
                      awarded_date: 'null'
                      description: Bachelors of Science
                      academic_summary:
                        - credit_type: SEMESTER
                          level: TOTAL
                          cumulative: 'true'
                          gpa_credits: '0'
                          attempted: '12'
                          earned: '12'
                          gpa: 'null'
                          quality_points: '0'
                      field_of_study:
                        - type: MAJOR
                          description: Biology
                          code_type: CIP
                          code: '26'
                      years_of_study: 'null'
                      other_attributes: {}
                  other_attributes: {}
                - type: SEMESTER
                  name: Spring 2018
                  start_date: '2018-01-04'
                  end_date: '2018-05-15'
                  in_progress: 'false'
                  level: Senior
                  honors:
                    - Dean's List
                  curriculum_code_type: 'null'
                  curriculum_code: 'null'
                  curriculum_name: 'null'
                  academic_summary:
                    - credit_type: SEMESTER
                      level: TOTAL
                      cumulative: 'true'
                      gpa_credits: '91'
                      attempted: '127'
                      earned: '127'
                      gpa: '3.74'
                      quality_points: '341'
                  courses:
                    - credit_basis: REGULAR_ENROLLMENT
                      honors_course: 'false'
                      repeated: 'true'
                      count_in_gpa: 'true'
                      code_type: 'null'
                      code: 'null'
                      id: CBIO 3800
                      name: Neurobiology
                      instructional_setting: REGULAR_CLASS
                      credits:
                        credit_type: SEMESTER
                        gpa_credits: '3'
                        attempted: '3'
                        earned: '3'
                        quality_points: '12'
                        grade_qualifier: 'null'
                        grade: A
                      start_date: '2018-01-04'
                      end_date: '2018-05-15'
                      other_attributes: {}
                    - credit_basis: REGULAR_ENROLLMENT
                      honors_course: 'false'
                      repeated: 'false'
                      count_in_gpa: 'null'
                      code_type: 'null'
                      code: 'null'
                      id: CBIO 3400
                      name: Cell Biology
                      instructional_setting: REGULAR_CLASS
                      credits:
                        credit_type: SEMESTER
                        gpa_credits: '3'
                        attempted: '3'
                        earned: '3'
                        quality_points: '9'
                        grade_qualifier: 'null'
                        grade: B
                      start_date: '2018-01-04'
                      end_date: '2018-05-15'
                      other_attributes: {}
                  degrees:
                    - type: BACHELORS
                      status: AWARDED
                      awarded_date: '2018-05-25'
                      description: Bachelors of Science
                      academic_summary:
                        - credit_type: SEMESTER
                          level: TOTAL
                          cumulative: 'true'
                          gpa_credits: '91'
                          attempted: '127'
                          earned: '127'
                          gpa: '3.74'
                          quality_points: '341'
                      field_of_study:
                        - type: MAJOR
                          description: Biology
                          code_type: 'null'
                          code: 'null'
                      years_of_study: '4'
                      other_attributes: {}
                  other_attributes: {}
    v3@item@new@m1_transcript_source_data_ref_remote:
      summary: Create a new Item using files on a remote location
      description: >-
        Example payload when creating a transcript file located on a remote
        server.p
      value:
        external_id: ABCDECD
        datarequest_id: dr_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datasource_id: sch_CV8e5NzZXwXhNp3TGnpryEmub2E
        source_data_type: TRANSCRIPT_FILE
        source_data:
          - referrer: USER
            source_data_reference:
              uri: >-
                sftp://john.doe:shah@examplesftp.net/path/to/directory/fileY.html
              media_type: text/html
          - referrer: USER
            source_data_reference:
              uri: >-
                https://example.com/path/to/directory/file_name.extension?query_params1&query_param_2
              media_type: text/html
              http_method: POST
              http_headers:
                authorization: bearer 863268e5-82yr-927h-33ks-h6y82548d284
                customer_header: customer_header_value
              http_body: ESCAPED%20STRING
    v3@item@new@m1_transcript_source_data_ref:
      summary: Create a new Item using an uploaded File
      description: Example payload when creating a transcript with uploaded files
      value:
        external_id: ABCDECD
        datarequest_id: dr_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datasource_id: sch_CV8e5NzZXwXhNp3TGnpryEmub2E
        source_data_type: TRANSCRIPT_FILE
        source_data:
          - referrer: USER
            source_data_reference:
              uri: m1://sdr_CaIGVqBRRpETI6fkCyUSpNHbHFo
              media_type: application/pdf
          - referrer: USER
            source_data_reference:
              uri: m1://sdr_DaKTVqBRRpEEI3fkCbUSpNHbkFm
              media_type: application/pdf
    v3@item@new@student_id:
      summary: Create a new Item for Student ID
      description: Example payload when submitting an Student ID
      value:
        individual_id: idv_2TgoxghPmhEVrEkbruJDidgSJFn
        external_id: kg
        datasource_id: sch_1valb8F35TwoPpELNaEwOwStgSt
        source_data_type: STUDENT_ID_CARD
        source_data:
          - referrer: USER
            source_data_reference:
              uri: m1://sdr_2TgowAazhEnbZj7ualAwPeVodaP
              media_type: image/jpeg
    v3@item@new@insurance_card:
      summary: Create a new Item for Insurance Card
      description: Example payload when submitting an Insurance Card
      value:
        individual_id: idv_2TgoxghPmhEVrEkbruJDidgSJFn
        datasource_id: dsr_1valb8F35TwoPpELNaEwOwStgSt
        source_data_type: INSURANCE_CARD
        source_data:
          - referrer: USER
            source_data_reference:
              uri: m1://sdr_2TgowAazhEnbZj7ualAwPeVodaP
              media_type: image/jpeg
    v3@item@new:
      summary: Successful Item created response when processing is not COMPLETED
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: IN_PROGRESS
    v3@item@new_completed:
      summary: Successful Item created response when processing is COMPLETED
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: COMPLETED
    v3@item@uploadfiles:
      summary: Upload Files
      description: Example payload when uploading item as file(s)
      value:
        files:
          - path/to/file.pdf
    v3@item@upload:
      summary: Example response payload
      value:
        - id: sdr_CaIGVqBRRpETI6fkCyUSpNHbHFo
          uri: m1://sdr_CaIGVqBRRpETI6fkCyUSpNHbHFo
          file_name: fileX.pdf
          created_at: 1561613398393
        - id: sdr_DaKTVqBRRpEEI3fkCbUSpNHbkFm
          uri: m1://sdr_DaKTVqBRRpEEI3fkCbUSpNHbkFm
          file_name: fileY.pdf
          created_at: 1566455776896
    v3@item@get_by_id:
      summary: Get Item Details
      description: Example payload for retrieving the item details
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@item@get_by_id-2:
      summary: >-
        Successful Response when processing is complete for college
        TRANSCRIPT_FILE
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        external_id: ABCDECD
        datasource_id: dts_1skdjflsoer3432ndsldfs
        datarequest_id: dr_2ILkNTtHEC0Q9dMOBnRB6oL7R69
        media_type: application/pdf
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              media_type: application/pdf
              file_name: fileX.pdf
              id: sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              created_at: 1684416793080
        source_data_type: TRANSCRIPT_FILE
        duplicates: []
        refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
        data:
          transcript_date: '2019-12-18'
          student_id: 10112ABCD
          student:
            first_name: John
            last_name: Doe
            middle_name: N.
            prefix: Mr.
            suffix: Jr.
            full_name: Doe,John N.
            former_first_name: Johnny
            former_middle_name: N.
            former_last_name: Doe
            former_full_name: Doe, Johnny N.
            former_suffix: Jr.
            former_prefix: Mr.
            date_of_birth: '1996-03-21'
            ssn: XXX-XX-3436
            email: johndoe@example.com
            address:
              addr1: 3757  Farland Avenue
              addr2: Village View Drive
              city: Liberty Center
              state: FL
              zipcode: '33901'
              country:
                name: United States
                a2_code: US
            other_attributes: {}
          previous_academic_record:
            - name: University Of California-Berkeley
              id_type: IPEDS
              id: '110635'
              address:
                addr1: 200 California Hall
                addr2: null
                city: Berkeley
                state: California
                zipcode: '94720'
                country:
                  name: United States
                  a2_code: US
              start_date: '2014-08-20'
              end_date: '2015-05-28'
              degrees:
                - type: BACHELORS
                  status: WITHDRAWN
                  awarded_date: null
                  description: Bachelors of Science
                  academic_summary:
                    - credit_type: SEMESTER
                      level: INSTITUTION
                      cumulative: true
                      gpa_credits: 27
                      attempted: 27
                      earned: 27
                      gpa: 3.6667
                      quality_points: 99
                  field_of_study:
                    - type: MAJOR
                      description: Biology
                      code_type: CIP
                      code: '26'
                  years_of_study: 1
                  other_attributes: {}
              other_attributes: {}
          transcript_institution:
            name: California State University-Bakersfield
            id_type: IPEDS
            id: '110486'
            address:
              addr1: '9001'
              addr2: Stockdale Hwy
              city: Bakersfield
              state: California
              zipcode: '93311'
              country:
                name: United States
                a2_code: US
            other_attributes:
              college: null
              campus: Bakersfield
          academic_summary:
            - credit_type: SEMESTER
              level: TOTAL
              cumulative: true
              gpa_credits: 91
              attempted: 127
              earned: 127
              gpa: 3.74
              quality_points: 341
          academic_sessions:
            - type: SEMESTER
              name: Fall 2014
              start_date: '2014-08-20'
              end_date: '2014-12-22'
              in_progress: false
              level: Freshman
              honors:
                - Dean's List
              curriculum_code_type: null
              curriculum_code: null
              curriculum_name: null
              academic_summary:
                - credit_type: SEMESTER
                  level: TOTAL
                  cumulative: true
                  gpa_credits: 0
                  attempted: 12
                  earned: 12
                  gpa: null
                  quality_points: 0
              courses:
                - credit_basis: TRANSFER
                  honors_course: false
                  repeated: false
                  count_in_gpa: null
                  code_type: null
                  code: null
                  id: ENGL 1101
                  name: English Comp I
                  instructional_setting: null
                  credits:
                    credit_type: SEMESTER
                    gpa_credits: 0
                    attempted: 3
                    earned: 3
                    quality_points: 0
                    grade_qualifier: null
                    grade: TA
                  start_date: '2014-08-20'
                  end_date: '2014-12-22'
                  other_attributes: {}
              degrees:
                - type: BACHELORS
                  status: UNKNOWN
                  awarded_date: null
                  description: Bachelors of Science
                  academic_summary:
                    - credit_type: SEMESTER
                      level: TOTAL
                      cumulative: true
                      gpa_credits: 0
                      attempted: 12
                      earned: 12
                      gpa: null
                      quality_points: 0
                  field_of_study:
                    - type: MAJOR
                      description: Biology
                      code_type: CIP
                      code: '26'
                  years_of_study: null
                  other_attributes: {}
              other_attributes: {}
            - type: SEMESTER
              name: Spring 2018
              start_date: '2018-01-04'
              end_date: '2018-05-15'
              in_progress: false
              level: Senior
              honors:
                - Dean's List
              curriculum_code_type: null
              curriculum_code: null
              curriculum_name: null
              academic_summary:
                - credit_type: SEMESTER
                  level: TOTAL
                  cumulative: true
                  gpa_credits: 91
                  attempted: 127
                  earned: 127
                  gpa: 3.74
                  quality_points: 341
              courses:
                - credit_basis: REGULAR_ENROLLMENT
                  honors_course: false
                  repeated: true
                  count_in_gpa: true
                  code_type: null
                  code: null
                  id: CBIO 3800
                  name: Neurobiology
                  instructional_setting: REGULAR_CLASS
                  credits:
                    credit_type: SEMESTER
                    gpa_credits: 3
                    attempted: 3
                    earned: 3
                    quality_points: 12
                    grade_qualifier: null
                    grade: A
                  start_date: '2018-01-04'
                  end_date: '2018-05-15'
                  other_attributes: {}
                - credit_basis: REGULAR_ENROLLMENT
                  honors_course: false
                  repeated: false
                  count_in_gpa: null
                  code_type: null
                  code: null
                  id: CBIO 3400
                  name: Cell Biology
                  instructional_setting: REGULAR_CLASS
                  credits:
                    credit_type: SEMESTER
                    gpa_credits: 3
                    attempted: 3
                    earned: 3
                    quality_points: '9'
                    grade_qualifier: null
                    grade: B
                  start_date: '2018-01-04'
                  end_date: '2018-05-15'
                  other_attributes: {}
              degrees:
                - type: BACHELORS
                  status: AWARDED
                  awarded_date: '2018-05-25'
                  description: Bachelors of Science
                  academic_summary:
                    - credit_type: SEMESTER
                      level: TOTAL
                      cumulative: true
                      gpa_credits: 91
                      attempted: 127
                      earned: 127
                      gpa: 3.74
                      quality_points: 341
                  field_of_study:
                    - type: MAJOR
                      description: Biology
                      code_type: null
                      code: null
                  years_of_study: 4
                  other_attributes: {}
              other_attributes: {}
        confidence:
          student.name: 94
          previous_academic_record.1.start_date: 63.4
          academic_sessions.1.degrees.1.name: 91
          degrees.gpa: 92
        processing_status: COMPLETED
        created_at: 1556781225343
        updated_at: 1556781257964
    v3@item@get_by_id_hs:
      summary: >-
        Successful Response when processing is complete for highschool
        TRANSCRIPT_FILE
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_2ILkNTtHEC0Q9dMOBnRB6oL7R69
        external_id: ABCDECD
        datasource_id: sch_23WF3I2AuA513DM7rbyx3nxVqE1
        media_type: application/pdf
        source_data_type: TRANSCRIPT_FILE
        duplicates: []
        refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_1KXGeat97YnOR8AHM4AZWYOAcog
              media_type: application/pdf
              file_name: fileX.pdf
              created_at: 1556781221243
        data:
          transcript_date: '2022-01-19'
          student_id: 10112ABCD
          student:
            first_name: John
            last_name: Doe
            middle_name: N.
            prefix: Mr.
            suffix: Jr.
            full_name: Doe,John N.
            former_first_name: Johnny
            former_middle_name: N.
            former_last_name: Doe
            former_full_name: Doe, Johnny N.
            former_suffix: Jr.
            former_prefix: Mr.
            date_of_birth: '1996-03-21'
            ssn: XXX-XX-3436
            email: johndoe@example.com
            address:
              addr1: 3757  Farland Avenue
              addr2: Village View Drive
              city: Liberty Center
              state: FL
              zipcode: '33901'
              country:
                name: United States
                a2_code: US
            other_attributes: {}
          pgc:
            - individual_type: PARENT_GUARDIAN
              first_name: Jane
              last_name: Doe
              middle_name: J.
              prefix: Mrs.
              full_name: Jane J. Doe
              ssn: xxx-xx-xxxx
              email: janedoe@example.com
              address:
                addr1: 3757  Farland Avenue
                addr2: Village View Drive
                city: Liberty Center
                state: FL
                zipcode: '33901'
                country:
                  name: United States
                  a2_code: US
          immunizations:
            - code: '90706'
              name: Tetanus Immunization
              date: '2015-02-22'
              status_code: Third Inoculation
              report_type_code: Health Certificate
          test_records:
            - name: SAT
              date: '2021-04-11'
              code: '803'
              subsets:
                - name: Reading Comprehension
                  score: '99'
                  score_qualifier: Percentile
          previous_academic_record:
            - name: Buffalo High School
              id_type: null
              id: null
              address:
                addr1: 29891 OLD HWY 87
                addr2: null
                city: Buffalo
                state: Wyoming
                zipcode: '82834'
                country:
                  name: United States
                  a2_code: US
              start_date: '2014-08-20'
              end_date: '2018-05-28'
              degrees:
                - type: HIGH-SCHOOL-DIPLOMA
                  status: WITHDRAWN
                  awarded_date: null
                  description: High School
                  academic_summary:
                    - credit_type: HIGHSCHOOL_CREDIT
                      level: INSTITUTION
                      cumulative: true
                      gpa_credits: 12
                      attempted: 12
                      earned: 12
                      gpa: 3.6667
                      quality_points: 44
                      student_rank: 5
                      class_size: 42
                      rank_date: '2018-01-23'
                      days_attended: 132
                      days_absent: 23
                  years_of_study: 3.5
                  other_attributes: {}
              other_attributes: {}
          transcript_institution:
            name: Bedford High School
            id_type: null
            id: null
            address:
              addr1: 330 E JOHN ST
              addr2: null
              city: Bedford
              state: Pennsylvania
              zipcode: '15522'
              country:
                name: United States
                a2_code: US
            other_attributes: {}
          academic_summary:
            - credit_type: HIGHSCHOOL_CREDIT
              level: TOTAL
              cumulative: true
              gpa_credits: 22
              attempted: 22
              earned: 22
              gpa: 3.73
              quality_points: 82.28
              student_rank: 7
              class_size: 40
              rank_date: '2022-01-10'
              days_attended: 114
              days_absent: 12
          academic_sessions:
            - type: SEMESTER
              name: Fall 2014
              start_date: '2014-08-20'
              end_date: '2014-12-22'
              in_progress: false
              level: null
              curriculum_code_type: null
              curriculum_code: null
              curriculum_name: null
              academic_summary:
                - credit_type: HIGHSCHOOL_CREDIT
                  level: TOTAL
                  cumulative: true
                  gpa_credits: 0
                  attempted: 12
                  earned: 12
                  gpa: null
                  quality_points: 0
              courses:
                - credit_basis: TRANSFER
                  honors_course: false
                  repeated: false
                  count_in_gpa: null
                  code_type: null
                  code: null
                  id: ENG9
                  name: ENGLISH 9
                  instructional_setting: null
                  credits:
                    credit_type: HIGHSCHOOL_CREDIT
                    gpa_credits: 0
                    attempted: 1
                    earned: 1
                    quality_points: 0
                    grade_qualifier: null
                    grade: TA
                  start_date: '2014-08-20'
                  end_date: '2014-12-22'
                  other_attributes: {}
              degrees:
                - type: HIGH-SCHOOL-DIPLOMA
                  status: UNKNOWN
                  awarded_date: null
                  description: High School
                  academic_summary:
                    - credit_type: HIGHSCHOOL_CREDIT
                      level: TOTAL
                      cumulative: true
                      gpa_credits: 0
                      attempted: 12
                      earned: 12
                      gpa: null
                      quality_points: 0
                  years_of_study: null
                  other_attributes: {}
              other_attributes: {}
            - type: SEMESTER
              name: Fall 2021
              start_date: '2021-08-14'
              end_date: '2022-01-10'
              in_progress: false
              curriculum_code_type: null
              curriculum_code: null
              curriculum_name: null
              academic_summary:
                - credit_type: HIGHSCHOOL_CREDIT
                  level: TOTAL
                  cumulative: true
                  gpa_credits: 22
                  attempted: 22
                  earned: 22
                  gpa: 3.73
                  quality_points: 82
                  student_rank: 7
                  class_size: 40
                  rank_date: '2022-01-10'
                  days_attended: 114
                  days_absent: 12
              courses:
                - credit_basis: REGULAR_ENROLLMENT
                  honors_course: false
                  repeated: false
                  count_in_gpa: true
                  code_type: null
                  code: null
                  id: MVUGRIB
                  name: MVU GERMAN IB
                  instructional_setting: REGULAR_CLASS
                  credits:
                    credit_type: HIGHSCHOOL_CREDIT
                    gpa_credits: 1
                    attempted: 1
                    earned: 1
                    quality_points: 3
                    grade_qualifier: null
                    grade: B
                  marks_awarded:
                    - grade_qualifier: null
                      grade: A
                      period: Six-week
                    - grade_qualifier: null
                      grade: B
                      period: Nine Weeks
                    - grade_qualifier: null
                      grade: B
                      period: Final Mark
                  start_date: '2021-08-14'
                  end_date: '2022-01-10'
                  other_attributes: {}
                - credit_basis: REGULAR_ENROLLMENT
                  honors_course: false
                  repeated: false
                  count_in_gpa: null
                  code_type: null
                  code: null
                  id: FORENSICS-B
                  name: FORENSICS/DRAMA B
                  instructional_setting: REGULAR_CLASS
                  credits:
                    credit_type: HIGHSCHOOL_CREDIT
                    gpa_credits: 1
                    attempted: 1
                    earned: 1
                    quality_points: 4
                    grade_qualifier: null
                    grade: A
                  marks_awarded:
                    - grade_qualifier: null
                      grade: A
                      period: Six-week
                    - grade_qualifier: null
                      grade: A
                      period: Nine Weeks
                    - grade_qualifier: null
                      grade: A
                      period: Final Mark
                  start_date: '2021-08-14'
                  end_date: '2022-01-10'
                  other_attributes: {}
              degrees:
                - type: HIGH-SCHOOL-DIPLOMA
                  status: AWARDED
                  awarded_date: '2022-01-12'
                  description: High School
                  academic_summary:
                    - credit_type: HIGHSCHOOL_CREDIT
                      level: TOTAL
                      cumulative: true
                      gpa_credits: 22
                      attempted: 22
                      earned: 22
                      gpa: 3.73
                      quality_points: 82
                      student_rank: 7
                      class_size: 40
                      rank_date: '2022-01-10'
                      days_attended: 114
                      days_absent: 12
                  years_of_study: 4
                  other_attributes: {}
              other_attributes: {}
        confidence:
          student.name: 94
          previous_academic_record.1.start_date: 63.4
          academic_sessions.1.degrees.1.name: 91
          degrees.gpa: 92
        processing_status: COMPLETED
        created_at: 1642629379670
        updated_at: 1642631379670
    v3@item@get_by_id_paystub_file:
      summary: Successful Response when processing is complete for PAYSTUB_FILE
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        external_id: ABCDECD
        datarequest_id: dts_1skdjflsoer3432ndsldfs
        datasource_id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        media_type: application/pdf
        source_data_type: PAYSTUB_FILE
        duplicates: []
        refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              media_type: application/pdf
              file_name: fileX.pdf
              id: sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              created_at: 1684416793080
        data:
          record_date: 08/20/2022
          pay_date: 08/20/2022
          interval:
            start_date: 08/01/2022
            end_date: 08/15/2022
          employer:
            name: MeasureOne Inc.
            phone_number: null
            address:
              addr1: 535 Mission Street
              addr2: 14th Floor
              city: San Francisco,
              state: CA
              zipcode: '94105'
              country:
                name: United States
                a2_code: US
          employee:
            service_details:
              employee_id: '001234'
              hire_date: 03/21/2019
              status: ACTIVE
              termination_date: null
              termination_reason: null
              salary: 73450
              salary_basis: ANNUAL
            first_name: John
            middle_name: N.
            last_name: Doe
            email: johndoe@example.com
            prefix: Mr.
            suffix: Jr.
            gender: null
            date_of_birth: 03/21/1996
            phone_number: null
            ssn: XXX-XX-3436
            address:
              addr1: 123 Measure Way
              addr2: null
              city: San Francisco ,
              state: CA
              zipcode: '93123'
              country:
                name: United States
                a2_code: US
          roles:
            - position:
                name: HR Manager
                title: Manager
              type: OTHER
              supervisor: Jane Smith
              department: 9DA1G&A
              location:
                name: MeasureOne, Inc-HQ
                address:
                  addr1: 535 Mission Street
                  addr2: 14th Floor
                  city: San Francisco,
                  state: CA
                  zipcode: '94105'
                  country:
                    name: United States
                    a2_code: US
                interval:
                  start_date: 08/01/2022
                  end_date: 08/15/2022
          earnings:
            - type: SALARY
              basis: SEMI_MONTHLY
              interval:
                start_date: 08/01/2022
                end_date: 08/15/2022
              amounts:
                - currency: USD
                  type: NET
                  ytd_flag: false
                  value: 1996
                  rate: null
                  hours: null
                - currency: USD
                  type: NET
                  ytd_flag: true
                  value: 3992
                  rate: null
                  hours: null
                - currency: USD
                  type: GROSS
                  ytd_flag: false
                  value: 2623.25
                  rate: null
                  hours: null
                - currency: USD
                  type: GROSS
                  ytd_flag: true
                  value: 5246.5
                  rate: null
                  hours: null
                - currency: USD
                  type: HOLIDAY
                  ytd_flag: false
                  value: 0
                  rate: 16.769
                  hours: 0
                - currency: USD
                  type: HOLIDAY
                  ytd_flag: true
                  value: 0
                  rate: null
                  hours: null
                - currency: USD
                  type: REGULAR
                  ytd_flag: false
                  value: 2623.25
                  rate: 0
                  hours: 0
                - currency: USD
                  type: REGULAR
                  ytd_flag: true
                  value: 5246.5
                  rate: null
                  hours: null
          deductions:
            - type: OTHER
              amounts:
                - currency: USD
                  type: STATE
                  ytd_flag: false
                  value: 135.71
                - currency: USD
                  type: STATE
                  ytd_flag: true
                  value: 271.42
                - currency: USD
                  type: STATE
                  ytd_flag: false
                  value: 75
                - currency: USD
                  type: STATE
                  ytd_flag: true
                  value: 150
                - currency: USD
                  type: FEDERAL
                  ytd_flag: false
                  value: 285.91
                - currency: USD
                  type: FEDERAL
                  ytd_flag: true
                  value: 571.82
                - currency: USD
                  type: FEDERAL
                  ytd_flag: false
                  value: 21.46
                - currency: USD
                  type: FEDERAL
                  ytd_flag: true
                  value: 92.42
                - currency: USD
                  type: FEDERAL
                  ytd_flag: false
                  value: 94.17
                - currency: USD
                  type: FEDERAL
                  ytd_flag: true
                  value: 188.34
                - currency: USD
                  type: OTHER
                  ytd_flag: false
                  value: 612.25
                - currency: USD
                  type: OTHER
                  ytd_flag: true
                  value: 1224.5
              interval:
                start_date: 08/01/2022
                end_date: 08/15/2022
          benefits:
            - type: OTHER
              amounts:
                - currency: USD
                  type: LIFE
                  ytd_flag: false
                  value: 2.66
                - currency: USD
                  type: LIFE
                  ytd_flag: true
                  value: 2.66
                - currency: USD
                  type: OTHER
                  ytd_flag: false
                  value: 172.5
                - currency: USD
                  type: OTHER
                  ytd_flag: true
                  value: 172.5
                - currency: USD
                  type: OTHER
                  ytd_flag: false
                  value: 15.65
                - currency: USD
                  type: OTHER
                  ytd_flag: true
                  value: 15.65
              interval:
                start_date: 08/01/2022
                end_date: 08/15/2022
        confidence: null
        processing_status: COMPLETED
        created_at: 1684416793226
        updated_at: 1684416806183
    v3@item@get_by_id_insurance:
      summary: Successful Response when processing is complete for INSURANCE_POLICY
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3Rc
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dts_1skdjflsoer3432ndsldfs
        external_id: ABCDECD
        datasource_id: insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
        media_type: application/pdf
        source_data_type: INSURANCE_POLICY
        duplicates: []
        refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              media_type: application/pdf
              file_name: fileX.pdf
              id: sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              created_at: 1684416793080
        data:
          record_date: 09/15/2021
          policy_number: '000000000'
          payment_frequency: ANNUAL
          as_of_date: 06/16/2023
          coverage_period:
            start_date: 10/25/2021
            end_date: 10/25/2022
          premium_amount:
            currency: USD
            amount: 4372
          policy_holders:
            - name: John Doe
              phone_number: null
              address:
                addr1: 000 John Street
                addr2: null
                city: San Francisco
                state: CA
                zipcode: 94123-1515
                country:
                  a2_code: null
                  name: null
            - name: Jane Doe
              phone_number: null
              address:
                addr1: 000 John Street
                addr2: null
                city: San Francisco
                state: CA
                zipcode: 94123-1515
                country:
                  a2_code: null
                  name: null
          insurance_provider:
            name: Encompass Insurance Company
            phone_number: null
            address:
              addr1: 2775 Sanders Rd.
              addr2: null
              city: Northbrook
              state: IL
              zipcode: 60062-6127
              country:
                a2_code: null
                name: null
          insurance_agent:
            name: Sadler & Company Ins Brokers, Inc
            phone_number: (707) 595-1182
            address:
              addr1: 902 Stevenson St
              addr2: null
              city: Santa Rosa
              state: CA
              zipcode: 95404-5108
              country:
                a2_code: null
                name: null
          remit_to: null
          coverages:
            - type: HOME
              premium_amount:
                currency: USD
                amount: 1115
              details:
                property_info:
                  name: 000 John Street, San Francisco, CA 94123
                  phone_number: null
                  address:
                    addr1: 000 John Street
                    addr2: null
                    city: San Francisco
                    state: CA
                    zipcode: '94123'
                    country:
                      a2_code: null
                      name: null
                  interested_parties:
                    - name: FIRST REPUBLIC BANK ITS SUCCESSORS &/OR ASSIGNS
                      phone_number: null
                      address:
                        addr1: P O Box 790869
                        addr2: null
                        city: San Antonio
                        state: TX
                        zipcode: 78279-0869
                        country:
                          a2_code: null
                          name: null
                      type: FIRST_MORTGAGEE
                      loan_number: 11-0000000
                coverage_items:
                  - name: Property Location Limit (PLL)*
                    type: DWELLING
                    x12_info:
                      code: Dwell
                      desc: Dwelling
                    premium_amount:
                      currency: USD
                      amount: 1115
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 188609
                          currency: USD
                    deductibles:
                      - type: AMOUNT
                        value:
                          amount: 1000
                          currency: USD
                  - name: Your Tangible Personal Property
                    type: PERSONAL_PROPERTY
                    x12_info:
                      code: PP
                      desc: Personal Property
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 80554
                          currency: USD
                    deductibles: []
                  - name: Your Building Additions and Alterations
                    type: BUILDING_ADDITIONS_ALTERATIONS
                    x12_info:
                      code: BAA
                      desc: Building Additions & Alterations
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 108055
                          currency: USD
                    deductibles: []
                  - name: Building Ordinance Increased Costs
                    type: BUILDING_ORDINANCE
                    x12_info:
                      code: BOLAW
                      desc: Building Ordinance or Law Coverage
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 56583
                          currency: USD
                    deductibles: []
                  - name: Loss Assessment
                    type: LOSS_ASSESSMENT
                    x12_info:
                      code: LAC
                      desc: Loss Assessment
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 50000
                          currency: USD
                    deductibles: []
                  - name: Identity Fraud Expense Coverage
                    type: IDENTITY_FRAUD
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: PER_ENDORSEMENT
                        value: null
                    deductibles: []
                  - name: Personal Liability
                    type: PERSONAL_LIABILITY
                    x12_info:
                      code: PPTC
                      desc: Personal Liability
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 500000
                          currency: USD
                    deductibles: []
                  - name: Personal Liability - Mold, Fungus, Wet Rot
                    type: ADDITIONAL_PREMISES_LIABILITY_EXTENSION
                    x12_info:
                      code: ADDRL
                      desc: Additional Premises Liability Extension
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 50000
                          currency: USD
                    deductibles: []
                  - name: Medical Expenses
                    type: MEDICAL_PAYMENTS
                    x12_info:
                      code: MEDPM
                      desc: Medical Payments
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 10000
                          currency: USD
                    deductibles: []
                  - name: Workers' Compensation Coverage
                    type: WORKERS_COMPENSATION
                    x12_info:
                      code: WCFIN
                      desc: Workers Compensation - Full Time Inservant
                    premium_amount: null
                    limits:
                      - type: PER_ENDORSEMENT
                        value: null
                    deductibles: []
            - type: AUTO
              premium_amount:
                currency: USD
                amount: 1429
              details:
                vehicle_info:
                  vin: SALA0000000000
                  make: Land Rover
                  year: 2013
                  model: LR4
                  brand: null
                  fuel_type: null
                  transmission_type: null
                  yearly_mileage:
                    type: VALUE
                    details:
                      unit: MI
                      value: 13500
                  current_mileage: null
                  interested_parties: []
                  usage_type: null
                drivers:
                  - first_name: John
                    middle_name: null
                    last_name: Doe
                    full_name: John Doe
                    email: null
                    prefix: null
                    suffix: null
                    gender: null
                    ssn: null
                    date_of_birth: 10/XX/1967
                    phone_number: null
                    marital_status: null
                    nationality: null
                    driving_license: null
                    date_licensed: 10/XX/1983
                    address: null
                  - first_name: Jane
                    middle_name: null
                    last_name: Doe
                    full_name: Jane Doe
                    email: null
                    prefix: null
                    suffix: null
                    gender: null
                    ssn: null
                    date_of_birth: 01/XX/1969
                    phone_number: null
                    marital_status: null
                    nationality: null
                    driving_license: null
                    date_licensed: 01/XX/1986
                    address: null
                coverage_items:
                  - name: Bodily Injury
                    type: BODILY_INJURY
                    x12_info:
                      code: BI
                      desc: Bodily Injury Liability
                    premium_amount:
                      currency: USD
                      amount: 460
                    limits:
                      - type: PER_PERSON
                        value:
                          amount: 250000
                          currency: USD
                      - type: PER_ACCIDENT
                        value:
                          amount: 500000
                          currency: USD
                    deductibles: []
                  - name: Property Damage
                    type: PROPERTY_DAMAGE
                    x12_info:
                      code: PD
                      desc: Property Damage- Single Limit
                    premium_amount:
                      currency: USD
                      amount: 269
                    limits:
                      - type: PER_ACCIDENT
                        value:
                          amount: 100000
                          currency: USD
                    deductibles: []
                  - name: Medical Expense
                    type: MEDICAL_PAYMENTS
                    x12_info:
                      code: MEDPM
                      desc: Medical Payments
                    premium_amount:
                      currency: USD
                      amount: 30
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 5000
                          currency: USD
                    deductibles: []
                  - name: Funeral Expense
                    type: FUNERAL_EXPENSE_BENEFITS
                    x12_info:
                      code: FEB
                      desc: Funeral Expense Benefits
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 5000
                          currency: USD
                    deductibles: []
                  - name: Bodily Injury - Uninsured Motorists
                    type: UNINSURED_MOTORIST_BODILY_INJURY
                    x12_info:
                      code: UMISG
                      desc: Uninsured Motorist BI Single Limit
                    premium_amount:
                      currency: USD
                      amount: 74
                    limits:
                      - type: PER_PERSON
                        value:
                          amount: 250000
                          currency: USD
                      - type: PER_ACCIDENT
                        value:
                          amount: 500000
                          currency: USD
                    deductibles: []
                  - name: Collision Deductible Waiver - Uninsured Motorists
                    type: UNINSURED_MOTORIST_BODILY_INJURY
                    x12_info:
                      code: UMISG
                      desc: Uninsured Motorist BI Single Limit
                    premium_amount:
                      currency: USD
                      amount: 27
                    limits:
                      - type: PER_ENDORSEMENT
                        value: null
                    deductibles: []
                  - name: Comprehensive
                    type: COMPREHENSIVE_COVERAGE
                    x12_info:
                      code: COMP
                      desc: Comprehensive Coverage
                    premium_amount:
                      currency: USD
                      amount: 237
                    limits: []
                    deductibles:
                      - type: AMOUNT
                        value:
                          amount: 250
                          currency: USD
                  - name: Collision
                    type: COLLISION_COVERAGE
                    x12_info:
                      code: COLL
                      desc: Collision Coverage
                    premium_amount:
                      currency: USD
                      amount: 288
                    limits: []
                    deductibles:
                      - type: AMOUNT
                        value:
                          amount: 1000
                          currency: USD
                  - name: Witness Expense Reimbursement
                    type: WITNESS_EXPENSE
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: PER_POLICY
                        value: null
                    deductibles: []
                  - name: Reward Coverage
                    type: REWARD_COVERAGE
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: PER_POLICY
                        value: null
                    deductibles: []
                  - name: Cost of Preparing Proof of Loss
                    type: PROOF_OF_LOSS
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 2500
                          currency: USD
                    deductibles: []
                  - name: Loss of Use
                    type: LOSS_OF_USE
                    x12_info:
                      code: LUSE
                      desc: Loss of Use
                    premium_amount: null
                    limits:
                      - type: TEXT
                        value: Included
                    deductibles: []
                  - name: Custom Parts or Equipment
                    type: CUSTOM_PARTS_EQUIPMENTS
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 1000
                          currency: USD
                    deductibles:
                      - type: TEXT
                        value: Comprehensive or Collision
                  - name: Towing
                    type: TOWING_AND_LABOR
                    x12_info:
                      code: TL
                      desc: Towing and Labor
                    premium_amount: null
                    limits:
                      - type: REASONABLE_EXPENSE
                        value: null
                    deductibles: []
                  - name: Rental Reimbursement
                    type: RENTAL_REIMBURSEMENT
                    x12_info:
                      code: RREIM
                      desc: Rental Reimbursement
                    premium_amount:
                      currency: USD
                      amount: 44
                    limits:
                      - type: PER_DAY
                        value:
                          amount: 100
                          currency: USD
                      - type: MAXIMUM
                        value:
                          amount: 3000
                          currency: USD
                    deductibles: []
                  - name: Trip Interruption
                    type: WORK_LOSS_BENEFITS
                    x12_info:
                      code: WLB
                      desc: Work Loss Benefits
                    premium_amount: null
                    limits:
                      - type: PER_DAY
                        value:
                          amount: 100
                          currency: USD
                      - type: MAXIMUM
                        value:
                          amount: 500
                          currency: USD
                    deductibles: []
                  - name: Emergency Transportation
                    type: EMERGENCY_TRANSPORTATION
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 20
                          currency: USD
                    deductibles: []
            - type: AUTO
              premium_amount:
                currency: USD
                amount: 1612
              details:
                vehicle_info:
                  vin: 5YJ3000000000
                  make: Tesla
                  year: 2021
                  model: '3'
                  brand: null
                  fuel_type: null
                  transmission_type: null
                  yearly_mileage:
                    type: VALUE
                    details:
                      unit: MI
                      value: 8000
                  current_mileage: null
                  interested_parties: []
                  usage_type: null
                drivers:
                  - first_name: John
                    middle_name: null
                    last_name: Doe
                    full_name: John Doe
                    email: null
                    prefix: null
                    suffix: null
                    gender: null
                    ssn: null
                    date_of_birth: 10/XX/1967
                    phone_number: null
                    marital_status: null
                    nationality: null
                    driving_license: null
                    date_licensed: 10/XX/1983
                    address: null
                  - first_name: Jane
                    middle_name: null
                    last_name: Doe
                    full_name: Jane Doe
                    email: null
                    prefix: null
                    suffix: null
                    gender: null
                    ssn: null
                    date_of_birth: 01/XX/1969
                    phone_number: null
                    marital_status: null
                    nationality: null
                    driving_license: null
                    date_licensed: 01/XX/1986
                    address: null
                coverage_items:
                  - name: Bodily Injury
                    type: BODILY_INJURY
                    x12_info:
                      code: BI
                      desc: Bodily Injury Liability
                    premium_amount:
                      currency: USD
                      amount: 417
                    limits:
                      - type: PER_PERSON
                        value:
                          amount: 250000
                          currency: USD
                      - type: PER_ACCIDENT
                        value:
                          amount: 500000
                          currency: USD
                    deductibles: []
                  - name: Property Damage
                    type: PROPERTY_DAMAGE
                    x12_info:
                      code: PD
                      desc: Property Damage- Single Limit
                    premium_amount:
                      currency: USD
                      amount: 244
                    limits:
                      - type: PER_ACCIDENT
                        value:
                          amount: 100000
                          currency: USD
                    deductibles: []
                  - name: Medical Expense
                    type: MEDICAL_PAYMENTS
                    x12_info:
                      code: MEDPM
                      desc: Medical Payments
                    premium_amount:
                      currency: USD
                      amount: 26
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 5000
                          currency: USD
                    deductibles: []
                  - name: Funeral Expense
                    type: FUNERAL_EXPENSE_BENEFITS
                    x12_info:
                      code: FEB
                      desc: Funeral Expense Benefits
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 5000
                          currency: USD
                    deductibles: []
                  - name: Bodily Injury - Uninsured Motorists
                    type: UNINSURED_MOTORIST_BODILY_INJURY
                    x12_info:
                      code: UMISG
                      desc: Uninsured Motorist BI Single Limit
                    premium_amount:
                      currency: USD
                      amount: 66
                    limits:
                      - type: PER_PERSON
                        value:
                          amount: 250000
                          currency: USD
                      - type: PER_ACCIDENT
                        value:
                          amount: 500000
                          currency: USD
                    deductibles: []
                  - name: Collision Deductible Waiver - Uninsured Motorists
                    type: UNINSURED_MOTORIST_BODILY_INJURY
                    x12_info:
                      code: UMISG
                      desc: Uninsured Motorist BI Single Limit
                    premium_amount:
                      currency: USD
                      amount: 27
                    limits:
                      - type: PER_ENDORSEMENT
                        value: null
                    deductibles: []
                  - name: Comprehensive
                    type: COMPREHENSIVE_COVERAGE
                    x12_info:
                      code: COMP
                      desc: Comprehensive Coverage
                    premium_amount:
                      currency: USD
                      amount: 269
                    limits: []
                    deductibles:
                      - type: AMOUNT
                        value:
                          amount: 250
                          currency: USD
                  - name: Collision
                    type: COLLISION_COVERAGE
                    x12_info:
                      code: COLL
                      desc: Collision Coverage
                    premium_amount:
                      currency: USD
                      amount: 519
                    limits: []
                    deductibles:
                      - type: AMOUNT
                        value:
                          amount: 1000
                          currency: USD
                  - name: Witness Expense Reimbursement
                    type: WITNESS_EXPENSE
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: PER_POLICY
                        value: null
                    deductibles: []
                  - name: Reward Coverage
                    type: REWARD_COVERAGE
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: PER_POLICY
                        value: null
                    deductibles: []
                  - name: Cost of Preparing Proof of Loss
                    type: PROOF_OF_LOSS
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 2500
                          currency: USD
                    deductibles: []
                  - name: Loss of Use
                    type: LOSS_OF_USE
                    x12_info:
                      code: LUSE
                      desc: Loss of Use
                    premium_amount: null
                    limits:
                      - type: TEXT
                        value: Included
                    deductibles: []
                  - name: Custom Parts or Equipment
                    type: CUSTOM_PARTS_EQUIPMENTS
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 1000
                          currency: USD
                    deductibles:
                      - type: TEXT
                        value: Comprehensive or Collision
                  - name: Towing
                    type: TOWING_AND_LABOR
                    x12_info:
                      code: TL
                      desc: Towing and Labor
                    premium_amount: null
                    limits:
                      - type: REASONABLE_EXPENSE
                        value: null
                    deductibles: []
                  - name: Rental Reimbursement
                    type: RENTAL_REIMBURSEMENT
                    x12_info:
                      code: RREIM
                      desc: Rental Reimbursement
                    premium_amount:
                      currency: USD
                      amount: 44
                    limits:
                      - type: PER_DAY
                        value:
                          amount: 100
                          currency: USD
                      - type: MAXIMUM
                        value:
                          amount: 3000
                          currency: USD
                    deductibles: []
                  - name: Trip Interruption
                    type: WORK_LOSS_BENEFITS
                    x12_info:
                      code: WLB
                      desc: Work Loss Benefits
                    premium_amount: null
                    limits:
                      - type: PER_DAY
                        value:
                          amount: 100
                          currency: USD
                      - type: MAXIMUM
                        value:
                          amount: 500
                          currency: USD
                    deductibles: []
                  - name: Emergency Transportation
                    type: EMERGENCY_TRANSPORTATION
                    x12_info: null
                    premium_amount: null
                    limits:
                      - type: AMOUNT
                        value:
                          amount: 20
                          currency: USD
                    deductibles: []
            - type: PERSONAL_UMBRELLA
              premium_amount:
                amount: 216
                currency: USD
              details:
                coverage_items:
                  - type: PERSONAL_UMBRELLA
                    x12_info:
                      code: PLC
                      desc: Personal Umbrella
                    name: Personal Umbrella coverage
                    premium_amount:
                      amount: 216
                      currency: USD
                    limits:
                      - type: PER_OCCURRENCE
                        value:
                          amount: 1000000
                          currency: USD
                      - type: AGGREGATE
                        value:
                          amount: 2000000
                          currency: USD
                    deductibles: []
        confidence: null
        processing_status: COMPLETED
        created_at: 1684416793226
        updated_at: 1684416806183
    v3@item@get_by_id_auto_insurance_claim:
      summary: >-
        Successful Response when processing is complete for  AUTO INSURANCE
        CLAIM
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3Rc
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dts_1skdjflsoer3432ndsldfs
        external_id: ABCDECD
        datasource_id: insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
        media_type: application/pdf
        source_data_type: AUTO_INSURANCE_CLAIM
        duplicates: []
        refresh_id: null
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              media_type: application/pdf
              file_name: fileX.pdf
              id: sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              created_at: 1684416793080
        data:
          record_date: 06/06/2024
          auto_insurance_claims:
            - claim_date: 05/15/2023
              claim_number: CLM123456
              policy_number: POL7891011
              vehicle_info:
                vin: 1HGBH41JXMN109186
                model: Civic
                make: Honda
                year: 2022
              policy_holders:
                - name: John Doe
                  phone_number: '+1234567890'
                  address:
                    addr1: 123 Main St
                    addr2: Apt 4B
                    city: Springfield
                    state: IL
                    zipcode: '62701'
                    country:
                      name: United States
                      a2_code: US
              insurance_provider:
                name: Good Insurance Co.
                phone_number: '+1987654321'
                address:
                  addr1: 456 Insurance Ave
                  addr2: ''
                  city: Chicago
                  state: IL
                  zipcode: '60601'
                  country:
                    name: United States
                    a2_code: US
              adjuster:
                name: Jane Smith
                phone_number: '+1123456789'
                email: jane.smith@goodinsurance.com
                address:
                  addr1: 789 Adjuster Rd
                  addr2: Suite 10
                  city: Chicago
                  state: IL
                  zipcode: '60602'
                  country:
                    name: United States
                    a2_code: US
              incident_location:
                addr1: 101 Accident St
                addr2: ''
                city: Springfield
                state: IL
                zipcode: '62702'
                country:
                  name: United States
                  a2_code: US
              claim_description: Rear-end collision at a traffic light.
              claim_disposition: OPEN
              vehicle_operator:
                first_name: John
                middle_name: A
                last_name: Doe
                full_name: John A Doe
                prefix: Mr.
                suffix: ''
                address:
                  addr1: 123 Main St
                  addr2: Apt 4B
                  city: Springfield
                  state: IL
                  zipcode: '62701'
                  country:
                    name: null
                    a2_code: null
                phone_number: '+1234567890'
                email: john.doe@example.com
                gender: Male
                nationality: American
                ssn: 123-45-6789
                date_of_birth: 03/04/1985
                marital_status: Married
                driving_license: D1234567
                date_licensed: 06/15/2001
              total_claim_paid:
                currency: USD
                amount: 5000
              claim_breakup:
                - name: Property Damage
                  type: PROPERTY_DAMAGE
                  x12_info:
                    code: PD
                    desc: Property damage claim
                  amount_claimed:
                    currency: USD
                    amount: 3000
                  deductible:
                    currency: USD
                    amount: 500
                  amount_paid:
                    currency: USD
                    amount: 2500
                  date_paid: 05/05/2024
                  paid_to: John's Auto Repair
                  disposition: CLOSED
                - name: Bodily Injury
                  type: BODILY_INJURY
                  x12_info:
                    code: BI456
                    desc: Bodily injury claim
                  amount_claimed:
                    currency: USD
                    amount: 4000
                  deductible:
                    currency: USD
                    amount: 1000
                  amount_paid:
                    currency: USD
                    amount: 2000
                  date_paid: 05/04/2024
                  paid_to: Springfield General Hospital
                  disposition: OPEN
        confidence: null
        processing_status: COMPLETED
        created_at: 1684416793226
        updated_at: 1684416806183
    v3@item@get_by_id_M1_DIGEST:
      summary: Successful Response when processing is complete for M1_DIGEST
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_2ILkNTtHEC0Q9dMOBnRB6oL7R69
        external_id: ABCDECD
        datasource_id: ds_CV8e5DmUi9CU5PcPhQuQCODEoNb
        source_data_type: M1_DIGEST
        duplicates: []
        refresh_id: rfs_1233ks2lkdw4i4j2li342podjslfu
        media_type: application/json
        source_data:
          - referrer: OTHER
            source_data_value:
              degree_type: BACHELORS
              min_grade: D
              credits_earned: 65
              cgpa: 3.3
              last_term_gpa: 3.5
              years_in_school: 2
        data:
          degree_type: BACHELORS
          years_in_school: 2
          min_grade: D
          cgpa: 3.3
          last_term_gpa: 3.5
          credits_earned: 65
        processing_status: COMPLETED
        created_at: 1556781225343
        updated_at: 1556781257964
    v3@item@get_by_id_Student_id:
      summary: Successful Response Student_ID
      value:
        item_id: itm_aski2ldk4i2312342134
        source_data_type: STUDENT_ID_CARD
        duplicates: []
        individual_id: idv_a2342342342oxhdl325
        external_id: '1234123'
        datasource_id: ds_1293sjl394942dk2834
        created_at: 12412349283
        updated_at: 12412359283
        refresh_id: null
        data:
          valid_from: 02/03/2021
          valid_upto: 02/03/2024
          student:
            student_id: 10112ABCD
            first_name: John
            last_name: Doe
            middle_name: N.
            prefix: Mr.
            suffix: Jr.
            full_name: Doe,John N.
            former_first_name: Johnny
            former_middle_name: N.
            former_last_name: Doe
            former_full_name: Doe, Johnny N.
            former_suffix: Jr.
            former_prefix: Mr.
            date_of_birth: '1996-03-21'
            govt_id:
              id: '1234556789'
              type: SSN
            email: johndoe@example.com
            phone_number: string
            address:
              addr1: 3757  Farland Avenue
              addr2: Village View Drive
              city: Liberty Center
              state: FL
              zipcode: '33901'
              country:
                name: United States
                a2_code: US
          teaching_institution:
            name: LD College
            id: C-1011
            id_type: AISHE
            address:
              addr1: ''
              addr2: ''
              city: Ahmedabad
              state: Gujarat
              zipcode: '380015'
              country:
                name: India
                a2_code: IN
          degree_awarding_institution:
            name: Gujarat University
            id: U-121
            id_type: AISHE
            address:
              addr1: ''
              addr2: ''
              city: Ahmedabad
              state: Gujarat
              zipcode: '380015'
              country:
                name: India
                a2_code: IN
          degrees:
            - description: ''
              type: BACHELORS
              field_of_study:
                - type: MAJOR
                  description: Biology
                  code_type: CIP
                  code: '26'
        confidence:
          student.name: 94
          degrees.0.description: 63.4
    v3@item@get_by_id_pending:
      summary: Successful Response when processing is pending
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        external_id: ABCDECD
        datarequest_id: dts_1skdjflsoer3432ndsldfs
        media_type: application/pdf
        datasource_id: ds_142xjvlalskdjf329sldvn3iosnc
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              media_type: application/pdf
              file_name: fileX.pdf
              id: sdr_2Py65sGTBKPgJ6nMu0PUpnC2gsx
              created_at: 1684416793080
        source_data_type: TRANSCRIPT_FILE
        duplicates: []
        refresh_id: null
        processing_status: IN_PROGRESS
        created_at: 1556781225343
        updated_at: 1556781257964
    v3@item@get_filter:
      summary: Get Items filters
      description: Example payload for items/get
      value:
        filters:
          individual_id: idv_bYxmUAKNIReDSOULxkIZ6r
        options:
          count: 20
          offset: 1
          sort_by: created_at
          sort_order: DESC
        fields:
          - id
          - created_at
          - individual_id
          - datarequest_id
          - external_id
          - media_type
          - duplicates
          - processing_status
          - source_data_type
          - data
    v3@items@get:
      summary: get list of items
      value:
        rowCount: 1
        results:
          - id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
            individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
            external_id: ABCDECD
            datarequest_id: dts_1skdjflsoer3432ndsldfs
            media_type: application/pdf
            source_data_type: PAYSTUB_FILE
            duplicates: []
            data:
              record_date: 08/20/2022
              pay_date: 08/20/2022
              interval:
                start_date: 08/01/2022
                end_date: 08/15/2022
              employer:
                name: MeasureOne Inc.
                phone_number: null
                address:
                  addr1: 535 Mission Street
                  addr2: 14th Floor
                  city: San Francisco,
                  state: CA
                  zipcode: '94105'
                  country:
                    name: United States
                    a2_code: US
              employee:
                service_details:
                  employee_id: '001234'
                  hire_date: 03/21/2019
                  status: ACTIVE
                  termination_date: null
                  termination_reason: null
                  salary: 73450
                  salary_basis: ANNUAL
                first_name: John
                middle_name: N.
                last_name: Doe
                email: johndoe@example.com
                prefix: Mr.
                suffix: Jr.
                gender: null
                date_of_birth: 03/21/1996
                phone_number: null
                ssn: XXX-XX-3436
                address:
                  addr1: 123 Measure Way
                  addr2: null
                  city: San Francisco ,
                  state: CA
                  zipcode: '93123'
                  country:
                    name: United States
                    a2_code: US
              roles:
                - position:
                    name: HR Manager
                    title: Manager
                  type: OTHER
                  supervisor: Jane Smith
                  department: 9DA1G&A
                  location:
                    name: MeasureOne, Inc-HQ
                    address:
                      addr1: 535 Mission Street
                      addr2: 14th Floor
                      city: San Francisco,
                      state: CA
                      zipcode: '94105'
                      country:
                        name: United States
                        a2_code: US
                    interval:
                      start_date: 08/01/2022
                      end_date: 08/15/2022
              earnings:
                - type: SALARY
                  basis: SEMI_MONTHLY
                  interval:
                    start_date: 08/01/2022
                    end_date: 08/15/2022
                  amounts:
                    - currency: USD
                      type: NET
                      ytd_flag: false
                      value: 1996
                      rate: null
                      hours: null
                    - currency: USD
                      type: NET
                      ytd_flag: true
                      value: 3992
                      rate: null
                      hours: null
                    - currency: USD
                      type: GROSS
                      ytd_flag: false
                      value: 2623.25
                      rate: null
                      hours: null
                    - currency: USD
                      type: GROSS
                      ytd_flag: true
                      value: 5246.5
                      rate: null
                      hours: null
                    - currency: USD
                      type: HOLIDAY
                      ytd_flag: false
                      value: 0
                      rate: 16.769
                      hours: 0
                    - currency: USD
                      type: HOLIDAY
                      ytd_flag: true
                      value: 0
                      rate: null
                      hours: null
                    - currency: USD
                      type: REGULAR
                      ytd_flag: false
                      value: 2623.25
                      rate: 0
                      hours: 0
                    - currency: USD
                      type: REGULAR
                      ytd_flag: true
                      value: 5246.5
                      rate: null
                      hours: null
              deductions:
                - type: OTHER
                  amounts:
                    - currency: USD
                      type: STATE
                      ytd_flag: false
                      value: 135.71
                    - currency: USD
                      type: STATE
                      ytd_flag: true
                      value: 271.42
                    - currency: USD
                      type: STATE
                      ytd_flag: false
                      value: 75
                    - currency: USD
                      type: STATE
                      ytd_flag: true
                      value: 150
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: false
                      value: 285.91
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: true
                      value: 571.82
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: false
                      value: 21.46
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: true
                      value: 92.42
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: false
                      value: 94.17
                    - currency: USD
                      type: FEDERAL
                      ytd_flag: true
                      value: 188.34
                    - currency: USD
                      type: OTHER
                      ytd_flag: false
                      value: 612.25
                    - currency: USD
                      type: OTHER
                      ytd_flag: true
                      value: 1224.5
                  interval:
                    start_date: 08/01/2022
                    end_date: 08/15/2022
              benefits:
                - type: OTHER
                  amounts:
                    - currency: USD
                      type: LIFE
                      ytd_flag: false
                      value: 2.66
                    - currency: USD
                      type: LIFE
                      ytd_flag: true
                      value: 2.66
                    - currency: USD
                      type: OTHER
                      ytd_flag: false
                      value: 172.5
                    - currency: USD
                      type: OTHER
                      ytd_flag: true
                      value: 172.5
                    - currency: USD
                      type: OTHER
                      ytd_flag: false
                      value: 15.65
                    - currency: USD
                      type: OTHER
                      ytd_flag: true
                      value: 15.65
                  interval:
                    start_date: 08/01/2022
                    end_date: 08/15/2022
            processing_status: COMPLETED
            created_at: 1684416793226
    v3@item@get_files:
      summary: Get files for an item
      description: Example payload for retrieving the files for an item
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@errors@405:
      summary: Method Not Allowed
      description: Example payload Method Not Allowed
      value:
        timestamp: '1585747802495'
        error_code: METHOD_NOT_ALLOWED
        error_message: Given Method not allowed
        http_code: 405
    v3@checkcodes@get:
      summary: Get checkcodes
      description: Example payload for getting the checkcodes for a session
      value:
        session_id: tls_1uffmSKQlARWA41NJS66jdrLpOM
    v3@checkcodes@get-2:
      summary: Get checkcodes
      description: Response values
      value:
        session_id: tls_1uffmSKQlARWA41NJS66jdrLpOM
        checkcodes:
          - code: CC_DUPLICATE_CREDENTIALS
            description: Credentials used in the past by one or more Individual
            context:
              data:
                - timestamp: 1624972011736
                  individual_id: idv_1ucjvy6YjPsL8abIkKpCMU6mqOF
                - timestamp: 1624971989696
                  individual_id: idv_1ucjN6PrKomAz7HFDpwigQI5IuP
    v3@services@with_service_context_id:
      value:
        service_context_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
    v3@individuals@with_transaction_id:
      value:
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
    v3@individuals@with_datarequest_id:
      value:
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
    v3@individuals@get_academic_summary:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
    v3@services@academic_accounts@academic_summary:
      summary: Academic Summary when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        academic_summary:
          - datasource:
              id: sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
              name: University of Michigan-Ann Arbor
              type: SIS
            student:
              first_name: John
              last_name: Doe
              middle_name: N.
              prefix: Mr.
              suffix: Jr.
              full_name: Doe,John N.
              former_first_name: Johnny
              former_middle_name: N.
              former_last_name: Doe
              former_full_name: Doe, Johnny N.
              former_suffix: Jr.
              former_prefix: Mr.
              date_of_birth: '1996-03-21'
              ssn: XXX-XX-3436
              email: johndoe@example.com
              address:
                addr1: 3757  Farland Avenue
                addr2: Village View Drive
                city: Liberty Center
                state: FL
                zipcode: '33901'
                country:
                  name: United States
                  a2_code: US
              other_attributes: {}
            degrees:
              - type: BACHELORS
                status: UNKNOWN
                awarded_date: null
                description: Bachelors of Science
                years_of_study: null
                majors:
                  - Marketing
                gpa_range:
                  minimum: 0
                  maximum: 10
                gpa: 3.6
                credits: 124
            attendance:
              - start_date: 1341081000000
                end_date: 1419186600000
            gpa_range:
              minimum: 0
              maximum: 10
            gpa: 3.6
            teaching_institution:
              name: MF College
              id: C-1011
              id_type: AISHE
              address:
                addr1: 37  Farland Avenue
                addr2: Village View Drive
                city: Liberty Center
                state: FL
                zipcode: '33901'
                country:
                  name: United States
                  a2_code: US
            degree_awarding_institution:
              name: XLU University
              id: U-121
              id_type: AISHE
              address:
                addr1: 357  Farland Avenue
                addr2: Village View Drive
                city: Liberty Center
                state: FL
                zipcode: '33901'
                country:
                  name: United States
                  a2_code: US
            credits: 124
            enrollment_status: ACTIVE
            as_of_date: 1586859401543
    v3@services@academic_accounts@academic_summary_acquiring:
      summary: Academic Summary when the processing is "ACQUIRING"
      description: >-
        We have received the request and system is acquiring the academic
        summary. Note that if MeasureOne system requires any intervention from
        our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@academic_accounts@academic_summary_pending:
      summary: Academic Summary when the processing is "IN_PROGRESS"
      description: >-
        We have received the request and our team is working to process the the
        academic summary.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: IN_PROGRESS
        metadata:
          report_id: REPORT
    v3@errors@422-unprocessable_other_services:
      summary: Unprocessable Entity
      description: Example payload Unprocessable Entity
      value:
        error_code: UNPROCESSABLE_ENTITY
        error_message: No items found for requested params
        reason_codes:
          - code: UNSUPPORTED_FORMAT
            description: >-
              The report could not be generated as the following items are of
              unsupported format.
            context:
              items:
                - itm_Cevp4JweIsEeNjpgAAjy2EZt3R
                - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
        timestamp: 1688121876609
        http_code: 422
    v3@individuals@get_enrollment_status_complete:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        enrollment_status:
          - enrollment_status: ACTIVE
            reason_codes:
              - code: MES_EXPLICIT_STATUS
                description: Enrollment Status explicitly available on school website
              - code: MES_VF_DAC
                description: 'Verification method: Direct school account connection'
            as_of_date: 1586859401543
            datasource_id: sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
    v3@services@get_enrollment_status_acquiring:
      description: >-
        We have received the request and system is acquiring the enrollment
        status. Note that if MeasureOne system requires any intervention from
        our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@get_enrollment_status_pending:
      description: >-
        We have received the request and our team is working to process the the
        enrollment status
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: IN_PROGRESS
        metadata:
          report_id: REPORT
    v3@analytics@get_merit_score:
      summary: Get Meritscore with transcript_id
      description: Example payload for retrieving the MeritScore
      value:
        items:
          - id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
    v3@meritscore@get:
      summary: Get MeritScore
      description: Response MeritScore for a transcript
      value:
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        'service_context_id ': trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        items:
          - id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
        meritscore:
          value: 579.16
          aa_code_1: 4
          aa_code_2: 1
          aa_code_3: 3
          version: v1.2
          reason_codes:
            - code: MMS_MERITSCORE_AVAILABLE
              description: MeritScore is available
    v3@errors@422-unprocessable@meritscore:
      summary: Unprocessable Entity
      description: Example payload Unprocessable Entity
      value:
        timestamp: 1585747802495
        error_code: UNPROCESSABLE_ENTITY
        reason_codes:
          - code: UNSUPPORTED_FORMAT
            description: >-
              The report could not be generated as the following items are of
              unsupported format.
            context:
              items:
                - itm_Cevp4JweIsEeNjpgAAjy2EZt3R
                - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
        http_code: 422
        error_message: 'Cannot generate Merit Score for Item: itm_TSEne2SSjP3GvpVrs5HLol4xor2'
    v3@analytics@get_grad_score:
      summary: Get GradScore
      description: Example payload for retrieving the GradScore
      value:
        items:
          - id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
    v3@gradscore@get:
      summary: Get GradScore
      description: Response GradScore for a transcript
      value:
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        items:
          - id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
        gradscore:
          grad_score: 698
          aa_code_1: 3
          aa_code_2: 1
          aa_code_3: 4
          version: v1.1
          reason_codes":
            - code: MGS_GRADSCORE_AVAILABLE
              description: Gradscore is available
    v3@errors@422-unprocessable@gradscore:
      summary: Unprocessable Entity
      description: Example payload Unprocessable Entity
      value:
        timestamp: 1585747802495
        error_code: UNPROCESSABLE_ENTITY
        reason_codes:
          - code: UNSUPPORTED_FORMAT
            description: >-
              The report could not be generated as the following items are of
              unsupported format.
            context:
              items:
                - itm_Cevp4JweIsEeNjpgAAjy2EZt3R
                - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
        http_code: 422
        error_message: 'Cannot generate Grad Score for Item: itm_TSEne2SSjP3GvpVrs5HLol4xor2'
    v3@item@get_by_id_digest:
      summary: Get Transcript Details
      description: Example payload for retrieving the transcript details
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@item@get_by_id_digest_complete:
      summary: Successful Response when processing is complete
      value:
        id: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        external_id: ABCDECD
        datasource_id: sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
        media_type: application/pdf
        source_data_type: TRANSCRIPT_FILE
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_1KXGeat97YnOR8AHM4AZWYOAcog
              media_type: application/pdf
              file_name: fileX.pdf
              created_at: 1556781221243
        processing_status: COMPLETED
        data:
          degree_type: BACHELORS
          years_in_school: 2
          min_grade: D
          cgpa: 3.76
          last_term_gpa: 3.52
          credits_earned: 123
        created_at: 1556781225343
        updated_at: 1556781257964
    v3@item@get_by_id_digest-2:
      summary: Successful Response when processing is pending
      value:
        id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        external_id: ABCDECD
        datasource_id: sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
        media_type: application/pdf
        source_data_type: TRANSCRIPT_FILE
        source_data:
          - referrer: OTHER
            source_data_reference:
              uri: m1://sdr_1KXGeat97YnOR8AHM4AZWYOAcog
              media_type: application/pdf
              file_name: fileX.pdf
              created_at: 1556781221243
        processing_status: IN_PROGRESS
        created_at: 1556781225343
        updated_at: 1556781257964
    v3@errors@422-unprocessable@digest:
      summary: Unprocessable Entity
      description: Example payload Unprocessable Entity
      value:
        timestamp: 1585747802495
        error_code: UNPROCESSABLE_ENTITY
        reason_codes:
          - code: UNSUPPORTED_FORMAT
            description: >-
              The report could not be generated as the following items are of
              unsupported format.
            context:
              items:
                - itm_Cevp4JweIsEeNjpgAAjy2EZt3R
                - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
        http_code: 422
        error_message: 'Cannot generate Digest for Item: itm_Cevp4Jw9CIsEeNjpgAAjy2EZt3R'
    v3@individuals@get_income_employment_details:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - emp_CGVqBRRpETI6fkCyUSpNHbHF123
    v3@services@income_summary:
      summary: Income Summary when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_summary:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            as_of_date: 1621961695927
            remitter:
              name: MeasureOne Inc.
              phone_number: null
              ein: 22-3567549
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            beneficiary:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state_name: CA
                zipcode: '98765'
                country:
                  name: US
            earnings:
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1610649000000
                interval:
                  start_date: 1609439400000
                  end_date: 1610649000000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 17.43
                  - ytd_flag: true
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 2688.09
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 149.63
                  - ytd_flag: false
                    currency: USD
                    type: GROSS
                    value: 289.56
                  - ytd_flag: true
                    currency: USD
                    type: GROSS
                    value: 3025.84
                  - ytd_flag: false
                    currency: USD
                    type: NET
                    value: 232.92
                  - ytd_flag: true
                    currency: USD
                    type: NET
                    value: 2375.57
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1612031400000
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 1330
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 30
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 280
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 52.65
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: GROSS
                    value: 1360
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: NET
                    value: 1456.73
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DRVD_EIN
                description: Employment Identification Number (ein) derived from W-2
    v3@services@income_summary_yearly:
      summary: >-
        Income Summary when the processing is "COMPLETED" and yearly earnings is
        included
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_summary:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            as_of_date: 1621961695927
            remitter:
              name: MeasureOne Inc.
              phone_number: null
              ein: 22-3567549
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            beneficiary:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state_name: CA
                zipcode: '98765'
                country:
                  name: US
            earnings:
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1610649000000
                interval:
                  start_date: 1609439400000
                  end_date: 1610649000000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1612031400000
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            yearly_earnings:
              - year: 2024
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - year: 2023
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - year: 2022
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DRVD_EIN
                description: Employment Identification Number (EIN) derived from W-2
    v3@services@income_summary_bank_income:
      summary: >-
        Income Summary when the processing is "COMPLETED" and summary generated
        from Bank Transactions
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_summary:
          - datasource:
              id: ds_2cJZjDfKdsEHTUXJA9PH09hhfNO
              type: null
              name: Plaid Income Transactions
              provider_name: Plaid Income Transactions
            as_of_date: 1707833025000
            remitter:
              name: n/a
              phone_number: null
              ein: null
              address: null
            beneficiary: null
            account_holders:
              - name: John Doe
                email: john.doe@example.com
                phone_number: null
                address:
                  addr1: 102 Main Street
                  addr2: null
                  city: Smalltown
                  state_name: CA
                  zipcode: '98765'
                  country:
                    name: US
              - name: Jane Doe
                email: jane.doe@example.com
                phone_number: null
                address:
                  addr1: 102 Main Street
                  addr2: null
                  city: Smalltown
                  state_name: CA
                  zipcode: '98765'
                  country:
                    name: US
            earnings:
              - type: WAGE
                basis: null
                pay_date: null
                interval:
                  start_date: 1704067200000
                  end_date: 1706659200000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3096
              - type: INTEREST
                basis: null
                pay_date: null
                interval:
                  start_date: 1704067200000
                  end_date: 1706659200000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3096
              - type: WAGE
                basis: null
                pay_date: null
                interval:
                  start_date: 1701388800000
                  end_date: 1703980800000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3672
            yearly_earnings: null
            reason_codes:
              - code: MIE_VF_UCB
                description: 'Verification method: User-connected bank account'
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive yearly earnings
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive an ein
    v3@services@income_summary_acquiring:
      summary: Income Summary when the processing is "ACQUIRING"
      description: >-
        We have received the request and system is acquiring the income summary.
        Note that if MeasureOne system requires any intervention from our team,
        the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasource_id:
            - emp_1pq3CGPefuL4kEh0He6mxcgrlar
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@income_summary_pending:
      summary: Income Summary when the processing is "IN_PROGRESS"
      description: >-
        We have received the request and our team is working to process the the
        income summary.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasource_id:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: IN_PROGRESS
        metadata:
          report_id: REPORT
    v3@services@employment_summary:
      summary: Employment Summary when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        employment_summary:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            as_of_date: 1621961695927
            employer:
              name: MeasureOne Inc.
              phone_number: null
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            employee:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state: CA
                zipcode: '98765'
                country:
                  name: US
              service_details:
                employee_id: '001234'
                status: ACTIVE
                termination_reason: null
                salary: 75000
                salary_basis: ANNUAL
                hire_date: 1524268800000
                termination_date: null
            roles:
              - position:
                  name: HR Manager
                  title: Manager
                type: FULL_TIME
                supervisor: null
                department: Human Resource
                location:
                  name: Head Office
                  address:
                    addr1: 17102 La-330
                    addr2: null
                    city: Abbeville
                    state_name: LA
                    zipcode: '70510'
                    country:
                      name: US
                interval:
                  start_date: 1609459200000
                  end_date: 1610668800000
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DA_ESD
                description: Employment start date directly available in source data
              - code: MIE_DA_ROLE
                description: Role information directly available in source data
              - code: MIE_DRVD_ES
                description: Employment status derived based on last pay date
    v3@services@employment_summary_acquiring:
      summary: Employment Summary when the processing is "ACQUIRING"
      description: >-
        We have received the request and system is acquiring the employment
        summary. Note that if MeasureOne system requires any intervention from
        our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasource_id:
            - emp_1pq3CGPefuL4kEh0He6mxcgrlar
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@employment_summary_pending:
      summary: Employment Summary when the processing is "IN_PROGRESS"
      description: >-
        We have received the request and our team is working to process the the
        academic summary.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasource_id:
            - emp_1pq3CGPefuL4kEh0He6mxcgrlar
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: IN_PROGRESS
        metadata:
          report_id: REPORT
    v3@services@income_employment_details:
      summary: Income Employment Details when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_employment_details:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            as_of_date: 1621961695927
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            employer:
              name: MeasureOne Inc.
              phone_number: null
              ein: 22-3567549
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            employee:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state: CA
                zipcode: '98765'
                country:
                  name: US
              service_details:
                employee_id: '001234'
                status: ACTIVE
                termination_reason: null
                salary: 75000
                salary_basis: ANNUAL
                hire_date: 1524268800000
                termination_date: null
            roles:
              - position:
                  name: HR Manager
                  title: Manager
                type: FULL_TIME
                supervisor: null
                department: Human Resource
                location:
                  name: Head Office
                  address:
                    addr1: 17102 La-330
                    addr2: null
                    city: Abbeville
                    state_name: LA
                    zipcode: '70510'
                    country:
                      name: US
                interval:
                  start_date: 1609459200000
                  end_date: 1610668800000
            earnings:
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1610649000000
                interval:
                  start_date: 1609439400000
                  end_date: 1610649000000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 1330
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 30
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 280
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 52.65
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: GROSS
                    value: 1360
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: NET
                    value: 1456.73
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1612031400000
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 17.43
                  - ytd_flag: true
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 2688.09
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 149.63
                  - ytd_flag: false
                    currency: USD
                    type: GROSS
                    value: 289.56
                  - ytd_flag: true
                    currency: USD
                    type: GROSS
                    value: 3025.84
                  - ytd_flag: false
                    currency: USD
                    type: NET
                    value: 232.92
                  - ytd_flag: true
                    currency: USD
                    type: NET
                    value: 2375.57
            deductions:
              - type: STATE_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: FEDERAL_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            benefits:
              - type: VISION
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: MEDICAL
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DA_ESD
                description: Employment start date directly available in source data
              - code: MIE_DA_ROLE
                description: Role information directly available in source data
              - code: MIE_DRVD_ES
                description: Employment status derived based on last pay date
              - code: MIE_DRVD_EIN
                description: Employment Identification Number (EIN) derived from W-2
    v3@services@income_employment_details_yearly:
      summary: >-
        Income Employment Details when the processing is "COMPLETED" and yearly
        earnings is included
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_employment_details:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            as_of_date: 1621961695927
            employer:
              name: MeasureOne Inc.
              phone_number: null
              ein: 22-3567549
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            employee:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state: CA
                zipcode: '98765'
                country:
                  name: US
              service_details:
                employee_id: '001234'
                status: ACTIVE
                termination_reason: null
                salary: 75000
                salary_basis: ANNUAL
                hire_date: 1524268800000
                termination_date: null
            roles:
              - position:
                  name: HR Manager
                  title: Manager
                type: FULL_TIME
                supervisor: null
                department: Human Resource
                location:
                  name: Head Office
                  address:
                    addr1: 17102 La-330
                    addr2: null
                    city: Abbeville
                    state_name: LA
                    zipcode: '70510'
                    country:
                      name: US
                interval:
                  start_date: 1609459200000
                  end_date: 1610668800000
            earnings:
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1610649000000
                interval:
                  start_date: 1609439400000
                  end_date: 1610649000000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1612031400000
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            yearly_earnings:
              - year: 2024
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - year: 2023
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - year: 2022
                type: SALARY
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            deductions:
              - type: STATE_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: FEDERAL_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            benefits:
              - type: VISION
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: MEDICAL
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DA_ESD
                description: Employment start date directly available in source data
              - code: MIE_DA_ROLE
                description: Role information directly available in source data
              - code: MIE_DRVD_ES
                description: Employment status derived based on last pay date
              - code: MIE_DRVD_EIN
                description: Employment Identification Number (EIN) derived from W-2
    v3@services@income_employment_details_bank_income:
      summary: >-
        Income Employment Details when the processing is "COMPLETED" and summary
        generated from Bank Transactions
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_employment_details:
          - datasource:
              id: ds_2cJZjDfKdsEHTUXJA9PH09hhfNO
              type: null
              name: Plaid Income Transactions
              provider_name: Plaid Income Transactions
            as_of_date: 1707833025000
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            employer:
              name: n/a
              phone_number: null
              ein: null
              address: null
            employee: null
            roles: null
            account_holders:
              - name: John Doe
                email: john.doe@example.com
                phone_number: null
                address:
                  addr1: 102 Main Street
                  addr2: null
                  city: Smalltown
                  state_name: CA
                  zipcode: '98765'
                  country:
                    name: US
              - name: Jane Doe
                email: jane.doe@example.com
                phone_number: null
                address:
                  addr1: 102 Main Street
                  addr2: null
                  city: Smalltown
                  state_name: CA
                  zipcode: '98765'
                  country:
                    name: US
            earnings:
              - type: WAGE
                basis: null
                pay_date: null
                interval:
                  start_date: 1704067200000
                  end_date: 1706659200000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3096
              - type: INTEREST
                basis: null
                pay_date: null
                interval:
                  start_date: 1704067200000
                  end_date: 1706659200000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3096
              - type: WAGE
                basis: null
                pay_date: null
                interval:
                  start_date: 1701388800000
                  end_date: 1703980800000
                amounts:
                  - currency: USD
                    type: OTHER
                    ytd_flag: false
                    value: 3672
            yearly_earnings: null
            deductions: null
            benefits: null
            reason_codes:
              - code: MIE_VF_UCB
                description: 'Verification method: User-connected bank account'
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive yearly earnings
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive employment status
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive employee role
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive employment start date
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive employment end date
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive an ein
    v3@services@income_employment_details_with_error:
      summary: Income Employment Details when the processing is "COMPLETED" with error
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        income_employment_details:
          - datasource:
              id: emp_1t24BlRpGDXmyM2a5CF66wMtgg0
              type: EMPLOYER
              name: MeasureOne Inc.
              provider_name: Trinet - MeasureOne Inc
            as_of_date: 1621961695927
            datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            employer:
              name: MeasureOne Inc.
              phone_number: null
              ein: 22-3567549
              address:
                addr1: 535 Mission Street
                addr2: 14th floor
                city: San Francisco
                state_name: CA
                zipcode: '94105'
                country:
                  name: United States
            employee:
              first_name: John
              middle_name: Doe
              last_name: J.
              email: john.doe@example.com
              prefix: Mr.
              suffix: Jr.
              gender: M
              date_of_birth: null
              phone_number: null
              ssn: 000-00-0000
              address:
                addr1: 102 Main Street
                addr2: null
                city: Smalltown
                state: CA
                zipcode: '98765'
                country:
                  name: US
              service_details:
                employee_id: '001234'
                status: ACTIVE
                termination_reason: null
                salary: 75000
                salary_basis: ANNUAL
                hire_date: 1524268800000
                termination_date: null
            roles:
              - position:
                  name: HR Manager
                  title: Manager
                type: FULL_TIME
                supervisor: null
                department: Human Resource
                location:
                  name: Head Office
                  address:
                    addr1: 17102 La-330
                    addr2: null
                    city: Abbeville
                    state_name: LA
                    zipcode: '70510'
                    country:
                      name: US
                interval:
                  start_date: 1609459200000
                  end_date: 1610668800000
            earnings:
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1610649000000
                interval:
                  start_date: 1609439400000
                  end_date: 1610649000000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 1330
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 30
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 280
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: OTHER
                    value: 52.65
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: GROSS
                    value: 1360
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: NET
                    value: 1456.73
              - type: SALARY
                basis: SEMI_MONTHLY
                pay_date: 1612031400000
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 17.43
                  - ytd_flag: true
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 2688.09
                  - ytd_flag: false
                    hours: null
                    rate: null
                    currency: USD
                    type: REGULAR
                    value: 149.63
                  - ytd_flag: false
                    currency: USD
                    type: GROSS
                    value: 289.56
                  - ytd_flag: true
                    currency: USD
                    type: GROSS
                    value: 3025.84
                  - ytd_flag: false
                    currency: USD
                    type: NET
                    value: 232.92
                  - ytd_flag: true
                    currency: USD
                    type: NET
                    value: 2375.57
            deductions:
              - type: STATE_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: FEDERAL_TAX
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            benefits:
              - type: VISION
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3096
              - type: MEDICAL
                interval:
                  start_date: 1610735400000
                  end_date: 1612031400000
                amounts:
                  - currency: USD
                    type: GROSS
                    ytd_flag: false
                    value: 3672
            reason_codes:
              - code: MIE_VF_DPC
                description: 'Verification method: Direct payroll account connection'
              - code: MIE_DA_ESD
                description: Employment start date directly available in source data
              - code: MIE_DA_ROLE
                description: Role information directly available in source data
              - code: MIE_DRVD_ES
                description: Employment status derived based on last pay date
              - code: MIE_DRVD_EIN
                description: Employment Identification Number (EIN) derived from W-2
          - datasource:
              id: null
              type: null
              name: null
              provider_name: null
            as_of_date: null
            datarequest_id: dr_1faOM8Q4efEWE2SBM2kLq4O34
            employer:
              name: null
              phone_number: null
              ein: null
              address:
                addr1: null
                addr2: null
                city: null
                state_name: null
                zipcode: null
                country:
                  name: null
            employee:
              first_name: null
              middle_name: null
              last_name: null
              email: null
              prefix: null
              suffix: null
              gender: null
              date_of_birth: null
              phone_number: null
              ssn: null
              address:
                addr1: null
                addr2: null
                city: null
                state: null
                zipcode: null
                country:
                  name: null
              service_details:
                employee_id: null
                status: null
                termination_reason: null
                salary: null
                salary_basis: null
                hire_date: null
                termination_date: null
            roles:
              - position:
                  name: null
                  title: null
                type: null
                supervisor: null
                department: null
                location:
                  name: null
                  address:
                    addr1: null
                    addr2: null
                    city: null
                    state_name: null
                    zipcode: null
                    country:
                      name: null
                interval:
                  start_date: null
                  end_date: null
            earnings:
              - type: null
                basis: null
                pay_date: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
              - type: null
                basis: null
                pay_date: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    hours: null
                    rate: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    currency: null
                    type: null
                    value: null
                  - ytd_flag: null
                    currency: null
                    type: null
                    value: null
            deductions:
              - type: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - currency: null
                    type: null
                    ytd_flag: null
                    value: null
              - type: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - currency: null
                    type: null
                    ytd_flag: null
                    value: null
            benefits:
              - type: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - currency: null
                    type: null
                    ytd_flag: null
                    value: null
              - type: null
                interval:
                  start_date: null
                  end_date: null
                amounts:
                  - currency: null
                    type: null
                    ytd_flag: null
                    value: null
            reason_codes:
              - code: MIE_INSUFFICIENT_DATA
                description: Insufficient information to derive summary
    v3@services@income_employment_details_acquiring:
      summary: Income Employment Details when the processing is "ACQUIRING"
      description: >-
        We have received the request and system is acquiring the income and
        employment details. Note that if MeasureOne system requires any
        intervention from our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasource_id:
            - emp_1t24BlRpGDXmyM2a5CF66wMtgg0
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@income_employment_details_pending:
      summary: Income Employment Details when the processing is "IN_PROGRESS"
      description: >-
        We have received the request and our team is working to process the the
        income employment details.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - sch_CaIGVqBRRpETI6fkCyUSpNHbHFo
            - sch_CGVqBRRpETI6fkCyUSpNHbHF123
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        processing_status: IN_PROGRESS
        metadata:
          report_id: REPORT
    v3@individuals@get_insurance_details:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
    v3@services@insurance_details:
      summary: Insurance Details when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        insurance_details:
          - datasource:
              id: insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
              name: Encompass Insurance
              type: INSURANCE_PROVIDER
            as_of_date: 1652832000000
            policy_number: '000000000'
            status: ACTIVE
            policy_types:
              - AUTO
              - HOME
              - PERSONAL_UMBRELLA
            premium_amount:
              amount: 4372
              currency: USD
            payment_frequency: ANNUAL
            coverage_period:
              start_date: 1635120000000
              end_date: 1666656000000
            policy_holders:
              - name: John Doe
                phone_number: null
                address:
                  addr1: 000 John Street
                  addr2: null
                  city: San Francisco
                  state: CA
                  zipcode: 94123-1515
                  country:
                    name: null
                    a2_code: null
              - name: Jane Doe
                phone_number: null
                address:
                  addr1: 000 John Street
                  addr2: null
                  city: San Francisco
                  state: CA
                  zipcode: 94123-1515
                  country:
                    name: null
                    a2_code: null
            insurance_provider:
              name: Encompass Insurance Company
              phone_number: null
              address:
                addr1: 2775 Sanders Rd.
                addr2: null
                city: Northbrook
                state: IL
                zipcode: 60062-6127
                country:
                  name: null
                  a2_code: null
            remit_to:
              name: Encompass Insurance Company
              phone_number: null
              address:
                addr1: 2775 Sanders Rd.
                addr2: null
                city: Northbrook
                state: IL
                zipcode: 60062-6127
                country:
                  name: null
                  a2_code: null
            insurance_agent:
              name: Sadler & Company Ins Brokers, Inc
              phone_number: (707) 595-1182
              address:
                addr1: 902 Stevenson St
                addr2: null
                city: Santa Rosa
                state: CA
                zipcode: 95404-5108
                country:
                  name: null
                  a2_code: null
            coverages:
              - type: HOME
                premium_amount:
                  amount: 1115
                  currency: USD
                details:
                  coverage_items:
                    - deductibles:
                        - type: AMOUNT
                          value:
                            amount: 1000
                            currency: USD
                      limits:
                        - type: AMOUNT
                          value:
                            amount: 188609
                            currency: USD
                      name: Property Location Limit (PLL)*
                      premium_amount:
                        amount: 1115
                        currency: USD
                      type: DWELLING
                      x12_info:
                        code: Dwell
                        desc: Dwelling
                    - deductibles: []
                      limits:
                        - type: AMOUNT
                          value:
                            amount: 80554
                            currency: USD
                      name: Your Tangible Personal Property
                      premium_amount: null
                      type: PERSONAL_PROPERTY
                      x12_info:
                        code: PP
                        desc: Personal Property
                    - deductibles: []
                      limits:
                        - type: AMOUNT
                          value:
                            amount: 108055
                            currency: USD
                      name: Your Building Additions and Alterations
                      premium_amount: null
                      type: BUILDING_ADDITIONS_ALTERATIONS
                      x12_info:
                        code: BAA
                        desc: Building Additions & Alterations
                  property_info:
                    address:
                      addr1: 000 John Street
                      addr2: null
                      city: San Francisco
                      country:
                        a2_code: null
                        name: null
                      state: CA
                      zipcode: '94123'
                    interested_parties:
                      - address:
                          addr1: P O Box 790869
                          addr2: null
                          city: San Antonio
                          country:
                            a2_code: null
                            name: null
                          state: TX
                          zipcode: 78279-0869
                        loan_number: 11-0000000
                        name: FIRST REPUBLIC BANK ITS SUCCESSORS &/OR ASSIGNS
                        phone_number: null
                        type: FIRST_MORTGAGEE
                    name: 000 John Street, San Francisco, CA 94123
              - type: AUTO
                premium_amount:
                  amount: 1612
                  currency: USD
                details:
                  drivers:
                    - address: null
                      date_licensed: 10/XX/1983
                      date_of_birth: 10/XX/1967
                      driving_license: null
                      email: null
                      first_name: John
                      full_name: John Doe
                      gender: null
                      last_name: Doe
                      marital_status: null
                      merital_status: null
                      middle_name: null
                      nationality: null
                      phone_number: null
                      prefix: null
                      ssn: null
                      suffix: null
                  vehicle_info:
                    vin: 5YJ3000000000
                    garaging_address:
                      addr1: 456 Elm Street
                      addr2: Garage B
                      city: Los Angeles
                      state: CA
                      zipcode: '90001'
                      country:
                        name: United States
                        a2_code: US
                    current_mileage:
                      type: VALUE
                      details:
                        range: 8400
                        unit: MI
                    fuel_type: null
                    model: 2021 Jeep 3
                    make: JEEP
                    year: 2021
                    transmission_type: null
                    yearly_mileage:
                      type: RANGE
                      details:
                        range: 8000 or greater
                        unit: MI
                    usage_type: PERSONAL
                    interested_parties:
                      - address:
                          addr1: P O Box 790869
                          addr2: null
                          city: San Antonio
                          country:
                            a2_code: null
                            name: null
                          state: TX
                          zipcode: 78279-0869
                        loan_number: 11-0000012
                        name: FIRST REPUBLIC BANK ITS SUCCESSORS &/OR ASSIGNS
                        phone_number: null
                        type: LIEN_HOLDER
                  coverage_items:
                    - deductibles: []
                      limits:
                        - type: PER_PERSON
                          value:
                            amount: 250000
                            currency: USD
                        - type: PER_ACCIDENT
                          value:
                            amount: 500000
                            currency: USD
                      name: Bodily Injury
                      premium_amount:
                        amount: 417
                        currency: USD
                      type: BODILY_INJURY
                      x12_info:
                        code: BI
                        desc: Bodily Injury Liability
                    - deductibles: []
                      limits:
                        - type: PER_ACCIDENT
                          value:
                            amount: 100000
                            currency: USD
                      name: Property Damage
                      premium_amount:
                        amount: 244
                        currency: USD
                      type: PROPERTY_DAMAGE
                      x12_info:
                        code: PD
                        desc: Property Damage- Single Limit
                    - deductibles: []
                      limits:
                        - type: AMOUNT
                          value:
                            amount: 5000
                            currency: USD
                      name: Medical Expense
                      premium_amount:
                        amount: 26
                        currency: USD
                      type: MEDICAL_PAYMENTS
                      x12_info:
                        code: MEDPM
                        desc: Medical Payments
              - type: PERSONAL_UMBRELLA
                premium_amount:
                  amount: 216
                  currency: USD
                details:
                  coverage_items:
                    - type: PERSONAL_UMBRELLA
                      x12_info:
                        code: PLC
                        desc: Personal Umbrella
                      name: Personal Umbrella coverage
                      premium_amount:
                        amount: 216
                        currency: USD
                      limits:
                        - type: PER_OCCURRENCE
                          value:
                            amount: 1000000
                            currency: USD
                        - type: AGGREGATE
                          value:
                            amount: 2000000
                            currency: USD
                      deductibles: []
            reference_items:
              - itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
              - itm_1ajjH2BEyAY9JwPYgTY7kdg60v0
              - itm_1aJKUKDmU4MDfqlujB0ENJVNxf3
            reason_codes:
              - code: MID_VF_DAC
                description: >-
                  Verification method: Direct insurance provider account
                  connection
    v3@services@insurance_details_acquiring:
      summary: Insurance details when the processing is "ACQUIRING"
      description: >
        We have received the request and system is acquiring the insurance
        details. Note that if MeasureOne system requires any intervention from
        our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@services@insurance_status:
      summary: Insurance Status when the processing is "COMPLETED"
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        insurance_status:
          - datasource:
              id: insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
              name: Encompass Insurance
              type: INSURANCE_PROVIDER
            as_of_date: 1652832000000
            policy_number: '000000000'
            status: ACTIVE
            coverage_period:
              start_date: 1635120000000
              end_date: 1666656000000
            policy_holders:
              - name: John Doe
                phone_number: null
                address:
                  addr1: 000 John Street
                  addr2: null
                  city: San Francisco
                  state: CA
                  zipcode: 94123-1515
                  country:
                    name: null
                    a2_code: null
              - name: Jane Doe
                phone_number: null
                address:
                  addr1: 000 John Street
                  addr2: null
                  city: San Francisco
                  state: CA
                  zipcode: 94123-1515
                  country:
                    name: null
                    a2_code: null
            insurance_provider:
              name: Encompass Insurance Company
              phone_number: null
              address:
                addr1: 2775 Sanders Rd.
                addr2: null
                city: Northbrook
                state: IL
                zipcode: 60062-6127
                country:
                  name: null
                  a2_code: null
            policy_types:
              - AUTO
            reference_items:
              - itm_1aJJylkh6Ov9ANpoxd9p0wpEfrq
            reason_codes:
              - code: MID_VF_DAC
                description: >-
                  Verification method: Direct insurance provider account
                  connection
              - code: MID_DRVD_STATUS
                description: >-
                  Verification method: Direct insurance provider account
                  connection
    v3@services@insurance_status_acquiring:
      summary: Insurance status when the processing is "ACQUIRING"
      description: >
        We have received the request and system is acquiring the insurance
        status. Note that if MeasureOne system requires any intervention from
        our team, the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - insr_24xPR8HxtMDWD5fYVWPcZVcLSXA
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@individuals@get_realized_gains:
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - brk_24xPR8HxtMDWD5fYVWPcZVcLSXA
          account_numbers:
            - '1000021'
            - '1000022'
          tax_years:
            - 2021
    v3@services@realized_gains:
      summary: Realized Gains when the processing is "COMPLETED"
      description: Response for Realized Gains
      value:
        individual:
          individual_id: idv_2IV5pi1ET498VBaEc5yN7fzHlir
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_2IV5sn1GPCqGhUnXf1LgH4kSBZg
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: COMPLETED
        metadata:
          report_id: REPORT
        realized_gains:
          - datasource:
              id: brk_1valb560LsKFCUhp0MIlxkQODGh
              name: E-Trade
              type: BROKERAGE_ACCOUNT
            recipient:
              name: Maya Smith
              tin: '***−**−0000'
              address:
                addr1: 00001 Measure Way
                addr2: null
                city: San Francisco
                state: CA
                zipcode: '93123'
                country:
                  name: null
                  a2_code: null
              phone_number: null
            payer:
              name: E*TRADE SECURITIES LLC
              tin: 35−2167612
              address:
                addr1: PO BOX 484
                addr2: null
                city: JERSEY CITY
                state: NJ
                zipcode: 07303−0484
                country:
                  name: null
                  a2_code: null
              phone_number: 800 387 2331
            transactions:
              - proceeds:
                  value: 5142.92
                  currency: USD
                cost:
                  value: 6907.11
                  currency: USD
                gain:
                  value: -1764.19
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 300
                asset_details:
                  type: SECURITY
                  description: '***CARNIVAL CORP COMMON PAIRED STOCK'
                  cusip: '143658300'
                  ticker: null
                acquired_date: 1591660800000
                sell_date: 1592784000000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 2540.88
                  currency: USD
                cost:
                  value: 3165.78
                  currency: USD
                gain:
                  value: -624.9
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 12
                asset_details:
                  type: SECURITY
                  description: DOCUSIGN INC COMMON STOCK
                  cusip: '256163106'
                  ticker: null
                acquired_date: 1599004800000
                sell_date: 1604880000000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 7735.28
                  currency: USD
                cost:
                  value: 8990.34
                  currency: USD
                gain:
                  value: -1255.06
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 300
                asset_details:
                  type: SECURITY
                  description: SLACK TECHNOLOGIES INC CLASS A COMMON STOCK
                  cusip: 83088V102
                  ticker: null
                acquired_date: 1589846400000
                sell_date: 1599696000000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 3058.59
                  currency: USD
                cost:
                  value: 1259.33
                  currency: USD
                gain:
                  value: 1799.26
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 2
                asset_details:
                  type: SECURITY
                  description: CALL LOGI LOGITECH INTERNATIONAL SA
                  cusip: '8548904'
                  ticker: null
                acquired_date: 1598832000000
                sell_date: 1607990400000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 3058.6
                  currency: USD
                cost:
                  value: 1275.33
                  currency: USD
                gain:
                  value: 1783.27
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 2
                asset_details:
                  type: SECURITY
                  description: CALL LOGI LOGITECH INTERNATIONAL SA
                  cusip: '8548904'
                  ticker: null
                acquired_date: 1598832000000
                sell_date: 1607990400000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 0
                  currency: USD
                cost:
                  value: 1622
                  currency: USD
                gain:
                  value: -1622
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 3
                asset_details:
                  type: SECURITY
                  description: CALL MSFT MICROSOFT CORP
                  cusip: 8PFLYB0
                  ticker: null
                acquired_date: 1595376000000
                sell_date: 1595548800000
                additional_information: EXPIRATION
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 0
                  currency: USD
                cost:
                  value: 540.67
                  currency: USD
                gain:
                  value: -540.67
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 1
                asset_details:
                  type: SECURITY
                  description: CALL MSFT MICROSOFT CORP
                  cusip: 8PFLYB0
                  ticker: null
                acquired_date: 1595376000000
                sell_date: 1595548800000
                additional_information: EXPIRATION
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 203.32
                  currency: USD
                cost:
                  value: 0
                  currency: USD
                gain:
                  value: 203.32
                  currency: USD
                gain_type: SHORT_TERM
                quantity_sold: 1
                asset_details:
                  type: SECURITY
                  description: CALL BA BOEING CO
                  cusip: 9PBBLY4
                  ticker: null
                acquired_date: 1591920000000
                sell_date: 1591660800000
                additional_information: EXPIRATION
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 2133.84
                  currency: USD
                cost:
                  value: 4028.99
                  currency: USD
                gain:
                  value: -1895.15
                  currency: USD
                gain_type: LONG_TERM
                quantity_sold: 100
                asset_details:
                  type: SECURITY
                  description: ISHARES INTERNATIONAL SELECT DIVIDEND ETF
                  cusip: '464288448'
                  ticker: null
                acquired_date: 1401235200000
                sell_date: 1584316800000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 31817.81
                  currency: USD
                cost:
                  value: 14405.49
                  currency: USD
                gain:
                  value: 17412.32
                  currency: USD
                gain_type: LONG_TERM
                quantity_sold: 150
                asset_details:
                  type: SECURITY
                  description: LENDINGTREE INC NEW COM
                  cusip: 52603B107
                  ticker: null
                acquired_date: 1445558400000
                sell_date: 1584316800000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 24653.44
                  currency: USD
                cost:
                  value: 19164.99
                  currency: USD
                gain:
                  value: 5488.45
                  currency: USD
                gain_type: LONG_TERM
                quantity_sold: 100
                asset_details:
                  type: SECURITY
                  description: SPDR S&P 500 ETF TRUST
                  cusip: 78462F103
                  ticker: null
                acquired_date: 1401235200000
                sell_date: 1584316800000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              - proceeds:
                  value: 13.24
                  currency: USD
                cost:
                  value: 44.32
                  currency: USD
                gain:
                  value: -31.08
                  currency: USD
                gain_type: LONG_TERM
                quantity_sold: 0
                asset_details:
                  type: SECURITY
                  description: '***HSBC HOLDINGS PLC SPONSORED ADR'
                  cusip: '404280406'
                  ticker: null
                acquired_date: 1200528000000
                sell_date: 1591747200000
                additional_information: null
                proceed_type: GROSS
                basis_reported_to_irs: false
                non_covered_security: false
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
            totals:
              short_term_gains:
                proceeds:
                  value: 21739.59
                  currency: USD
                cost:
                  value: 23760.56
                  currency: USD
                gain:
                  value: -2020.97
                  currency: USD
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
              long_term_gains:
                proceeds:
                  value: 58618.33
                  currency: USD
                cost:
                  value: 37643.79
                  currency: USD
                gain:
                  value: 20974.54
                  currency: USD
                accrued_market_discount:
                  value: 0
                  currency: USD
                wash_sale_disallowed:
                  value: 0
                  currency: USD
            as_of_date: 1609372800000
            fatca_filing_requirement: false
            account_number: '00000000'
            reason_codes:
              - code: MRG_VF_DAC
                description: 'Verification method: Direct brokerage account connection'
    v3@services@realized_gains_acquiring:
      summary: Realized Gains when the processing is "ACQUIRING"
      description: >-
        We have received the request and system is acquiring the realized gains.
        Note that if MeasureOne system requires any intervention from our team,
        the status will update to IN_PROGRESS.
      value:
        individual:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
          datasources:
            - brk_24xPR8HxtMDWD5fYVWPcZVcLSXA
        datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        transaction_id: trx_1fGUhrSFQ1L4Jd2rOeQiHQgt986
        service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
        processing_status: ACQUIRING
        metadata:
          report_id: REPORT
    v3@authentication@generate_access_token:
      summary: Access token
      description: Response Access token
      value:
        access_token: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
        token_type: bearer
        expires_in: 2128865176
        expires_at: 3637805578000
    v3@authentication@generate_data_deletion_token:
      summary: Data Deletion token
      description: Response Data Deletion token
      value:
        access_token: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
        token_type: bearer
        expires_in: 2128865176
        expires_at: 3637805578000
    v3@auth@generate_public_token_with_scope:
      summary: Generate public token
      description: Example payload for generating a public token
      value:
        validity: 25600
        scopes:
          - WIDGET
        policy:
          individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
    v3@authentication@generate_public_access_token:
      summary: Public Access token
      description: Response Access token
      value:
        access_token: 6fd5122a-9a91-4bd6-1219-d6e71fd123b0
        token_type: bearer
        expires_in: 25600
        expires_at: 1681191048000
    v3@datasource_query_example_with_filters@get:
      value:
        filters:
          institution_display_name: Pacific College
          countries:
            - CA
            - US
    v3@datasource_options_get_logo@get:
      value:
        filters:
          institution_display_name: MeasureOne
          countries:
            - CA
            - US
        options:
          get_logo: 'true'
          count: 1
    v3@datasource@get@200@example_with_default_fields:
      value:
        - id: sch_1qsAVuj4DJBoDtahULtKSNbQoV4
          contact_info:
            website: https://www.pacific-college.edu
            registrar_phone: null
            phone_number: '7146624402'
            it_helpdesk_email: null
            it_helpdesk_phone: null
            registrar_email: null
            addresses:
              - addr1: 3160 Red Hill Ave
                addr2: null
                country:
                  name: United States
                  a2_code: US
                state_name: California
                state_short_code: CA
                city: Costa Mesa
                zipcode: '92626'
                _id: 6352405a01a34b7756e6aece
            _id: 6352405a01a34b7756e6aecd
          ipeds_id: '422695'
          ceeb_id: null
          ope_id: '03299300'
          institution_display_name: Pacific College
          student_type:
            - type: ALUMNI
              name: Former Student
          employment_type: []
          employment_status: []
          countries:
            - name: United States
              a2_code: US
              _id: 6352405a01a34b7756e6aed0
    v3@datasource@get@200_get_logo@get:
      value:
        - id: sch_1qsAVuj4DJBoDtahULtKSNbQoV4
          contact_info:
            website: https://www.pacific-college.edu
            registrar_phone: null
            phone_number: '7146624402'
            it_helpdesk_email: null
            it_helpdesk_phone: null
            registrar_email: null
            addresses:
              - addr1: 3160 Red Hill Ave
                addr2: null
                country:
                  name: United States
                  a2_code: US
                state_name: California
                state_short_code: CA
                city: Costa Mesa
                zipcode: '92626'
                _id: 6352405a01a34b7756e6aece
            _id: 6352405a01a34b7756e6aecd
          ipeds_id: '422695'
          ceeb_id: null
          ope_id: '03299300'
          institution_display_name: Pacific College
          student_type:
            - type: ALUMNI
              name: Former Student
          employment_type: []
          employment_status: []
          countries:
            - name: United States
              a2_code: US
              _id: 6352405a01a34b7756e6aed0
          logos:
            - type: logo
              uri: m1://sch_1qsAVuj4DJBoDtahULtKSNbQoV4.png
              base64_content: >-
                /9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCABkAGQDAREAAhEBAxEB/8QAHAAAAwEAAwEBAAAAAAAAAAAAAAYHBQECAwQI/8QARBAAAQMDAQUEBggDBAsAAAAAAQIDBAAFEQYHEiExQRNRYXEUImKBobIjMjVyc3SRsTaiwRbR4fAVJDNCU1SCksLS8f/EABoBAAIDAQEAAAAAAAAAAAAAAAADAgQFAQb/xAA1EQACAgEDAQYEAgoDAAAAAAABAgADEQQFITESM0FxgcETNFGxUpEUFSIkMmFygqHRQuHx/9oADAMBAAIRAxEAPwD9U0QhRCFEIUQiHrbabZtN9pHYULhck8OwZV6qD7a+Q8hk+FOroZ+egi2sCyMXDUWrte3JUeMqU6DxESFlDaB7XH4qNWwiVDJiSzPM27aI1tppSrmmDOjoR6xehvhSkYHM7is/Co/ERzid7LCNehNt0yF2cTVTap0bkJjQAdSPaTyX5jB86U9APKya2fWXmxXu236AibaJjMuMr/ebVnB7iOYPgeNVipU4MaCD0mjXJ2FEIUQhRCFEIUQi/qzV9n0tH7S6ygl1QyiO36zrnknu8TgeNTStn6SLMF6yF6v2mXzVD3oNrQ7BhuncSxHJU894FQ4+5Pxq6lCpyYhrC3AmvorY7MmhuVqVxUKNzEVsjtVfePJPxPlULNSBwsktWeso91v2ldnVsENpDTKwMohxhvOuHvV/7KNICPacxhZUGIpac2426Tc3Y1/hG3NKX9FIQouISOgXwyPMAjyqT6cjpIrYD1mvrHZfp3WUc3K0OtQpjw30yomFNPeKkjgfMYPnUVtZODJFA3IkQudm1dsxu4lJU9E47qZkc7zDw7lcMH7qhmrAZbBFEFZVtCbbYM/s4eqm0W+VyEpGSws+11R8R4ikvQRysYtn1liYebfZQ6w4hxpY3krQoEKHeCOdV4yd6IQohCiEjG0/ao9DmP2jTK0JcaJQ/NICt1XVKAeHDqo9eXfVumjI7TRL2Y4ETdKbPNQawkenz1uxYrx3lzJeVOO+KUnirzOBTXuWvgSCoW5lw0zpGx6MguvQo5U8hsqdlLT2jygBk4wP5Uiqb2NYeY8KFkp1rtimzwuNppCoMU8DJWB2yx7I5I+J8qs16YDlolrSeky9H7ML3qZ0TbqpyBDdO+p58FTz2eoSePvV8ak96pwOZxay3JjXq/YbBkxEu6aluRpraMFEpZWh4jqTzSfLh4UldQc/tRhrHhJZb7rq7ZheDHKXoZJ3lRXxvsPjvHQ/eSc00hbBIZKy9bO9e27aFDlQZNuU1KbaBkx3UdoytJOOCsYIJ6EA+eM1Wes18xqsG4iprvYhGldpM0k6mI9zMJ1RLSvuK5p8jkeVTS/HDSLV/STKx6l1Zs0uphOIeYQk7zlvlglpY70933kn9acVWwZkASs/TOhtVwdYWJu5W/KDnceYWfWZWOaT394PUVUdChwY9W7QzGCoTsKIRNc2baaVqBi7oght1tRcUwk/QuK6KKOWQePDAzzpvxn7PZzIfDXOY5UqThRCKVl2faetN4k3NiGHJTrpdQXfWSxnjhCeQ49efjTWuZhiQCAHMbaVJwohPgvdmt18gLhXaGzLjL5ocTnB7weYPiONdDFTkThAPWZWidG2vRsSVHtCXd2S8XVrdVvK7kpz3AcvM1J3L9ZxVC9IyVCSi/rTSds1fafQLqhQCVBbbzeA40epSSDzHA1JHKHInGUN1ntpbTFo0tBVFskNEdCyC4rJUtwjqpR4mhmLcmAAHSbVRnYtan1BJtM5tlhplaVN75K85zkjofCtLRaJNQhZiesx9w3GzS2BEAPGZkt60lhY7SLHUnqEkg/1q2dqrxwxlJd7tzyo/wAxts9zYukQPxyQQcLQeaT3GsnUadqG7LTc0uqTUp20/wDJh6i1JKtlyMZlllaAhKsrznjnxq7pNCl9fbYmZ2u3OzTW/DUAjEzP7aTv+Xjfzf31a/VVX4jKf67u/CP8zd0te37uuSH22kdkEkbmeOc9/lVHW6RdOF7J6zS27XPqiwcAYx0mHqbWc61XuRCYjxltt7uFL3snKQeh8au6Pa6tRSLGJyYrV7jZRaa1AwJvaRv4vdsW88ENPtKKXUpPAdQePTH7GqOv0f6LYFXkHpLuj1f6RX2jwR1ipM2hSxLeTEjRlRwshtS97JT0J41q17JWUBdjnx6TMfd37R7AGI9WGau42aJMeSlLjzYWoJ5A+FYWqqFNzVr0Bmzp7TbUrnxivqHXaIUtca2sIkKbO6t1ZwjI5gY5+damk2c2qHtOM+HjM7U7oK2KVjOPGdbBrxEuUiPc2EMFw7qXUKJTnpkHl513VbOa1L1HOPCc026h27NoxnxjzWHNiIO0D7XY/AHzKre2ruj5+wnmN779fL3M1pVrhL0kHvRmkvJihwOJSAreCc5zVVNRYNV2e1xnH+Zes0tJ0Xa7Iz2c59Jm7PVqE+WgH1S0FEeIP+NWN1A7Cn+cqbIx+I4/lPj1z9ur/CT/AFp229z6mV94+ZPkI1QUWN5DLaUW9bykgboCSScVl2nUqSSWA9ZtUro3AUBSfSasaJGilRjMNNb3PcSBn9KqPa7/AMZzLtdNdeewoHlJJrwb2rpiR1LY/lFes2s40qnz+5nnNxGdSw8vtMxuTMtDk+KlRaW4lUd5Pv8A/vuNWjXXqAlh5xyJXD2UFkHGeDPmcjuNsMPLTht7e3PHdOD8aYHDMVHUe8WUIAY+MrlgWprQsdxBwpMMqB7iEmvJ6oBtaQfxT02mJGkBH0iDs/gR7jfkomNh1tDSnNxXEE8Bx7+db263PTRlDgk4mLttS23YcZwJ32h2+Nb74lENpLTbjIcKE8ADkjgOnKo7Tc91OXOSDid3KpKrcIMZEqNmcU7Z4Lizla2G1E95KRXmNQAtrgfU/eeioJapSfoIm7QPtdj8AfMqtjau6Pn7Ced3vv18vcxje/gw/kh8lZw+b/u95qt8h/b7Re2ffacn8H/yFaG692vnMvZO+by958uueF+X+Ej+tN23uPUxO7/MnyE1LFpmTFnxJi32VNp9cpGc8Un++quq16WI1YBzLuj2uyqxbSwwP9RyrHm/I9rr+MZX3m/lTXr9s+UX1+5nl9w+Zb0m/r3Trsm8w5EJHGYoMuYHBKuij7gf0qhteuVKWSw/w8jy+n5/eXNx0Ze1WT/lxM/aNEaguWiKwMNNR1IT7iONWNosa0WO3UmJ3OsVlEXoBG6y/wAAM/klfKaydR88f6veaen+TH9MTdl38Qr/ACyv3TWxvXy/r/uZW0d96f6nfan9vsflh8yqjsncHz9hO7v3w8vcyi2D7Ct35Zv5RXntV3z+Z+83dN3KeQ+0T9oJAu7GSB9APmVWvtXdHz9hPPb336+XuZmu36c/b0wQtAZ3Q3hCfWIHTNWV0dS2fFxz1lRtwuer4OeOkadE2l2Gy7KkoKHHgEpQeYSOOT51l7jqVsIROQJs7TpGpU2OME/aYGuSP9PLBI/2SOvnV/be49TMzePmT5CcN6tuKEJQlUfCQAPU/wAa6dtpJycwXd71GBj8ox6RvMm6rlCUWiGwkp3E4558fCs7X6VKAvY8Zq7ZrbNUW+JjjHSIWuiP7ZSuI+s319lNbu2D90X1+5mduB/em9JYa8hPUSabViBcrfkgfRL5n2hXpNj7t/MTA3j+NfIxv0m2l7SNvbXxQuOEnHcRWTrmK6pyPAzT0YDaZQfpJpJj3LSN530ZQUZDbpTlDiP89OlekR6dwpwfUeIMwHS3Q25H5+Bgy1c9XXgKVlxasJW6E4Q0j/OeHM0M1G31YHH8vEmCrdrrcn/oSxxmUx47TLf1G0hCfIDFePdi7Fj4z1KqFUKPCcuMtOHLjaFHllSQaA7L0MGRW5InCGGUK3kNNpUOoSBQXY8EzgrQHIE9KjJzzWw04reW0hSu8pBqQdhwDIGtWOSJ19Fj/wDAa/7BXfiP9Zz4SfhH5Tu2021ns20Izz3QBXCxbqZJUVegxOrkVhxZW4w0pR6lAJrosYDAMCik5InrUJKebrDLxBdabWRyKkg4qSuy9DIlFbqJ3QlKEhKEhKRwAAwBXCSTkzoAAwJw4hDiSlxKVJPRQyKASDkQIB4MG20NpCW0pSnuSMCgkscmAAHAnauTsKIT89ay1hrLTmu964yPUjrKmY6E7kd9o9cczw6kkg1eSut04ldmYNzKlovaJZdUBDLbnodxI4xXyASfYPJXu4+FVrKWTyjVcNHOlScKIQohCiEKIQohPkutzhWiC5MucpmLFbGVOOqCQPDz8K6ATwJwnHWQDadtjXdY7lt0qX4sbeBcnEltxYBzhA5pHieJ7hVqunHLRTWZ4EqGx2ZqW4aURL1WsKU6oGKVt7jqmsfWXjhx6cAccTzpFoUNhZNM45j1S5OFEJl6isFs1FBMS7xG5DXNJPBSD3pUOIPlUlcocicKg9ZDdabIrlaSuVp9S7jDSd7suT7flj6/uwfCrleoDcNxENUR0njozavd7EtMS9pcuMNB3D2hw+1jpk/W8lcfGu2adW5XiC2EdZc9M6mtOpYnpFoloewPXbPquN+CkniP2qm6MhwY4MG6TZqElCiE4WpKElSyEpAySTgAUQkn15totVm7SJp5KLrPHAug/wCrtnxUPr+SeHjT0oJ5MW1gHSRtpnV+1C9b2X56kHBWr1I8YfKnyGVHxp/7NYi+XMtegtjtosBal3kputyThQ304ZbPso6nxV+gqu9xbgcRi1gdZUqTGQohCiEKIQohFLWegbLqpCnJTPo87GEy2AAv/q6KHn8KbXaydJBkDSG6k0VqTQ00T4y3VsNHKJ8Mkbo9sc0+/I8auJalgwYkoU5jlozbNupRG1UyTwwJkdGc/fQP3T+lKs03ikmtv1jJfdsulLdFUuHIeuMnHqsMsqTx8VKAAH6+VJFD55kzYPCRTU+t9U7Qp4tzCHewdP0duhAkKHtnmrzOEjuFWFrWsZiixbiPmhNhwHZy9YO73UQGF8PJaxz8k/qaU9/gsmtf1lvt0CJbYbcS3x2o0ZsYQ00gJSn3Cq5JPJjQMT6a5CFEIUQhRCFEIUQhRCcKSFAhQBBGCDRCSTajs+sLdvfu0NhyFIz6yI6gltR790gge7FWqbmz2TEug6yOaK05E1HqoQZzshDJWASypIVjzINOsYryJBRmfqTS2lrPpeGY1lhNsA/Xc+s44e9SjxP7VRZy3WWAoHSbdRnYUQhRCFEIUQn/2Q==
    v3@datarequest@new:
      summary: Create a new Static Data Request
      description: Example payload create a Static Data Request
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        type: ACADEMIC_SUMMARY
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
    v3@datarequest@new_custom:
      summary: Create a new Custom Data Request
      description: Example payload create a Custom Data Request
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        type: CUSTOM
        source_data_types:
          direct_connections:
            - EMPLOYMENT
            - INCOME
          manual_uploads:
            source_data_type: PAYSTUB_FILE
            min_count: 2
            max_count: 2
        experience_id: exp_29yUzw2KnXN168IgMkMnb7YBV4S
        reports:
          - uri: m1_report://INCOME_EMPLOYMENT_DETAILS
            params:
              get_yearly_earnings: true
            metadata:
              report_id: ABCDEF
        enable_manual_upload: true
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
    v3@datarequest@new_with_auth_token_creds:
      summary: Create a new Data Request with Auth Token Credentials
      description: Example payload create a Data Request
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        type: ACADEMIC_SUMMARY
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
            x_auth_token_credentials:
              token_type: JWT
              http_method: POST
              url: https://somedomain.com/generate_token
              key_id: ek_12345677834r
              headers:
                content-type: application/x-www-form-urlencoded
                authorization: 12n4509as8rtkqj35p1oq8eurfqwiaebr13425
              data:
                username: 8uafoi12n4509as8rtkqj35p1oq8eurfqwiaebr13425
                password: 123498172349817234891234iljasbf8071641
              response_token_path: access_token.token
    v3@datarequest@get_by_id:
      summary: Get Data Request Details by ID
      description: Example payload when retrieving Data Request details by ID
      value:
        id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        individual_id: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
        type: ACADEMIC_SUMMARY
        source_data_types:
          direct_connections:
            - EDUCATION
          manual_uploads:
            source_data_type: TRANSCRIPT_FILE
            min_count: 1
            max_count: 1
        experience_id: exp_1faOM8Q4efEWIjzdE2SBM24efEW
        reports:
          - uri: m1_report://ACADEMIC_SUMMARY
        enable_manual_upload: true
        show_connect_method_options: 'true'
        datasource:
          id: emp_of6SdbYxmUAKNImksmnaiOSt4wRT
          display_name: U.S. Bank (US Bancorp)
          enable_override: true
          connection_method: DIRECT_CONNECTION
          last_connected_at: '1673492103030'
          last_connection_status: CONNECTED"
        countries:
          - US
        created_at: 1673322103030
        updated_at: 1673492103030
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        requester_logo: 'null'
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
        invitation_links:
          - id: 23JUuA89ikWQ3JVesPuO7KNZUfr
            uri: https://link-stg.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
            expires_at: 1673922103030
            email_notification: true
            sms_notification: false
            status: ACTIVE
            additional_message: null
        last_activity_type: CREATED
        last_activity_at: 1673322103030
        refresh_policy:
          enabled: true
          schedule:
            frequency: WEEKLY
            by_weekday:
              - MO
        event_logs:
          - type: DATAREQUEST_CREATED
            created_at: 1673322103030
          - type: DATAREQUEST_UPDATED
            created_at: 1673464103030
            details:
              autorun_services: true
              requester_name: ABC Company
          - type: DATAREQUEST_LINK_GENERATED
            created_at: 0
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
              expires_at: 1673922103030
          - type: NOTIFY_USER_REQUESTED
            created_at: 1673923103030
            details:
              email_notification: true
          - type: DATAREQUEST_LINK_ACCESSED
            created_at: 1673522103030
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
          - type: WIDGET_INITIATED
            created_at: 1673522403030
          - type: LOGIN_ATTEMPTED
            created_at: 1673522703030
            details:
              session_id: tls_2O6SJQkNL3KR5EQh4afjHGpiZrM
          - type: DATAREQUEST_LINK_USED
            created_at: 1673522703030
          - type: DATASOURCE_CONNECTED
            created_at: 1673522703030
            details:
              session_id: tls_2O6SJQkNL3KR5EQh4afjHGpiZrM
    v3@datarequest@get_by_id_x_auth_token_credentials:
      summary: Get Data Request Details by ID (get_x_auth_token_credentials = true)
      description: Example payload when retrieving Data Request details by ID
      value:
        id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        individual_id: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
        type: ACADEMIC_SUMMARY
        source_data_types:
          direct_connections:
            - EDUCATION
          manual_uploads:
            source_data_type: TRANSCRIPT_FILE
            min_count: 1
            max_count: 1
        experience_id: exp_1faOM8Q4efEWIjzdE2SBM24efEW
        reports:
          - uri: m1_report://ACADEMIC_SUMMARY
        enable_manual_upload: true
        show_connect_method_options: 'true'
        datasource:
          id: emp_of6SdbYxmUAKNImksmnaiOSt4wRT
          display_name: U.S. Bank (US Bancorp)
          enable_override: true
          connection_method: null
          last_connected_at: null
          last_connection_status: NOT_CONNECTED
        countries:
          - US
        created_at: 1673322103030
        updated_at: 1673492103030
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        requester_logo: lgo_1faOM8Q4efEWIjzdE2SBM2kLjzd.png
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
            x_auth_token_credentials:
              token_type: JWT
              http_method: POST
              url: https://somedomain.com/generate_token
              key_id: ek_12345677834r
              headers:
                content-type: application/x-www-form-urlencoded
                authorization: 12n4509as8rtkqj35p1oq8eurfqwiaebr13425
              data:
                loginId: 8uafoi12n4509as8rtkqj35p1oq8eurfqwiaebr13425
                password: 123498172349817234891234iljasbf8071641
              response_token_path: access_token.token
        invitation_links:
          - id: 23JUuA89ikWQ3JVesPuO7KNZUfr
            uri: https://link-stg.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
            expires_at: 1673922103030
            email_notification: true
            sms_notification: false
            status: ACTIVE
            additional_message: null
        last_activity_type: CREATED
        last_activity_at: 1673322103030
        refresh_policy:
          enabled: true
          schedule:
            frequency: WEEKLY
            by_weekday:
              - MO
        event_logs:
          - type: DATAREQUEST_CREATED
            created_at: 1673322103030
          - type: DATAREQUEST_UPDATED
            created_at: 1673464103030
            details:
              autorun_services: true
              requester_name: ABC Company
          - type: DATAREQUEST_LINK_GENERATED
            created_at: 0
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
              expires_at: 1673922103030
          - type: NOTIFY_USER_REQUESTED
            created_at: 1673923103030
            details:
              email_notification: true
          - type: DATAREQUEST_LINK_ACCESSED
            created_at: 1673522103030
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
    v3@datarequest@get_by_id_consent:
      summary: Get Data Request Details by ID (get_consent = true)
      description: Example payload when retrieving Data Request details by ID
      value:
        id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        type: ACADEMIC_SUMMARY
        individual_id: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
        source_data_types:
          direct_connections:
            - EDUCATION
          manual_uploads:
            source_data_type: TRANSCRIPT_FILE
            min_count: 1
            max_count: 1
        experience_id: exp_1faOM8Q4efEWIjzdE2SBM24efEW
        reports:
          - uri: m1_report://ACADEMIC_SUMMARY
        enable_manual_upload: true
        show_connect_method_options: 'true'
        datasource:
          id: emp_of6SdbYxmUAKNImksmnaiOSt4wRT
          display_name: U.S. Bank (US Bancorp)
          enable_override: true
          connection_method: null
          last_connected_at: null
          last_connection_status: NOT_CONNECTED
        countries:
          - US
        created_at: 1673322103030
        updated_at: 1673492103030
        third_party_requester: ABC Company's largest customer
        requester_name: ABC Company
        requester_logo: lgo_1faOM8Q4efEWIjzdE2SBM2kLjzd.png
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
        consent:
          id: '20230824'
          description: >-
            By continuing, you hereby give MeasureOne consent to access, obtain,
            use and extract your personal account data
             from third party sources, databases, networks, processors or information systems (each, a "Third Party Source"), 
             including personally identifiable information such as your full name, address, birth date, employment or student 
             status, income or other financial information and any related data applicable to the provision and delivery of 
             MeasureOne services, and to use other personally identifiable information that you may directly provide to 
             MeasureOne, for the uses described in this consent.


            You have been directed to MeasureOne by, or through, the application
            of a MeasureOne customer or partner with
             which you have a direct commercial relationship and from which you have requested, or may obtain, products or 
             services (each of those MeasureOne customers or partners being referred to as an "Authorized Recipient"). You 
             hereby expressly authorize and give MeasureOne permission to deliver, provide or make available to the Authorized 
             Recipient, the designated personal account data (or data and information that MeasureOne may derive from, or is 
             based on, that personal account data) required by, or necessary to enable, the Authorized Recipient to evaluate your 
             request to obtain, or otherwise provide you with, its products or services (the designated personal account data that 
             MeasureOne delivers, provides or makes available to an Authorized Recipient with your consent, or otherwise 
             derives from or is based on your personal account data, being referred to as the "Permissioned Data"). To the extent 
             that any of the Permissioned Data may be considered "Tax Return Information" under Section 7216 of the IRS Code, 
             you acknowledge and agree that MeasureOne makes available the Permissioned Data to Authorized Recipient for 
             the purpose of providing auxiliary services in connection with the preparation of your tax return.


            To obtain your personal account data from a Third Party Source,
            MeasureOne requires you to provide your
             credentials (including log-in information and any related two-factor authentication tokens or similar access 
             information) and your authorization to access, obtain, use and extract that personal account data from the Third 
             Party Source. You represent that the credentials you provide belong to you, that they are valid for the use intended 
             and that you are making those credentials available to MeasureOne for the purposes referred to in this consent.


            You confirm that all personal account data belongs to, and is owned
            by, you. You confirm that you have the legal 

            capacity to provide and deliver this consent and to understand its
            purpose. You legally and validly hereby appoint 

            and designate MeasureOne to act as your lawful, authorized and
            empowered agent to access, obtain, use and 

            extract your personal account data from the Third Party Source
            within which that data may be stored, maintained or 

            reside (and from which Permissioned Data may be derived, taken or
            made available to any Authorized Recipient). 

            You consent, and hereby grant, an irrevocable, royalty-free license,
            and sublicense, to the foregoing uses and 

            applications, to sharing personal account data with MeasureOne and
            for MeasureOne to share Permissioned Data 

            with, and provide Permissioned Data to, the Authorized Recipient.
            You agree that neither MeasureOne nor the 

            Authorized Recipient has any liability to you, and you hereby
            expressly, unconditionally and irrevocably waive and 

            agree not to assert any claims against MeasureOne or the Authorized
            Recipient, for any actions taken or not taken 

            as your lawful, authorized and empowered agent under this consent,
            for any use or misuse of your Permissioned 

            Data by any Authorized Recipient or for any decisions affecting you
            that the Authorized Recipient may make or not 

            make in connection your use of its application.
          recorded_at: 1696675463535
        invitation_links:
          - id: 23JUuA89ikWQ3JVesPuO7KNZUfr
            uri: https://link-stg.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
            expires_at: 1673922103030
            email_notification: true
            sms_notification: false
            status: ACTIVE
            additional_message: null
        last_activity_type: CREATED
        last_activity_at: 1673322103030
        refresh_policy:
          enabled: true
          schedule:
            frequency: WEEKLY
            by_weekday:
              - MO
        event_logs:
          - type: DATAREQUEST_CREATED
            created_at: 1673322103030
          - type: DATAREQUEST_UPDATED
            created_at: 1673464103030
            details:
              autorun_services: true
              requester_name: ABC Company
          - type: DATAREQUEST_LINK_GENERATED
            created_at: 0
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
              expires_at: 1673922103030
          - type: NOTIFY_USER_REQUESTED
            created_at: 1673923103030
            details:
              email_notification: true
          - type: DATAREQUEST_LINK_ACCESSED
            created_at: 1673522103030
            details:
              uri: https://link-alpha1.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
    v3@datarequest@expire:
      summary: Expire Data Request Link
      description: Example payload to expire an data request link
      value:
        id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        expiry_reason:
          code: LINK_TIMEOUT
          description: Link expired without use
    v3@datarequest@get_by_datarequest_type:
      summary: Get DataRequest by Data Request type (filters)
      description: Example payload for datarequest/get
      value:
        filters:
          type:
            - ACADEMIC_SUMMARY
        fields:
          - id
          - type
          - individual_id
          - invitation_links
          - created_at
    v3@datarequest@get_multiple_filters:
      summary: Get Data Request by multiple filters
      description: Example payload for datarequest/get
      value:
        filters:
          status:
            - ACTIVE
          datasource_id:
            - emp_of6SdbYxmUAKNIReDSOULxkIZ6r
          type:
            - EMPLOYMENT_SUMMARY
          name: John Doe
        options:
          count: 50
          offset: 1
          sort_by: created_at
          sort_order: ASC
          prefetch_individual: false
          get_x_auth_token_credentials: true
        fields:
          - id
          - individual_id
          - invitation_links
          - created_at
    v3@datarequest@get:
      summary: Get list of Data Requests
      description: Example payload for getting list of Data Requests
      value:
        results:
          - id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
            individual_id: idv_Cevp4Jw9CIsEeNjpgasjy2EZt3R
            type: ACADEMIC_SUMMARY
            created_at: 1673322103030
            experience_id: exp_1faOM8Q4efEWIjzdE2SBM24efEW
            invitation_links:
              - id: 23JUuA89ikWQ3JVesPuO7KNZUfr
                uri: https://link-stg.measureone.com/2LBYn0SQgJcvO2aWnnKhWDNRTP2
                expires_at: 1673922103030
                email_notification: true
                sms_notification: false
                status: ACTIVE
                additional_message: null
            event_logs:
              - type: DATAREQUEST_CREATED
                details: null
                created_at: 1719858938643
            reports:
              - uri: m1_report://ACADEMIC_SUMMARY
            source_data_types:
              direct_connections:
                - EDUCATION
              manual_uploads:
                source_data_type: TRANSCRIPT_FILE
                min_count: 1
                max_count: 1
        rowCount: 1
    v3@datarequest@update:
      summary: Update a data request
      description: Example payload Update a data request
      value:
        id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
        requester_name: ABC screening
        request_details:
          student_type: ALUMNI
        delivery_details:
          - event_type: datasource.connected
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
        refresh_policy:
          enabled: true
          schedule:
            frequency: MONTHLY
            by_monthday:
              - 15
    v3@datarequest@enable_refresh:
      summary: Enable refresh data for Data Requests
      description: Example payload Enable refresh data for Data Requests
      value:
        - id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
          refresh_policy:
            schedule:
              frequency: WEEKLY
              by_weekday:
                - MO
            effective_date: 1642322723663
            end_date: 1684322723663
    v3@compliances@purge_individual:
      summary: Purge Individual
      value:
        individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
        delivery_details:
          - event_type: individual.purged
            url: https://www.example.com/unique_or_common_link
            headers:
              content-type: application/json
x-webhooks:
  datarequest.report_available:
    post:
      summary: datarequest.report_available
      description: |
        Triggered when the report data for a Data Request is available
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                  type: string
                transaction_id:
                  type: string
                  description: Unique ID of the Transaction identified by MeasureOne
                  deprecated: true
                service_context_id:
                  type: string
                  description: Unique ID of the service context identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                report_uri:
                  type: string
                  description: The type of the report.
                  enum:
                    - m1_report://EMPLOYMENT_SUMMARY
                    - m1_report://INCOME_SUMMARY
                    - m1_report://INCOME_EMPLOYMENT_DETAILS
                    - m1_report://INSURANCE_DETAILS
                    - m1_report://INSURANCE_STATUS
                    - m1_report://ACADEMIC_SUMMARY
                    - m1_report://ENROLLMENT_STATUS
                    - m1_report://REALIZED_GAINS
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
                metadata:
                  type: object
                  description: >-
                    metadata can be used for storing additional information in a
                    structured format.
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                transaction_id: trx_TSEne2SSjP3GvpVrs5HLol4xor2
                service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
                report_uri: m1_report://INSURANCE_DETAILS
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.report_available
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
                metadata:
                  report_id: REPORT
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.report_error:
    post:
      summary: datarequest.report_error
      description: >
        Triggered when an error occurred during generating report for a Data
        Request


        ### Reason Codes


        |Reason Code|Description|

        |--- |--- |

        |UNSUPPORTED_FORMAT| The report could not be generated as the following
        items are of unsupported format.

        |UNPROCESSABLE_DOCUMENT_QUALITY| The report could not be generated as
        the following items are unprocessable.

        |PARTIAL_DOCUMENT| The report could not be generated as the following
        items are partial.

        |NO_ITEMS| The report could not be generated as there are no items for
        this Individual.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                individual_id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                transaction_id:
                  type: string
                  description: Unique ID of the Transaction identified by MeasureOne
                  deprecated: true
                service_context_id:
                  type: string
                  description: Unique ID of the service context identified by MeasureOne
                report_uri:
                  type: string
                  description: The type of the report.
                  enum:
                    - m1_report://EMPLOYMENT_SUMMARY
                    - m1_report://INCOME_SUMMARY
                    - m1_report://INCOME_EMPLOYMENT_DETAILS
                    - m1_report://INSURANCE_DETAILS
                    - m1_report://INSURANCE_STATUS
                    - m1_report://ACADEMIC_SUMMARY
                    - m1_report://ENROLLMENT_STATUS
                    - m1_report://REALIZED_GAINS
                metadata:
                  type: object
                  description: >-
                    metadata can be used for storing additional information in a
                    structured format.
                reason_codes:
                  description: >-
                    List of reason codes. Helps developer understand what error
                    occurred during report generation.
                  type: array
                  items:
                    properties:
                      code:
                        type: string
                        description: Reason code applicable
                      description:
                        type: string
                        description: >-
                          Description providing details to understand what error
                          occurred during report generation.
                      context:
                        type: object
                        description: >-
                          Context to understand where the reason code is
                          applicable
                        properties:
                          items:
                            type: array
                            description: List of Items where the reason code is applicable
                            items:
                              type: string
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                transaction_id: trx_TSEne2SSjP3GvpVrs5HLol4xor2
                service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
                report_uri: m1_report://INSURANCE_DETAILS
                metadata:
                  report_id: REPORT
                reason_codes:
                  - code: UNSUPPORTED_FORMAT
                    description: >-
                      The report could not be generated as the following items
                      are of unsupported format.
                    context:
                      items:
                        - itm_Cevp4JweIsEeNjpgAAjy2EZt3R
                        - itm_2QE8ZMulsMal2OYaDAMxD0cQN4o
                event: datarequest.report_error
                is_refresh: false
                refresh_id: null
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  datarequest.items_available:
    post:
      summary: datarequest.items_available
      description: >
        Triggered when the data extraction for a Data Request is complete and
        Items are available. This is triggered when

        * The user has successfully connected their account and MeasureOne has
        successfully extracted all the documents relevant for the Data Request

        * The user has manually uploaded the required documents for the Data
        Request
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
                items:
                  description: List of items extracted
                  type: array
                  items:
                    properties:
                      id:
                        type: string
                        description: Unique ID of the item identified by MeasureOne
                      source_data_type:
                        type: string
                        description: The type of the source_data
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.items_available
                is_refresh: false
                refresh_id: null
                items:
                  - id: itm_1aJJylkh6Ov9ANpoxd9p0wpEfYq
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1aJKUKDmU4MDfqlujB0ENJVNxn3
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1aJlaoY6dxe1d0KJPY1A4KDuOUF
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1ajjH2BEyAY9JwPYgTY7kdg6uv0
                    source_data_type: TRANSCRIPT_FILE
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.items_processed:
    post:
      summary: datarequest.items_processed
      description: >
        Triggered when all the Items for a Data requests are processed. This is
        triggered when

        * The user has successfully connected their account and MeasureOne has
        successfully processed all the documents relevant for the Data Request

        * The user has manually uploaded the required documents are processed
        for the Data Request
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
                items:
                  description: List of items extracted
                  type: array
                  items:
                    properties:
                      id:
                        type: string
                        description: Unique ID of the item identified by MeasureOne
                      source_data_type:
                        type: string
                        description: The type of the source_data
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: e2SSjP3GvpVrs5HL
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.items_processed
                is_refresh: false
                refresh_id: null
                items:
                  - id: itm_1aJJylkh6Ov9ANpoxd9p0wpEfYq
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1aJKUKDmU4MDfqlujB0ENJVNxn3
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1aJlaoY6dxe1d0KJPY1A4KDuOUF
                    source_data_type: TRANSCRIPT_FILE
                  - id: itm_1ajjH2BEyAY9JwPYgTY7kdg6uv0
                    source_data_type: TRANSCRIPT_FILE
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.no_items:
    post:
      summary: datarequest.no_items
      description: >
        Triggered when the data extraction for a Data Request is complete and no
        Item is available.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.no_items
                is_refresh: false
                refresh_id: null
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.updates_available:
    post:
      summary: datarequest.updates_available
      description: |
        Triggered when the updated data for a Data Request is available
      tags:
        - webhooks
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                  type: string
                transaction_id:
                  type: string
                  description: Unique ID of the Transaction identified by MeasureOne
                  deprecated: true
                service_context_id:
                  type: string
                  description: Unique ID of the service context identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                transaction_id: trx_TSEne2SSjP3GvpVrs5HLol4xor2
                service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.updates_available
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.acquisition_complete:
    post:
      summary: datarequest.acquisition_completed
      description: >
        Triggered when the data extraction for a Data Request is complete. This
        is triggered when

        * The user has successfully connected their account and MeasureOne has
        successfully extracted all the documents relevant for the Data Request

        * The user has manually uploaded the required documents for the Data
        Request
      tags:
        - webhooks
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                reason_code:
                  description: Reason code for this webhook
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: datarequest.acquisition_completed
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
  datarequest.refresh_failed:
    post:
      summary: datarequest.refresh_failed
      description: >
        Triggered when a scheduled refresh fails 


        ### Reason Codes


        |Reason Code|Description|

        |--- |--- |

        |INVALID_CREDENTIALS| Refresh could not be completed as available
        credentials are invalid or no credentials are available.

        |MFA_REQUIRED| Refresh could not be completed as MFA authentication is
        required.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datasource_id:
                  type: string
                  description: Unique ID of the Datasource identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                connection_id:
                  description: Unique ID of the connection with the Datasource
                external_id:
                  description: Your identifier for the Individual
                session_id:
                  description: >-
                    MeasureOne's Unique ID of the session for which the
                    Individual connected their account
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
                reason_codes:
                  description: >-
                    List of reason codes. Helps developer understand what error
                    occurred during datarequest refresh flow.
                  type: array
                  items:
                    properties:
                      code:
                        type: string
                        description: Reason code applicable
                      description:
                        type: string
                        description: >-
                          Description providing details to understand what error
                          occurred during datarequest refresh flow.
              example:
                connection_id: cn_TSEne2SSjP3GvpVrs5HLol4xor2
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                datasource_id: sch_CV8e5Lsvv2S8Wjz9Bpwpr8lm9Ay
                external_id: ABCDECD
                session_id: tls_1fGYo0n2ggSN7iROJNkvxFDkovE
                checkcodes_created: true
                event: datarequest.refresh_failed
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
                reason_codes:
                  - code: INVALID_CREDENTIALS
                    description: >-
                      Refresh could not be completed as available credentials
                      are invalid or no credentials are available.
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
              
              
  datasource.connected:
    post:
      summary: datasource.connected
      description: >-
        Triggered when a successful connection with the Datasource is
        established
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datasource_id:
                  type: string
                  description: Unique ID of the Datasource identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                connection_id:
                  description: Unique ID of the connection with the Datasource
                external_id:
                  description: Your identifier for the Individual
                session_id:
                  description: >-
                    MeasureOne's Unique ID of the session for which the
                    Individual connected their account
                checkcodes_created:
                  description: >-
                    A flag to identify if checkcodes are available for given
                    session
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                connection_id: cn_TSEne2SSjP3GvpVrs5HLol4xor2
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                datasource_id: sch_CV8e5Lsvv2S8Wjz9Bpwpr8lm9Ay
                external_id: ABCDECD
                session_id: tls_1fGYo0n2ggSN7iROJNkvxFDkovE
                checkcodes_created: true
                event: datasource.connected
                is_refresh: false
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
              
              
  transaction.processed:
    post:
      summary: transaction.processed
      description: >-
        Triggered when a transaction created while calling services API is
        completed
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                transaction_id:
                  type: string
                  description: Unique ID of the Transaction identified by MeasureOne
                  deprecated: true
                service_context_id:
                  type: string
                  description: Unique ID of the service context identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
                metadata:
                  type: object
                  description: >-
                    metadata can be used for storing additional information in a
                    structured format.
              example:
                transaction_id: trx_TSEne2SSjP3GvpVrs5HLol4xor2
                service_context_id: trx_SEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                individual_id: idv_1iSADgTyw9NihNmsVRfjwOfdRDk
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                event: transaction.processed
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
                metadata:
                  report_id: REPORT
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  unprocessable.entity:
    post:
      summary: unprocessable.entity
      description: >
        Triggered when an item received by MeasureOne is not processable.


        ### Reason Codes


        |Reason Code|Description|

        |--- |--- |

        |UNSUPPORTED_FORMAT| The item can not be processed due to unsupported
        format.

        |UNPROCESSABLE_DOCUMENT_QUALITY| The item can not be processed due to
        unprocessable document quality.

        |PARTIAL_DOCUMENT| The item can not be processed due to partial
        document.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                item_id:
                  type: string
                  description: Unique ID of the Item identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                reason_codes:
                  description: >-
                    List of reason codes. Helps developer understand what error
                    occurred during processing an item.
                  type: array
                  items:
                    properties:
                      code:
                        type: string
                        description: Reason code applicable
                      description:
                        type: string
                        description: >-
                          Description providing details to understand what error
                          occurred during processing an item.
                      context:
                        type: object
                        description: >-
                          Context to understand where the reason code is
                          applicable
                        properties:
                          media_type:
                            type: string
                            description: >-
                              Media type of the source data document Supported
                              Types eg `application/pdf`, `application/json`,
                              `image/jpeg`, `image/png`, `image/tiff`,
                              `text/html`
                item_type:
                  description: Type of the item
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                item_id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
                individual_id: idv_1iSADgTyw9NihNmsVRfjwOfdRDk
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                item_type: TRANSCRIPT_FILE
                event: unprocessable.entity
                reason_codes:
                  - code: UNSUPPORTED_FORMAT
                    description: The item can not be processed due to unsupported format.
                    context:
                      media_type: image/jpeg
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  session.completed:
    deprecated: true
    post:
      summary: session.completed
      deprecated: true
      description: Triggered when a session gets completed
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                session_id:
                  type: string
                  description: >-
                    MeasureOne's Unique ID of the session for which the
                    Individual connected their account
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
                reason_code:
                  description: Reason code for this webhook
              example:
                session_id: tls_1d7wotXTBnA54hsQEyjq6LwSaZs
                external_id: ABCDECD
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                event: session.completed
                reason_code: DATA_NOT_AVAILABLE
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  session.rejected:
    post:
      summary: session.rejected
      description: >
        Triggered when the Link session cannot be processed. Reason Codes and
        Description for session.rejected events are in the following table


        ### Reason Codes


        |Reason Code|Description|

        |--- |--- |

        |DATA_NOT_AVAILABLE| Individual was able to login successfully but
        verified data is not available or accessible to MeasureOne.|

        |INCOMPLETE_LOGIN| An error occurred during login that is now resolved.
        Please ask the individual to login again.|
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                individual_id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                session_id:
                  type: string
                  description: MeasureOne's Unique ID of the session in which
                reason_code:
                  description: Reason code for rejection
                  type: string
                description:
                  description: Description about the reason_code
                  type: string
                event:
                  type: string
                  description: Name of the event
              example:
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                session_id: tls_1fGYo0n2ggSN7iROJNkvxFDkovE
                reason_code: INCOMPLETE_LOGIN
                description: >-
                  An error occurred during login that is now resolved. Please
                  ask the individual to login again
                event: session.rejected
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  session.terminated:
    post:
      summary: session.terminated
      description: >
        Triggered when the session is terminated. This can occur for internal
        reasons or
        [max_latency](/api/openapi_3.2/openapi/data-requests/paths/~1v3~1datarequests~1new/post#data-requests/paths/~1v3~1datarequests~1new/post/t=request&path=&oneof=0/processing_config/max_latency) 
        is set and exceeded.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                individual_id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                session_id:
                  type: string
                  description: MeasureOne's Unique ID of the session in which
                event:
                  type: string
                  description: Name of the event
              example:
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: Oas212
                session_id: tls_1fGYo0n2ggSN7iROJNkvxFDkovE
                event: session.terminated
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  session.no_login:
    post:
      summary: session.no_login
      description: >
        Triggered when the Link widget is closed without a successful
        connection. Reason Codes and Description for session.no_login events are
        in the following table.


        ### Reason Codes


        |Reason Code|Description|

        |--- |--- |

        |NO_MATCH_FOUND| Could not find matching datasources for the information
        provided|

        |INSUFFICIENT_CREDENTIALS| The individual is unable to provide
        sufficient credentials to connect their account|

        |LINK_EXPIRED| The link expired without use|
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                reason_code:
                  type: string
                  description: Reason code for this webhook
                  enum:
                    - NO_MATCH_FOUND
                    - INSUFFICIENT_CREDENTIALS
                    - LINK_TIMEOUT
                description:
                  type: string
                  description: Description of the reason code
                event:
                  type: string
                  description: Name of the event
              example:
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                datarequest_id: dr_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                reason_code: NO_MATCH_FOUND
                description: >-
                  MeasureOne could not find a matching datasource for the
                  information provided
                event: session.no_login
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  item.created:
    post:
      summary: item.created
      description: >
        Triggered when an item is created. This event can occur in one of the
        following conditions

        * When MeasureOne extracts the item from the datasource

        * When Individual manually uploads an item through MeasureOne Link

        * When you upload and create an item using /items/new API
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                item_id:
                  type: string
                  description: Unique ID of the item identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                item_type:
                  description: Source Data type of the item
                event:
                  type: string
                  description: Name of the event,
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                item_id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
                datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                item_type: TRANSCRIPT_FILE
                event: item.created
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                    
  item.processed:
    post:
      summary: item.processed
      description: |
        Triggered when an item is processed and data is available to be pulled
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                item_id:
                  type: string
                  description: Unique ID of the item identified by MeasureOne
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                item_type:
                  description: Source Data type of the item
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                item_id: itm_TSEne2SSjP3GvpVrs5HLol4xor2
                datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDECD
                item_type: TRANSCRIPT_FILE
                event: item.processed
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  item.unavailable:
    post:
      summary: item.unavailable
      description: >-
        Triggered when MeasureOne is unable to extract a specific Item type from
        the Datasource
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                session_id:
                  type: string
                  description: >-
                    MeasureOne's Unique ID of the session for which the
                    Individual connected their account
                datarequest_id:
                  type: string
                  description: Unique ID of the Data Request identified by MeasureOne
                individual_id:
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  description: Your identifier for the Individual
                item_type:
                  type: string
                  description: Unique ID of the item identified by MeasureOne
                reason_code:
                  description: Reason code for this webhook
                event:
                  type: string
                  description: Name of the event
                is_refresh:
                  description: >-
                    A flag to identify if event trigger due to a scheduled auto
                    refresh
                refresh_id:
                  description: Unique ID of a scheduled refresh identified by MeasureOne
              example:
                session_id: tls_1d7wotXTBnA54hsQEyjq6LwSaZs
                datarequest_id: dr_1faOM8Q4efEWIjzdE2SBM2kLq4O
                individual_id: idv_TSEne2SSjP3GvpVrs5HLol4xor2
                external_id: ABCDED
                item_type: TRANSCRIPT_FILE
                event: item.unavailable
                reason_code: ITEM_UNAVAILABLE
                is_refresh: true
                refresh_id: rfs_1234ks2lkdw4i4j2li342podjslru
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
  individual.purged:
    post:
      summary: individual.purged
      description: |
        Triggered when an Individual is purged.
      tags:
        - webhooks
      requestBody:
        content:
          application/json:
            schema:
              properties:
                individual_id:
                  type: string
                  description: Unique ID of the Individual identified by MeasureOne
                external_id:
                  type: string
                  description: Your identifier for the Individual
                event:
                  type: string
                  description: Name of the event
              example:
                individual_id: idv_Cevp4Jw9CIsEeNjpgAAjy2EZt3R
                external_id: ABCDECD
                event: individual.purged
      responses:
        '200':
          description: >
            Return a 200 status to indicate that the data was received
            successfully
                        
security:
  - Bearer: []
  - Basic: []
  - Internal: []
  - None: []
