> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rial.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get optional damage localization results

> Read optional damage locations on your inspection photos and their processing status.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/verifications/{id}/damage-localization
openapi: 3.1.0
info:
  title: rial API
  version: 0.1.0
  description: 'Prove a photo is real. Base URL: https://api.rial.io'
  contact:
    name: rial-platform team
    url: https://github.com/Rial-ventures-Inc/rial-platform
  license:
    name: UNLICENSED — proprietary, internal use only
servers:
  - url: https://api.rial.io
    description: Production
security: []
tags:
  - name: Verifications
    description: >-
      Create, fetch, list, and finalize verifications. The core of the API —
      every tenant integration starts here.
  - name: Templates
    description: >-
      Publish, update, revoke and inspect link templates — the reusable capture
      links behind `/l/{token}` (a compact JWT carrying the org and template
      slugs; the legacy `/l/{org}/{slug}` keeps resolving). Callable with a
      secret key; each publish snapshots a versioned capture spec (GET-83).
  - name: Databases
    description: >-
      Create, update, inspect and synchronize tenant-scoped databases used by
      reusable verification templates. Callable with a dashboard session or
      secret API key.
  - name: Credits
    description: >-
      Prepaid photo credits at US$0.20 a photo, bought in packs by an agent with
      the card a person saved, under a monthly spend cap. While credits remain,
      Pro features are on. Callable with a dashboard session or secret API key.
paths:
  /v1/verifications/{id}/damage-localization:
    get:
      tags:
        - Verifications
      summary: Get optional damage localization results
      description: >-
        Read optional damage locations on your inspection photos and their
        processing status.
      parameters:
        - schema:
            type: string
            pattern: ^vfy_[0-9A-HJKMNP-TV-Z]{26}$
            description: ULID with `vfy_` prefix.
            example: vfy_01HXYZABCDEFGHJKMNPQRSTVWX
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Capability state and per-photo jobs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                  jobs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        capture_id:
                          type: string
                        status:
                          type: string
                          enum:
                            - queued
                            - running
                            - retry_wait
                            - completed
                            - failed
                            - cancelled
                        attempts:
                          type: integer
                          minimum: 0
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        next_attempt_at:
                          type: string
                        result:
                          type: object
                          properties:
                            outcome:
                              type: string
                              enum:
                                - localized
                                - no_damage
                                - not_localizable
                            explanation:
                              type: string
                              minLength: 1
                              maxLength: 2000
                            unusable:
                              type: string
                              enum:
                                - no_vehicle
                                - blurry
                            regions:
                              type: array
                              items:
                                type: object
                                properties:
                                  aspect:
                                    type: string
                                    minLength: 1
                                    maxLength: 200
                                  evidence:
                                    type: string
                                    minLength: 1
                                    maxLength: 2000
                                  box:
                                    type: object
                                    properties:
                                      x:
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                      'y':
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                      width:
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                        exclusiveMinimum: 0
                                      height:
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                        exclusiveMinimum: 0
                                    required:
                                      - x
                                      - 'y'
                                      - width
                                      - height
                                  types:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - scratch_scuff
                                        - dent_ding_crease
                                        - crack
                                        - broken
                                        - missing_part
                                        - oxidation_corrosion
                                        - part_misalignment
                                        - paint_burn_peeling
                                        - water_infiltration
                                        - puncture_hole
                                        - poorly_repaired
                                        - paint_blistering
                                        - heat_deformation
                                        - bent_wheel
                                    minItems: 1
                                    maxItems: 6
                                  part:
                                    type: string
                                    enum:
                                      - front_bumper
                                      - rear_bumper
                                      - hood
                                      - trunk_lid
                                      - roof
                                      - grille
                                      - front_door_left
                                      - front_door_right
                                      - rear_door_left
                                      - rear_door_right
                                      - front_fender_left
                                      - front_fender_right
                                      - rear_quarter_panel_left
                                      - rear_quarter_panel_right
                                      - rocker_panel_left
                                      - rocker_panel_right
                                      - a_pillar
                                      - b_pillar
                                      - c_pillar
                                      - headlight_left
                                      - headlight_right
                                      - taillight_left
                                      - taillight_right
                                      - fog_light
                                      - side_marker_light
                                      - windshield
                                      - rear_window
                                      - side_window
                                      - sunroof
                                      - side_mirror_left
                                      - side_mirror_right
                                      - wheel_rim_front_left
                                      - wheel_rim_front_right
                                      - wheel_rim_rear_left
                                      - wheel_rim_rear_right
                                      - tire_front_left
                                      - tire_front_right
                                      - tire_rear_left
                                      - tire_rear_right
                                      - license_plate
                                      - trim_molding
                                      - underbody
                                      - interior
                                      - other
                                  location:
                                    type: string
                                    minLength: 1
                                    maxLength: 200
                                  severity:
                                    type: string
                                    enum:
                                      - minor
                                      - moderate
                                      - severe
                                  action:
                                    type: string
                                    enum:
                                      - none_cosmetic
                                      - polish_buff
                                      - paintless_dent_repair
                                      - repair_and_refinish
                                      - replace
                                  size:
                                    type: object
                                    properties:
                                      length:
                                        type: number
                                        exclusiveMinimum: 0
                                        maximum: 1000
                                      width:
                                        type: number
                                        exclusiveMinimum: 0
                                        maximum: 1000
                                      unit:
                                        type: string
                                        enum:
                                          - cm
                                    required:
                                      - length
                                      - width
                                      - unit
                                required:
                                  - aspect
                                  - evidence
                                  - box
                              maxItems: 20
                          required:
                            - outcome
                            - regions
                        error:
                          type: string
                      required:
                        - id
                        - capture_id
                        - status
                        - attempts
                        - created_at
                        - updated_at
                required:
                  - enabled
                  - jobs
              example:
                enabled: false
                jobs: []
        '401':
          description: Authentication required.
        '404':
          description: Verification not found.
        '503':
          description: Result storage temporarily unavailable.
      security:
        - bearerApiKey: []
components:
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: rk_secret_<key>
      description: >-
        Secret API key, created in the dashboard under Settings → API. Send it
        as `Authorization: Bearer rk_secret_…` from your server only.
        Publishable keys (`pk_live_…`) are for the native SDKs and reach the
        capture endpoints alone. An unknown key returns 401.

````

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