> ## 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.

# Check Bulk Enhance Job Status

> Check the status of a data request. Returns status, and, when complete, provides links to the requested data.



## OpenAPI

````yaml https://data-api-staging.sovfixer.com/api/schema/?format=json get /api/v1/bulk_enhance/{id}
openapi: 3.0.3
info:
  title: Ping.Data API
  version: v1.0
  description: >
    ### Ping.Data API


    This API provides convenient, efficient access to bulk location data from
    many sources.


    The typical usage flow is:


    * POST to `/api/v1/bulk_enhance`.  The POST body should look like this:

    ``` {
        "locations": [
            {
                "id": "user-id1",
                "address": "1212 Ping Data Lane, Pingville, FL",
                "sources": ["PG", "PH"],
                ...
            },
            ...
        ],
        "timeout": 60.0,
    }

    ```


    * Poll GET `/api/v1/bulk_enhance/{id}`, passing the `id` given by the
    previous response until `response.request.status` is `COMPLETE` or `FAILED`.

    * Download the  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`.


    Output JSON Example:

    ```

    {
      "user-id1": {
        "GG": {
          "is_success": true,
          "error_message": null,
          "confidence": 80,
          "status_code": 200,
          "fetch_time": 4.754,
          "street_number": "1212",
          "route": "Ping Data Ln",
          "location_type": "ROOFTOP",
          "latitude": 28.xxx,
          "longitude": -81.xxx,
          "formatted_address": "1212 Ping Data Lane, Pingville, FL, USA",
          "place_id": "xxx-yyy",
          "address_line_1": "1212 Ping Data Lane",
          "address_line_2": "",
          "city": "Pingville",
          "postal_code": "00010",
          "county": "Pingville",
          "state": "FL",
          "country": "US"
        },
        "HH": {
          "is_success": true,
          "error_message": null,
          "confidence": null,
          "status_code": null,
          "latitude": 28.xxx,
          "longitude": -81.xxx,
          "geocode_type": "ADDRESS",
          "google_maps_link": "https://www.google.com/maps/search/?api=1&query=28.xxx,-81.xxx",
          "fema_flood_zone": "X",
          "elevation": null,
          "bldg_year_built": 2009,
          ... more attributes ...

        }
      },
      ... more buildings ...
    }

    ```
  contact:
    email: support@pingintel.com
    name: Ping Intel
    url: https://www.pingintel.com
servers:
  - url: https://data-api.sovfixer.com
    description: Ping.Data API
  - url: https://data-api-staging.sovfixer.com
    description: Ping.Data API (staging)
security: []
paths:
  /api/v1/bulk_enhance/{id}:
    get:
      tags:
        - Bulk Enhance
      summary: Check Bulk Enhance Job Status
      description: >-
        Check the status of a data request. Returns status, and, when complete,
        provides links to the requested data.
      operationId: api_v1_bulk_enhance_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBulkEnhanceAPIViewResponse'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BEVErrorResponse401'
          description: ''
components:
  schemas:
    GetBulkEnhanceAPIViewResponse:
      type: object
      properties:
        request:
          allOf:
            - $ref: '#/components/schemas/GetBulkEnhanceAPIViewResponseRequest'
          description: Information about the request.
        result:
          allOf:
            - $ref: '#/components/schemas/GetBulkEnhanceAPIViewResponseResponse'
          description: >-
            Result when done processing. This key will be missing until the
            request.status is COMPLETE.
      required:
        - request
    BEVErrorResponse401:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Request ID
        message:
          type: string
          description: Authorization error message
      required:
        - id
        - message
    GetBulkEnhanceAPIViewResponseRequest:
      type: object
      properties:
        completed_at:
          type: string
          format: date-time
          description: Datestamp when processing was complete
        num_canceled:
          type: integer
        num_completed:
          type: integer
        num_problems:
          type: integer
        num_requested:
          type: integer
        progress_started_at:
          type: string
          format: date-time
          description: Datestamp when task came off queue and began processing
        requested_at:
          type: string
          format: date-time
          description: Time when it was requested
        status:
          enum:
            - PENDING
            - QUEUED
            - IN_PROGRESS
            - COMPLETE
            - FAILED
          type: string
          x-spec-enum-id: 90f97acf01bb3f18
          description: Request status.
      required:
        - completed_at
        - num_canceled
        - num_completed
        - num_problems
        - num_requested
        - progress_started_at
        - requested_at
        - status
    GetBulkEnhanceAPIViewResponseResponse:
      type: object
      properties:
        message:
          type: string
          description: Result status message.
        outputs:
          allOf:
            - $ref: '#/components/schemas/GetBulkEnhanceAPIViewResponseOutputs'
          description: Information about result datafiles, including urls to access it.
        sources:
          allOf:
            - $ref: '#/components/schemas/GetBulkEnhanceAPIViewResponseSources'
          description: Statistics about per-source fetching results.
        status:
          enum:
            - SUCCESS
            - FAILED
          type: string
          x-spec-enum-id: ea61713756b69bf1
          description: Result status.
        total_processing_time:
          type: number
          format: double
          description: Total time taken to complete job, in seconds.
      required:
        - message
        - outputs
        - sources
        - status
        - total_processing_time
    GetBulkEnhanceAPIViewResponseOutputs:
      type: object
      properties:
        description:
          type: string
        filename:
          type: string
        url:
          type: string
          format: uri
      required:
        - description
        - filename
        - url
    GetBulkEnhanceAPIViewResponseSources:
      type: object
      properties:
        avg_fetch_duration:
          type: number
          format: double
        max_fetch_duration:
          type: number
          format: double
        min_fetch_duration:
          type: number
          format: double
        num_fails:
          type: integer
        num_fetched:
          type: integer
        num_successes:
          type: integer
        source:
          enum:
            - PG
            - PH
            - LB
          type: string
          x-spec-enum-id: c2bc9488a2e0dec7
        total_fetch_duration:
          type: number
          format: double
      required:
        - avg_fetch_duration
        - max_fetch_duration
        - min_fetch_duration
        - num_fails
        - num_fetched
        - num_successes
        - source
        - total_fetch_duration

````