# Ping Intel API

- [Introduction](https://docs.pingintel.com/introduction.md): Ping API Documentation
- [Getting Started](https://docs.pingintel.com/quickstart.md): Get started with Ping APIs
- [Concepts & Identifiers](https://docs.pingintel.com/concepts-and-identifiers.md): Shared terms and identifiers used across the Ping APIs
- [Command-line Tools](https://docs.pingintel.com/command-line-tools.md)
- [Overview](https://docs.pingintel.com/integrations.md)
- [Base Output Attributes](https://docs.pingintel.com/base-output-attributes.md)
- [Ping Geocoding](https://docs.pingintel.com/ping-geocoding.md)
- [Ping Hazard v1](https://docs.pingintel.com/ping-hazard-v1.md)
- [Ping Hazard v2](https://docs.pingintel.com/ping-hazard-v2.md)
- [Property Guardian Wildfire Resiliency Score](https://docs.pingintel.com/property-guardian-wildfire-resiliency-score.md)
- [Property Guardian Wildfire Recurrence Scores](https://docs.pingintel.com/property-guardian-wildfire-recurrence-scores.md)
- [Property Guardian Wildfire Moratorium Insights](https://docs.pingintel.com/property-guardian-wildfire-moratorium-insights.md)
- [First Street Fire Factor](https://docs.pingintel.com/first-street-wildfire.md)
- [Terrafuse AI Wildfire Risk Score](https://docs.pingintel.com/terrafuse-wildfire-likelihood.md)
- [e2Value Pronto Lite Commercial](https://docs.pingintel.com/e2value-pronto-lite-commercial.md)
- [e2Value Pronto Lite Residential](https://docs.pingintel.com/e2value-pronto-lite-residential.md)
- [OFAC Sanctions Screening](https://docs.pingintel.com/ofac-api.md)
- [Top-Level Attributes](https://docs.pingintel.com/json-formats/top-level.md)
- [Buildings Attributes](https://docs.pingintel.com/json-formats/buildings.md)
- [Underwriting Rules Attributes](https://docs.pingintel.com/json-formats/uw-rules.md)
- [Computed Policy Terms Attributes](https://docs.pingintel.com/json-formats/computed-policy-terms.md)
- [Peril Terms Attributes](https://docs.pingintel.com/json-formats/peril-terms.md)
- [Layer Terms Attributes](https://docs.pingintel.com/json-formats/layer-terms.md)
- [Zone Terms Attributes](https://docs.pingintel.com/json-formats/zone-terms.md)
- [How Ping Processes SOVs](https://docs.pingintel.com/how-ping-processes-sovs.md): High-level behavior of SOV processing in **Ping.Extraction**
- [Output Formats](https://docs.pingintel.com/output-formats.md): The output formats Ping.Extraction can generate from a parsed SOV
- [Process an SOV](https://docs.pingintel.com/workflows/ping-extraction/parse-sov.md): Example workflow for submitting an SOV via the **Ping.Extraction** API
- [Update an SOV](https://docs.pingintel.com/workflows/ping-extraction/update-sov.md): Example workflow for updating an existing SOV via the **Ping.Extraction** API
- [Get or Create an SOV Output](https://docs.pingintel.com/workflows/ping-extraction/get-or-create-output.md): Example workflow for requesting an additional output format from an existing SOV via the **Ping.Extraction** API
- [Monitor SOV Activity](https://docs.pingintel.com/workflows/ping-extraction/monitor-sov-activity.md): Example workflow for tracking every new SOV and SOV Update across an account via the **Ping.Extraction** API
- [Build an SOV Pipeline](https://docs.pingintel.com/workflows/ping-extraction/build-sov-pipeline.md): End-to-end example workflow: submit SOVs, monitor processing, and fetch outputs via the **Ping.Extraction** API
- [Start SOV Parsing Job](https://docs.pingintel.com/ping-extraction/parse-sovs/start-sov-parsing-job.md): Submit an Excel file to be parsed as an SOV.
- [Check SOV Parsing Status](https://docs.pingintel.com/ping-extraction/parse-sovs/check-sov-parsing-status.md): Check the status of a SOV parsing request. Returns status of the parsing job, and, when complete, provides links to the output documents.
- [Fetch Outputs of SOV Parsing Job](https://docs.pingintel.com/ping-extraction/parse-sovs/fetch-outputs-of-sov-parsing-job.md)
- [Get/Check SOV Output Result](https://docs.pingintel.com/ping-extraction/parse-sovs/getcheck-sov-output-result.md): Get the status of a SOV output request, and the result if it is complete.
- [Fetch Building](https://docs.pingintel.com/ping-extraction/get-sov-data/fetch-building.md): Retrieve a specific building.
- [List Available Output Formats](https://docs.pingintel.com/ping-extraction/get-sov-data/list-available-output-formats.md): Returns the list of output formats available for the given context. Provide one of `sovid`, `division_uuid`, or `team_uuid` to scope the results; if none are provided, the requesting user's default team/division is used. Precedence: sovid > division_uuid > team_uuid > user default.
- [Get Public Shareable URL](https://docs.pingintel.com/ping-extraction/get-sov-data/get-public-shareable-url.md): Returns a publicly shareable URL for the map associated with the provided `sovid` or `pingid`.
- [Get Or Create SOV Output](https://docs.pingintel.com/ping-extraction/get-sov-data/get-or-create-sov-output.md): If an output file is already available, it will be returned. If not, a new output file will be generated and an id will be provided to check the status.
- [List SOV Activity](https://docs.pingintel.com/ping-extraction/get-sov-data/list-sov-activity.md): Fetch a list of the most recent SOV Fixer activity. If desired, the returned `fields` can be configured and the responses can be filtered by `status`, `origin`, etc.
- [List Historical SOVs](https://docs.pingintel.com/ping-extraction/get-sov-data/list-historical-sovs.md): List completed and failed SOVs and SOV Update Data (SUD) in chronological order. Supply `start` to begin at a specific timestamp. Pass the returned `cursor_id` in each subsequent request to page through results. Intended for periodic polling to stay current with all processed submissions.
- [Get Historical SOV](https://docs.pingintel.com/ping-extraction/get-sov-data/get-historical-sov.md): Retrieve details and output files for a specific SOV or SOV Update Data (SUD). Pass the `id` returned by List Historical SOVs. The response includes output `url` values you can use to download each generated file.
- [Add Building](https://docs.pingintel.com/ping-extraction/update-sovs/add-building.md): Adds a building as an annotation to an existing SOV.
- [Initiate SOV Update Job](https://docs.pingintel.com/ping-extraction/update-sovs/initiate-sov-update-job.md): Updates an SOV, it should be followed by some `/sov/update/{id}/add_locations` calls followed by `/sov/update/{id}/start.`
- [Check SOV Update Status](https://docs.pingintel.com/ping-extraction/update-sovs/check-sov-update-status.md)
- [Add Locations to SOV Update Job](https://docs.pingintel.com/ping-extraction/update-sovs/add-locations-to-sov-update-job.md)
- [Start SOV Update Job](https://docs.pingintel.com/ping-extraction/update-sovs/start-sov-update-job.md)
- [Create New Submission](https://docs.pingintel.com/ping-extraction/update-sovs/create-new-submission.md): Create a new, empty submission instance. Then, populate via add_locations then /start.
- [Enhance Multiple Locations](https://docs.pingintel.com/workflows/ping-data/bulk-enhance.md): Example workflow for submitting a Bulk Enhance request via the **Ping.Data** API
- [Enhance One Location](https://docs.pingintel.com/workflows/ping-data/enhance-location.md): Example for enhancing a single location via the **Ping.Data** API
- [Enhance Location](https://docs.pingintel.com/ping-data/enhance/enhance-location.md): Request data from multiple sources for a single location, synchronously.
- [Start Bulk Enhance Job](https://docs.pingintel.com/ping-data/bulk-enhance/start-bulk-enhance-job.md): Enhance a list of locations with additional data.
- [Check Bulk Enhance Job Status](https://docs.pingintel.com/ping-data/bulk-enhance/check-bulk-enhance-job-status.md): Check the status of a data request. Returns status, and, when complete, provides links to the requested data.
- [Fetch Bulk Enhance Job Result Data](https://docs.pingintel.com/ping-data/bulk-enhance/fetch-bulk-enhance-job-result-data.md): Download outputs of a bulk enhance request. For documentation of the contents of the file, see the response to the [enhance location](#tag/api/operation/api_v1_enhance_location) endpoint.
- [List Datasources](https://docs.pingintel.com/ping-data/reference-data/list-datasources.md): Returns datasource configurations the user has access to.
- [Get Datasource](https://docs.pingintel.com/ping-data/reference-data/get-datasource.md): Returns a datasource configuration for the requested datasource code.
- [Get Source Access Policy](https://docs.pingintel.com/ping-data/account/get-source-access-policy.md): Returns the effective source access policy for a user or organization. The policy has two facets:
- [Get Usage](https://docs.pingintel.com/ping-data/account/get-usage.md): Returns API credit usage over a time range, broken down by data source and time bucket.
- [Send and Track SOV Submission](https://docs.pingintel.com/workflows/ping-vision/send-and-track-submission.md): Example workflow for submitting and tracking an SOV via the **Ping.Vision** API
- [How to: Integrate an External System](https://docs.pingintel.com/workflows/ping-vision/clear-and-triage.md): Example workflow for processing a submission via the **Ping.Vision** API
- [List Recent Submission Activity](https://docs.pingintel.com/ping-vision/get-submission-data/list-recent-submission-activity.md): Fetch a list of the most recent submission activity.  If desired, the returned `fields` can be configured and the responses can be filtered by `status`, `origin`, etc.
- [List Submission Events](https://docs.pingintel.com/ping-vision/get-submission-data/list-submission-events.md): List submission events since a `start` time or since the last `cursor_id`, in ascending time order, filtered by team, division, or pingid. Intended primarily for system-to-system periodic polling to stay up-to-date with all events, to keep systems in sync. Events include status changes (event_type=S…
- [Download Submission Document](https://docs.pingintel.com/ping-vision/get-submission-data/download-submission-document.md): Download submission document specified by `filename`.
- [Get Or Create Submission Output](https://docs.pingintel.com/ping-vision/get-submission-data/get-or-create-submission-output.md): If an output file is already available, it will be returned. If not, a new output file will be generated and an id will be provided to check the status.
- [Get Submission Details](https://docs.pingintel.com/ping-vision/get-submission-data/get-submission-details.md): Retrieve a single submission by pingid. Accepts params for field selection and other inclusions.Behaves much like `GET /v1/submission`, excluding parameters that only apply to multi-result pages and filtering.(cursor_id, page_size, sort_by, sort_order).
- [Get/Check Submission Output Result](https://docs.pingintel.com/ping-vision/get-submission-data/getcheck-submission-output-result.md): Get the status of a submission output request, and the result if it is complete.
- [Initiate New Submission](https://docs.pingintel.com/ping-vision/create-submission/initiate-new-submission.md): Initiate a new submission for processing. Supply a single email file (.eml or .msg) to process its attachments, or one or more documents directly, such as Excel SOV workbooks, ACORD forms, loss runs, and supporting PDFs.
- [Update Submission Document Details](https://docs.pingintel.com/ping-vision/update-submission/update-submission-document-details.md): Update details of a submission document, such as renaming, changing type, or archiving.
- [Update Submission Details](https://docs.pingintel.com/ping-vision/update-submission/update-submission-details.md): Update properties of the submission. If you want to change the claimant or the workflow status, use v1/submission/bulkupdate instead.
- [Attach Document to Submission](https://docs.pingintel.com/ping-vision/update-submission/attach-document-to-submission.md): Upload an additional document to attach to a submission.
- [Parse Documents via Ping.Extraction](https://docs.pingintel.com/ping-vision/update-submission/parse-documents-via-pingextraction.md): Send attached documents to Ping.Extraction for parsing.
- [Transfer Document from FTP to Submission](https://docs.pingintel.com/ping-vision/update-submission/transfer-document-from-ftp-to-submission.md): Download a file from FTP/SFTP and attach it to the submission. Synchronous by default; pass "async": true to queue it and poll via transfer-status.
- [Get Transfer Status](https://docs.pingintel.com/ping-vision/update-submission/get-transfer-status.md): Poll the status of an asynchronously queued SFTP transfer, in either direction. Accepts the task_id returned by both the transfer-to-ftp and transfer-from-ftp endpoints.
- [Transfer Document to FTP](https://docs.pingintel.com/ping-vision/update-submission/transfer-document-to-ftp.md): Upload a submission document to FTP/SFTP. Synchronous by default; pass "async": true to queue it and poll via transfer-status.
- [Store Additional Data on Submission](https://docs.pingintel.com/ping-vision/update-submission/store-additional-data-on-submission.md): Store arbitrary custom tags on the submission. This is useful for storing additional information that is not part of the standard submission data structure.
- [Change Submission Status](https://docs.pingintel.com/ping-vision/update-submission/change-submission-status.md): Change the workflow status of a submission.
- [Action Submission(s)](https://docs.pingintel.com/ping-vision/update-submission/action-submissions.md): Provide a list of changes to transition ("change_status") or assign ("claim") one or multiple submissions.
- [Generate Acc/Loc Files](https://docs.pingintel.com/ping-vision/cat-modeling/generate-accloc-files.md): Kicks off an asynchronous job to generate files. Poll the <a href="accloc-file-status">Acc/Loc File Status</a> endpoint to check progress and retrieve download URLs.
- [Acc/Loc File Status](https://docs.pingintel.com/ping-vision/cat-modeling/accloc-file-status.md): Returns the current status of an acc/loc file generation job and download URLs for completed files.
- [List Coverage Options](https://docs.pingintel.com/ping-vision/cat-modeling/list-coverage-options.md): Lists all of the coverage options for a submission.
- [Create Coverage Option](https://docs.pingintel.com/ping-vision/cat-modeling/create-coverage-option.md): Creates a new, empty coverage option for the submission, pre-populated with the default peril sections/groups/subperils and zones for the submission's policy terms configuration.
- [Get Coverage Option](https://docs.pingintel.com/ping-vision/cat-modeling/get-coverage-option.md): Returns the raw, editable term structure for a coverage option: its peril sections, peril groups (with their subperils), and per-zone terms, along with the `policy_terms_config` that controls which of those term fields are editable/visible for this coverage option's outputter.
- [Delete Coverage Option](https://docs.pingintel.com/ping-vision/cat-modeling/delete-coverage-option.md): Permanently deletes a coverage option, along with its peril sections/groups/subperils and zones.
- [Update Coverage Option](https://docs.pingintel.com/ping-vision/cat-modeling/update-coverage-option.md): Updates the details of a coverage option.
- [Duplicate Coverage Option](https://docs.pingintel.com/ping-vision/cat-modeling/duplicate-coverage-option.md): Creates a full copy of a coverage option, including its peril sections, peril groups, subperils, and zones. The new coverage option inherits the same `policy_terms_config` as the source.
- [Move subperil](https://docs.pingintel.com/ping-vision/cat-modeling/move-subperil.md): Moves a subperil from its current peril group to `group_uuid` on the same coverage option. `group_uuid` is required and must reference a peril group that the subperil is allowed to join (per its `allowed_peril_groups`); a mismatch returns a validation error. Returns the coverage option's full detail…
- [Create Peril Group](https://docs.pingintel.com/ping-vision/cat-modeling/create-peril-group.md): Creates a new, user-created peril group on a coverage option. `group_label` must be a label that at least one subperil on this coverage option allows via `allowed_peril_groups`, and must not already be in use — see <a href="#tag/CAT/operation/api_v1_internal_submissions_coverage_options_available_gr…
- [Update Peril Group](https://docs.pingintel.com/ping-vision/cat-modeling/update-peril-group.md): Updates a peril group's terms. `is_deductible_combined` and `is_sublimit_combined` can only be changed when `is_bi_split_allowed=true`; switching either toggles which deductible/sublimit fields (combined `min_deductible`/`max_deductible`/`sublimit` vs. split `pd_*`/`bi_*` variants) are accepted on s…
- [List Available Peril Groups](https://docs.pingintel.com/ping-vision/cat-modeling/list-available-peril-groups.md): Returns the group labels that are valid to create a new peril group with on this coverage option (i.e. labels allowed by at least one subperil's `allowed_peril_groups` that are not already in use by an existing peril group). Use with <a href="#tag/CAT/operation/api_v1_internal_submissions_coverage_o…
- [Update Subperil](https://docs.pingintel.com/ping-vision/cat-modeling/update-subperil.md): Sets whether a subperil is included in coverage. Excluded subperils are dropped from the peril group's coverage and reported in `excluded_subperil_types` on export endpoints.
- [Get Coverage Option Validations](https://docs.pingintel.com/ping-vision/cat-modeling/get-coverage-option-validations.md): Returns validation errors for a coverage option (only errors are reported; warnings are not surfaced here). When the coverage option is valid, `validations` is an empty list. When it is invalid, `validations` is instead an object keyed by what the error affects (`peril_group`, `zone`, or `coverage_o…
- [Update Zone Terms](https://docs.pingintel.com/ping-vision/cat-modeling/update-zone-terms.md): Updates the terms for a single zone (e.g. `CA`, `Tier1`, `AllOther`) within a coverage option's peril class. `peril_group` links the zone to the peril group whose subperils it applies to; pass its `uuid`, or `null` to clear the association.
- [Update Coverage Option with Terms](https://docs.pingintel.com/ping-vision/cat-modeling/update-coverage-option-with-terms.md): Replaces a coverage option's own fields, its peril group terms (including each group's subperils) and its per-zone terms in a single request. The body is the coverage option's complete state:
- [List Layer Structures](https://docs.pingintel.com/ping-vision/cat-modeling/list-layer-structures.md): Lists all of the layer structures for a submission. Pass `include_layers=true` to also include each structure's `layers`.
- [Create Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/create-layer-structure.md): Creates a new, empty layer structure (a named group of layers/towers) for the submission. If `name` is omitted, it defaults to `Group N` for the next available `N`; if the resulting name is already in use on this submission, a numeric suffix is appended.
- [Get Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/get-layer-structure.md): Returns a layer structure along with its full ordered list of layers.
- [Delete Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/delete-layer-structure.md): Permanently deletes a layer structure and all of its layers.
- [Update Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/update-layer-structure.md): Renames a layer structure. The new name must be unique on the submission.
- [Duplicate Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/duplicate-layer-structure.md): Creates a full copy of a layer structure, including all of its layers. If `name` is omitted, the source's name is reused; if that name is already in use on this submission, a numeric suffix is appended (e.g. `Structure 1 2`).
- [Create Layer](https://docs.pingintel.com/ping-vision/cat-modeling/create-layer.md): Adds a new layer to a layer structure. If `name` is omitted, it is auto-generated from `attachment`/`limit` (e.g. `10x25`, `Primary 25`, `Ground Up`), with a numeric suffix appended if that name is already used within the structure. `participation_amount` cannot be set directly; only `participation_…
- [Delete Layer](https://docs.pingintel.com/ping-vision/cat-modeling/delete-layer.md): Permanently deletes a single layer from a layer structure.
- [Get Layer](https://docs.pingintel.com/ping-vision/cat-modeling/get-layer.md): Updates a layer's terms. If `name` was auto-generated (i.e. never explicitly set) and `attachment`/`limit` change, the name is regenerated to match; an explicitly-set name is left untouched unless a new `name` is provided.
- [Create Layer Structure with Layers](https://docs.pingintel.com/ping-vision/cat-modeling/create-layer-structure-with-layers.md): Creates a layer structure and all of its layers in a single request. `name` is required and must be unique across the submission. Every entry in `layers` must carry its own `name` too — unlike the single-layer create endpoint, this one never auto-generates a name from `attachment`/`limit` — and two…
- [Update Layer Structure with Layers](https://docs.pingintel.com/ping-vision/cat-modeling/update-layer-structure-with-layers.md): Replaces a layer structure and its layers outright. The body is the structure's complete state, so `name` and `layers` are both required, and every layer entry needs its own `name`; any term an entry leaves out is reset to its default rather than carried over from the layer's current values.
- [Get Layer Validations](https://docs.pingintel.com/ping-vision/cat-modeling/get-layer-validations.md): Returns validation errors for all layer structures on a submission (only errors are reported; warnings are not surfaced here). When all layers are valid, `validations` is an empty list. When any layer is invalid, `validations` is instead an object keyed by `layer` (the only affected entity type for…
- [Export Modeling Options](https://docs.pingintel.com/ping-vision/cat-modeling/export-modeling-options.md): Returns all valid modeling options for the submission. Each entry includes the full coverage option (with peril and zone terms) and the layers selected for modeling. Any coverage options that have validation errors will be excluded from the response.
- [Modeling Option - Add Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/modeling-option--add-layer-structure.md): Associates one or more coverage options with **every layer** in the given layer structure. Equivalent to calling the per-layer add endpoint for each layer individually. If a modeling option for a coverage option does not yet exist, it is created automatically. Idempotent — layers that already have t…
- [Modeling Option - Remove Layer Structure](https://docs.pingintel.com/ping-vision/cat-modeling/modeling-option--remove-layer-structure.md): Removes one or more coverage options from a layer structure entirely, deleting the underlying modeling option records. If no modeling option exists for a coverage option, the request is a no-op for that entry.
- [Modeling Option - Add Layer](https://docs.pingintel.com/ping-vision/cat-modeling/modeling-option--add-layer.md): Associates one or more coverage options with a specific layer for modeling. If a modeling option for a coverage option does not yet exist under the layer's structure, it is created automatically. Idempotent — calling this when the coverage option is already on the layer has no effect.
- [Modeling Option - Remove Layer](https://docs.pingintel.com/ping-vision/cat-modeling/modeling-option--remove-layer.md): Removes one or more coverage options from a specific layer. If removing a layer leaves a modeling option with no layers, the modeling option is deleted. If no modeling option exists for a coverage option, the request is a no-op for that entry.
- [List User Memberships](https://docs.pingintel.com/ping-vision/user-memberships/list-user-memberships.md): List all company, division, or user memberships for the authenticated user. Memberships at the company level will be inherited by division and teams, and memberships at the division level will be inherited by teams.
- [Add Permission for User](https://docs.pingintel.com/ping-vision/user-memberships/add-permission-for-user.md): Create a new user membership. Supply exactly one of company_uuid, division_uuid, or team_uuid, along with the desired membership_type (defaults to 'member').
- [Remove User Permission](https://docs.pingintel.com/ping-vision/user-memberships/remove-user-permission.md): Delete a user membership by ID.
- [List User Teams](https://docs.pingintel.com/ping-vision/user-memberships/list-user-teams.md): Retrieve a list of teams associated with the authenticated user, whether the user is a member directly or a member of the team's division or company.
- [List Submission Statuses](https://docs.pingintel.com/ping-vision/reference-data/list-submission-statuses.md): List all submission statuses available for a given division.
- [Get Current User Info](https://docs.pingintel.com/ping-vision/account/get-current-user-info.md): Get current user info and permissions for the authenticated user.
- [Get Sitewide User Settings](https://docs.pingintel.com/ping-vision/account/get-sitewide-user-settings.md): Get PingVision API settings for the authenticated user.
- [Contact Us](https://docs.pingintel.com/support.md)

## OpenAPI Specs

- [?format=json](https://api.sovfixer.com/api/schema/?format=json)
- [?format=json](https://data-api.sovfixer.com/api/schema/?format=json)
- [?format=json](https://vision.pingintel.com/api/schema/?format=json)
- [package](/package.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.