# Get insurance status

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|
  


Endpoint: POST /v3/services/get_insurance_status
Version: 3.0
Security: Bearer

## Header parameters:

  - `version` (number)
    Version number of the MeasureOne API you wish to integrate.

  - `Authorization` (string)
    Authorization API Key

  - `Content-type` (string)
    Content-type of the request payload. MeasureOne accepts content in application/json format unless specified otherwise

## Response 200 fields (application/json):

  - `individual` (object)
    Individual Status

  - `individual.individual_id` (string)
    Unique ID of the individual identified by MeasureOne

  - `individual.datasources` (array)

  - `datarequest_id` (string)
    Unique ID of the Data Request identified by MeasureOne

  - `service_context_id` (string)
    Unique ID of the service context identified by MeasureOne

  - `processing_status` (string)
    Processing status of the request.  - MeasureOne has finished processing of the request.  - We have received the request and system is acquiring the Insurance Policy.
    Enum: "COMPLETED", "ACQUIRING"

  - `metadata` (object)
    metadata can be used for storing additional information in a structured format. metadata will be sent in webhooks and report response.

  - `insurance_status` (array)
    List of basic insurance information retrieved

  - `insurance_status.datasource` (object)
    Datasource details

  - `insurance_status.datasource.id` (string)
    MeasureOne datasource identifier

  - `insurance_status.datasource.type` (string)
    Type of datasource

  - `insurance_status.datasource.name` (string)
    Name of datasource

  - `insurance_status.as_of_date` (number)
    timestamp when this record was generated

  - `insurance_status.policy_number` (string)
    Policy number

  - `insurance_status.status` (string)
    Policy status
    Enum: "ACTIVE", "EXPIRED", "PENDING_ACTIVATION", "PENDING_CANCELLATION", "PENDING_EXPIRATION", "CANCELLED", "UNVERIFIED", "RESCINDED", "NOT_AVAILABLE"

  - `insurance_status.coverage_period` (object)
    Insurance coverage period

  - `insurance_status.coverage_period.start_date` (string)
    Start date timestamp of policy coverage

  - `insurance_status.coverage_period.end_date` (string)
    End date timestamp of policy coverage

  - `insurance_status.policy_holders` (array)
    List of policy holders

  - `insurance_status.policy_holders.name` (string)
    Name of the policy holder

  - `insurance_status.policy_holders.phone_number` (string)
    Phone number of the policy holder

  - `insurance_status.policy_holders.address` (object)
    Address of the policy holder

  - `insurance_status.policy_holders.address.addr1` (string)
    Address Line 1

  - `insurance_status.policy_holders.address.addr2` (string)
    Address Line 2

  - `insurance_status.policy_holders.address.city` (string)
    City

  - `insurance_status.policy_holders.address.state` (string)
    State

  - `insurance_status.policy_holders.address.zipcode` (string)
    Zipcode

  - `insurance_status.policy_holders.address.country` (object)
    Country details

  - `insurance_status.policy_holders.address.country.name` (string)
    Country name

  - `insurance_status.policy_holders.address.country.a2_code` (string)
    Alpha-2 code of country

  - `insurance_status.insurance_provider` (object)
    Details of insurance provider

  - `insurance_status.insurance_provider.name` (string)
    Name of the insurance provider

  - `insurance_status.insurance_provider.phone_number` (string)
    Phone number of the insurance provider

  - `insurance_status.insurance_provider.address` (object)
    Address of the insurance holder

  - `insurance_status.policy_types` (array)
    Type of Policy
    Enum: "AUTO", "HOME", "RENTERS", "PERSONAL_UMBRELLA"

  - `insurance_status.reference_items` (array)
    Array of item ids used for determining the insurance details.

  - `insurance_status.reason_codes` (array)
    Array of reason codes used for determining the insurance details. Helps developer understand how has the insurance details been derived.

  - `insurance_status.reason_codes.code` (string)
    Reason code applicable

  - `insurance_status.reason_codes.description` (string)
    Description providing details to understand how has the insurance details been derived.

  - `transaction_id` (string)
    Unique ID of this transaction

## Response 401 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 404 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 405 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds
    Example: 1655227025839

  - `error_code` (string)
    MeasureOne Error code
    Example: "METHOD_NOT_ALLOWED"

  - `error_message` (string)
    Details of the error
    Example: "Given Method not allowed"

  - `http_code` (number)
    Example: 405

## Response 409 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds
    Example: 1655227025839

  - `http_code` (number)
    Error status code
    Example: 409

  - `error_code` (string)
    MeasureOne Error code
    Example: "MULTIPLE_REPORT_INSTANCES"

  - `error_message` (string)
    Details of the error
    Example: "Multiple instances of the report INSURANCE_STATUS found in the Data Request. Please provide params/metadata in request"

## Response 422 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

  - `reason_codes` (array)
    List of reason codes. Helps developer understand what error occurred during processing an item.

  - `reason_codes.code` (string)
    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.

  - `reason_codes.description` (string)
    Description providing details to understand what error occurred during processing an item.

  - `reason_codes.context` (object)
    Context to understand where the reason code is applicable

  - `reason_codes.context.items` (array)
    List of Items where the reason code is applicable

## Response 500 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error