# Ping Data Intelligence API

## Docs

- [Command-line Tools](https://docs.pingintel.com/command-line-tools.md)
- [Data Integrations](https://docs.pingintel.com/integrations.md)
- [Introduction](https://docs.pingintel.com/introduction.md): Ping API Documentation
- [Buildings Attributes](https://docs.pingintel.com/json-formats/buildings.md)
- [Computed Policy Terms Attributes](https://docs.pingintel.com/json-formats/computed-policy-terms.md)
- [Layer Terms Attributes](https://docs.pingintel.com/json-formats/layer-terms.md)
- [Perils Terms Attributes](https://docs.pingintel.com/json-formats/peril-terms.md)
- [Top-Level Attributes](https://docs.pingintel.com/json-formats/top-level.md)
- [Underwriting Rules Attributes](https://docs.pingintel.com/json-formats/uw-rules.md)
- [Zone Terms Attributes](https://docs.pingintel.com/json-formats/zone-terms.md)
- [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 reponse to the [enhance location](#tag/api/operation/api_v1_enhance_location) endpoint.
- [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.
- [Enhance Location](https://docs.pingintel.com/ping-data/enhance/enhance-location.md): Request data from multiple sources for a single location, synchronously.
- [Fetch Building](https://docs.pingintel.com/ping-extraction/get-sov-data/fetch-building.md): Retrieve a specific building.
- [Get Historical SOV](https://docs.pingintel.com/ping-extraction/get-sov-data/get-historical-sov.md): Get a specific historical SOV by its ID.
- [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.
- [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`. User must have permission to view the `sovid`.
- [List Historical SOVs](https://docs.pingintel.com/ping-extraction/get-sov-data/list-historical-sovs.md): List historical completed/failed SOVs and their updates in time order. Intended primarily to poll periodically for ETL/archival purposes, to stay up-to-date with all transactions.
- [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.
- [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.
- [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.
- [Add Building](https://docs.pingintel.com/ping-extraction/update-sovs/add-building.md): Adds a building as an annotation to an existing SOV.
- [Add Locations to SOV Update Job](https://docs.pingintel.com/ping-extraction/update-sovs/add-locations-to-sov-update-job.md)
- [Check SOV Update Status](https://docs.pingintel.com/ping-extraction/update-sovs/check-sov-update-status.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.
- [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.`
- [Start SOV Update Job](https://docs.pingintel.com/ping-extraction/update-sovs/start-sov-update-job.md)
- [Initiate New Submission](https://docs.pingintel.com/ping-vision/create-submission/initiate-new-submission.md): Initiate a new submission for processing. Supports sending in one or multiple documents at once, or a single .eml file.
- [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/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.
- [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…
- [Get Current User Info](https://docs.pingintel.com/ping-vision/miscellaneous/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/miscellaneous/get-sitewide-user-settings.md): Get PingVision API settings for the authenticated user.
- [List Submission Statuses](https://docs.pingintel.com/ping-vision/miscellaneous/list-submission-statuses.md): List all submission statuses available for a given division.
- [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.
- [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.
- [Change Submission Status](https://docs.pingintel.com/ping-vision/update-submission/change-submission-status.md): Change the workflow status of a submission.
- [Parse Documents via SOV Fixer](https://docs.pingintel.com/ping-vision/update-submission/parse-documents-via-sov-fixer.md): Send attached documents to SOV Fixer for parsing.
- [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.
- [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.
- [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.
- [Add Permission for User](https://docs.pingintel.com/ping-vision/user-memberships/add-permission-for-user.md): Create a new user membership for the authenticated user. Supply exactly one of company, division, or team, along with the desired role.
- [Add Temporary Membership](https://docs.pingintel.com/ping-vision/user-memberships/add-temporary-membership.md): Add a temporary membership override for the authenticated user. While any temporary memberships exist, normal memberships are ignored. Requires can_view_all_teams privilege. Usually only applicable to testing.
- [Clear Temporary Memberships](https://docs.pingintel.com/ping-vision/user-memberships/clear-temporary-memberships.md): Delete all temporary membership overrides for the authenticated user, restoring normal membership. Requires can_view_all_teams privilege. Usually only applicable to testing.
- [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 interited by teams.
- [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.
- [Remove User Permission](https://docs.pingintel.com/ping-vision/user-memberships/remove-user-permission.md): Delete a user membership by ID.
- [Getting Started](https://docs.pingintel.com/quickstart.md): Get started with Ping APIs
- [Contact Us](https://docs.pingintel.com/support.md)
- [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
- [Process an SOV](https://docs.pingintel.com/workflows/ping-extraction/parse-sov.md): Example workflow for submitting an SOV via the **Ping.Extraction** 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
- [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

## OpenAPI Specs

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