LogoLogo
  • PAVE OpenAPI Overview
  • How PAVE Works
    • Capture Link
    • Guided Capture
    • Customer Disclosures
    • Identified Vehicle Information
    • Captured Photos
    • Text Notifications
    • Inspection Results
    • Condition Report (PDF)
    • Detected Damages
    • Grading
    • Languages
    • Accuracy & Limitations
  • INTEGRATIONS
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • GET Session Data
        • GET Session Photos
        • GET Session Notes
        • GET Session Results
        • PUT Update Session
        • DELETE Session
      • Webhooks
        • GET All Callbacks
        • GET View a Callback
        • POST Create New Callback
        • PUT Update a Callback
        • DELETE a Callback
      • Deep Linking
        • Deep Link with React Native App
        • Deep Link Native App
        • Deep Linking with Shareable Links
      • Pass-Through Additional User Information
      • Tracking Your Sessions
      • User Session Lifecycle
      • Developer Testing
    • Account Optional Add-ons
      • Capture Only Theme (CAPT)
        • Skip Pictures
      • Right-Hand-Drive Capture Flow
  • MANAGING YOUR ACCOUNT
    • Your Guide to PAVE's Account and Enterprise Dashboards
  • Hotspots
    • PAVE Hotspots API
    • Activating PAVE Hotspots
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • POST Upload Photos
        • GET Results
  • OTHER RESOURCES
    • PAVE Capture Troubleshooting Guide
      • iPhone (iOS) Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Get's Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
      • Android Phone Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Gets Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
    • Policies
      • Service Level Agreement and Standards
      • Service Delivery Sub-Processors & Processors
      • API Strategy and Architecture
      • Information Security Policy
        • Data Quality Guideline
        • Data Retention Policy
        • Backup and Disaster Recovery
        • Data Residency
        • Data Access Control
Powered by GitBook
On this page
  1. Hotspots
  2. Developer Docs
  3. Sessions

POST Upload Photos

Upload Vehicle Photos to the Hotspots API

Endpoint

POST https://openapi.paveapi.com/v1/hotspots/:session_key/photos-url

Headers

API-Key: Your_API_Key
Headers
Description
Example

API-Key

The API Key for authentication.

09bc91b9-76e5-4256-8e4g-7a41c1408014

Params

session_key: Your_Session_Key
Params
Description
Example

session_key

The Session ID Key

UCB-C3NPR4AGQZ

Sample Request

{
    "photos": [
        {
            "photo_label": "VIN",
            "url": "https://i.ibb.co/b67cPzx/UDB-MPG1-GV1-IZO-01-GFE.jpg"
        },
        {
            "photo_label": "Interior",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_02_X7W.jpg"
        },
        {
            "photo_label": "Cluster",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_03_KSR.jpg"
        },
        {
            "photo_label": "Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_04_TVL.jpg"
        },
        {
            "photo_label": "Front",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_05_IC5.jpg"
        },
        {
            "photo_label": "Tires",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_06_VI9.jpg"
        },
        {
            "photo_label": "Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_07_R0Q.jpg"
        },
        {
            "photo_label": "Rear",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_08_U9T.jpg"
        },
        {
            "photo_label": "Windshield",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_09_GRA.jpg"
        },
        {
            "photo_label": "Front_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_10_WQM.jpg"
        },
        {
            "photo_label": "Front_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_11_6NG.jpg"
        },
        {
            "photo_label": "Rear_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_12_FO3.jpg"
        },
        {
            "photo_label": "Rear_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_13_VSB.jpg"
        }
    ]
}
```

Sample Confirmation Response (200 OK)

{
    "data": [
        {
            "photo_label": "VIN",
            "url": "https://i.ibb.co/b67cPzx/UDB-MPG1-GV1-IZO-01-GFE.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Interior",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_02_X7W.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Cluster",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_03_KSR.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_04_TVL.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Front",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_05_IC5.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Tires",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_06_VI9.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_07_R0Q.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Rear",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_08_U9T.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Windshield",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_09_GRA.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Front_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_10_WQM.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Front_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_11_6NG.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Rear_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_12_FO3.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        },
        {
            "photo_label": "Rear_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_13_VSB.jpg",
            "success": true,
            "message": "Photo URL has been successfully submitted."
        }
    ]
}

Sample Response when the images have already been submitted

{
    "data": [
        {
            "photo_label": "VIN",
            "url": "https://i.ibb.co/b67cPzx/UDB-MPG1-GV1-IZO-01-GFE.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Interior",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_02_X7W.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Cluster",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_03_KSR.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_04_TVL.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Front",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_05_IC5.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Tires",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_06_VI9.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_07_R0Q.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Rear",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_08_U9T.jpg",
            "success": false,
            "message": "Photo has been successfully processed and cannot be updated."
        },
        {
            "photo_label": "Windshield",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_09_GRA.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Front_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_10_WQM.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Front_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_11_6NG.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Rear_Right",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_12_FO3.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        },
        {
            "photo_label": "Rear_Left",
            "url": "https://images-cdn.paveapi.com/UDB/UDB-512D3TASIY/UDB-512D3TASIY_13_VSB.jpg",
            "success": false,
            "message": "Photo is still under processing and cannot be updated."
        }
    ]
}

Sample Error Responses

Response: Missing API-KEY
{
    "code": 400,
    "message": "Missing API-Key in authentication header.",
    "timestamp": {{time_stamp}}
}
Response: Missing Header
{
    "code": 404,
    "message": "Session cannot be found with the given API-Key.",
    "timestamp": {{time_stamp}}
}
Response: Session Already Completed

{
    "code": 400,
    "message": "This session is already inspected or expired.",
    "timestamp": "2023-05-30T20:52:29.506948Z"
}
PreviousPOST Create SessionNextGET Results

Last updated 1 year ago