> ## Documentation Index > Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt > Use this file to discover all available pages before exploring further. # Start SOV Update Job ## OpenAPI ````yaml https://api-staging.sovfixer.com/api/schema/?format=json post /api/v1/sov/update/{id}/start openapi: 3.0.3 info: title: Ping.Extraction API version: v1.0 description: >- ### Ping.Extraction API This API provides an asynchronous method for parsing Excel SOV documents using the Ping Intel SOV Fixer platform. The typical SOV Fixer usage flow is: * POST to `/api/v1/sov` * Poll GET `/api/v1/sov/{id}`, passing the `id` given by the previous response until `response.request.status` is `COMPLETE` or `FAILED`. Depending on load, number of buildings in the SOV, and 3rd party integrations, it may take anywhere from a few seconds to many minutes. * Download the parsed SOV data as JSON from `/api/v1/sov/{id}/output/{filename}`. The exact url comes from the response to the above query, in `response.result.outputs[].url`. API Usage Examples: [Python](/api/v1/sov-api-usage-example.py) | [.NET](/api/v1/sov-api-usage-example.cs) Client Libraries: [Python](https://pypi.org/project/pingintel-api/) #### Authorization Most endpoints are protected by Bearer authentication. Under each endpoint listed below, click into the `authorizations` section to see what is required for that endpoint. #### Output JSON Example: ```json { "id": "s-e-xxxxxxx", "source_filename": "My Example SOV.xls", "num_buildings": 26, "extra_data": { "insured_name": "Joe Insured", "... custom document-level data fields ...": "" }, "buildings": [ { "item_key": "i-s-e-xxxxxxx!Original SOV Sheet!7", "building_counter": 1, "sheet_name": "Original SOV Sheet", "sheet_row_number": 7, "parsing_sheet_name": "Original SOV Sheet", "location_code": { "value": "A-1", "confidence": 0.5, "comment": "Adjusted." }, "bldg_name": { "value": "Elementary School", "confidence": 0.7 }, "street": { "value": "1212 Mockingbird Lane", "confidence": 0.7 }, "city": { "value": "Tewksbury", "confidence": 0.5 }, "state": { "original": "Mass", "value": "MA", "confidence": 0.9 }, "zip": { "value": "01876", "original": 1876, "confidence": 0, "comment": "Please check." }, "... more building attributes ...": "", "external_data": { "PG": { "latitude": 42.6109, "longitude": -71.2342, "confidence": 0.9, "street": "1212 Mockingbird Ln", "city": "Tewksbury", "... rest of the data from the Ping Geocoding (PG) external data source ...": "" }, "... any other requested third party data sources ...": "" }, "extra": { "... columns that were not identified as a standard SOV field ...": "", "Unidentified Column": "123213", "Another Unidentified Column": "abc" } }, "... additional buildings ...": "" ] } ``` Complete JSON reference documentation can be found for each output type: [SOV](/docs/data/SOV/) | [Premium BDX](/docs/data/PREM_BDX/) | [Claim BDX](/docs/data/CLAIM_BDX/). Some notes about specific JSON output fields: * `limits__total_limit`: Contains the TIV if explicitly specified in the SOV. If not, it is summed from the fields `limits__building_limit` + `limits__bpp_limit` + `limits__bi_limit` + `limits__signs_and_other_limit`. * `limits__building_limit`: Building Limit is an aggregate of: * `limits__building_value` * `limits__location_limit` * `limits__blanket_limit` * `limits__building_only_limit` * `limits__real_property_limit` * `limits__structure_limit` * `limits__bpp_limit`: Business Personal Property (Contents) Limit is an aggregate of: * `limits__contents_value` * `limits__contents_limit` * `limits__bpp_value` * `limits__equip_limit` * `limits__personal_property_limit` * Any field identified as a limit field but not otherwise categorized. * `limits__bi_limit`: Business Interruption Limit is an aggregate of: * `limits__bi_value` * `limits__bi_income_limit` * `limits__business_interruption_limit` * `limits__time_element_limit` * `limits__signs_and_other_limit`: Signs and Other Structures Limit is an aggregate of: * `limits__signs_limit` * `limits__other_structures_limit` ### Ping Intel SOV History API This API provides a method for accessing historical SOV submissions including their revisions (SOV Updates) and the raw parsed output. The typical usage workflow is: * GET to `api/v1/sov/history?start={start_timestamp}` for a list of SOVIDs submitted between `start_timestamp` and now. * For each sovid: * GET to `api/v1/sov/history/{id}` to get information about the SOV or SOV Update. This includes any output we produced in servicing the request * GET to the the URL in the outputs dict to download the resource you need. contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://api.sovfixer.com description: Ping.Extraction API - url: https://api-staging.sovfixer.com description: Ping.Extraction API (staging) security: [] paths: /api/v1/sov/update/{id}/start: post: tags: - Update SOVs summary: Start SOV Update Job operationId: sov_update_start_create parameters: - in: path name: id schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SOVUpdateStartRequestRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SOVUpdateStartRequestRequest' multipart/form-data: schema: $ref: '#/components/schemas/SOVUpdateStartRequestRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SOVUpdateStartResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/SOVUpdateStartError400' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/SOVUpdateStartError401' description: '' security: - tokenAuth: [] components: schemas: SOVUpdateStartRequestRequest: type: object properties: extra_data: type: object additionalProperties: type: string minLength: 1 description: Extra data associated with the policy. integrations: type: array items: enum: - PG - PH - PFPC type: string x-spec-enum-id: 7066edafaaede991 description: |- Integration option. * `PG` - PG * `PH` - PH * `PFPC` - PFPC description: >- If set, specifies the desired third-party data source integrations to include in the output. metadata: $ref: '#/components/schemas/MetadataRequest' output_formats: type: array items: enum: - json - pingv2 - amrisc type: string description: |- * `json` - json * `pingv2` - pingv2 * `amrisc` - amrisc x-spec-enum-id: f23d2be1ffe08a2e default: - json description: If set, specifies the desired output format(s). Defaults to JSON. outputter_name: type: string minLength: 1 description: >- Name of the outputter settings to use when generating outputters. This is typically the same as the "Ping Format Name" property of the scrubber. policy_terms: allOf: - $ref: '#/components/schemas/PolicyTermsRequest' description: Policy terms to be used by the outputter. required: - extra_data SOVUpdateStartResponse: type: object properties: message: type: string description: API Message. required: - message SOVUpdateStartError400: type: object properties: message: type: string description: Server error message detail. required: - message SOVUpdateStartError401: type: object properties: detail: type: string description: Authorization error message. required: - detail MetadataRequest: type: object properties: Timestamp: type: integer description: >- Timestamp of the request, in unix time (non-leap seconds since 1970-01-01). UserInfo: $ref: '#/components/schemas/UserInfoRequest' PolicyTermsRequest: type: object properties: excluded_subperil_types: type: array items: enum: - HU_Wind - HU_Surge - HU_PrecipitationFlood - EQ_Shake - EQ_Fire - EQ_Sprinkler - EQ_Landslide - EQ_Tsunami - EQ_Liquefaction - InlandFlood - Wildfire - WinterStorm - SevereConvectiveStorm - Hail - StraightLineWind - Tornado - SevereStorm - Terrorism - NonCat type: string description: |- * `HU_Wind` - HU_Wind * `HU_Surge` - HU_Surge * `HU_PrecipitationFlood` - HU_PrecipitationFlood * `EQ_Shake` - EQ_Shake * `EQ_Fire` - EQ_Fire * `EQ_Sprinkler` - EQ_Sprinkler * `EQ_Landslide` - EQ_Landslide * `EQ_Tsunami` - EQ_Tsunami * `EQ_Liquefaction` - EQ_Liquefaction * `InlandFlood` - InlandFlood * `Wildfire` - Wildfire * `WinterStorm` - WinterStorm * `SevereConvectiveStorm` - SevereConvectiveStorm * `Hail` - Hail * `StraightLineWind` - StraightLineWind * `Tornado` - Tornado * `SevereStorm` - SevereStorm * `Terrorism` - Terrorism * `NonCat` - NonCat x-spec-enum-id: fc871bd96fcd381d layer_terms: type: array items: $ref: '#/components/schemas/LayerTermRequest' peril_terms: type: array items: $ref: '#/components/schemas/PerilTermRequest' zone_terms: type: array items: $ref: '#/components/schemas/PerilTermRequest' UserInfoRequest: type: object properties: UserName: type: string minLength: 1 LayerTermRequest: type: object properties: name: type: string minLength: 1 attachment: type: integer limit: type: integer participation: type: number format: double premium: type: integer required: - name PerilTermRequest: type: object properties: group: type: string minLength: 1 bi_days_deductible: type: integer blanket_deductible: type: integer location_deductible: type: number format: double location_deductible_type: enum: - S - C - CT - CB - PL type: string description: |- * `S` - S * `C` - C * `CT` - CT * `CB` - CB * `PL` - PL x-spec-enum-id: 6259ea0cb1b43bd1 max_deductible: type: integer min_deductible: type: integer sublimit: type: integer subperil_types: type: array items: enum: - HU_Wind - HU_Surge - HU_PrecipitationFlood - EQ_Shake - EQ_Fire - EQ_Sprinkler - EQ_Landslide - EQ_Tsunami - EQ_Liquefaction - InlandFlood - Wildfire - WinterStorm - SevereConvectiveStorm - Hail - StraightLineWind - Tornado - SevereStorm - Terrorism - NonCat type: string description: |- * `HU_Wind` - HU_Wind * `HU_Surge` - HU_Surge * `HU_PrecipitationFlood` - HU_PrecipitationFlood * `EQ_Shake` - EQ_Shake * `EQ_Fire` - EQ_Fire * `EQ_Sprinkler` - EQ_Sprinkler * `EQ_Landslide` - EQ_Landslide * `EQ_Tsunami` - EQ_Tsunami * `EQ_Liquefaction` - EQ_Liquefaction * `InlandFlood` - InlandFlood * `Wildfire` - Wildfire * `WinterStorm` - WinterStorm * `SevereConvectiveStorm` - SevereConvectiveStorm * `Hail` - Hail * `StraightLineWind` - StraightLineWind * `Tornado` - Tornado * `SevereStorm` - SevereStorm * `Terrorism` - Terrorism * `NonCat` - NonCat x-spec-enum-id: fc871bd96fcd381d required: - group securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token" ````