Overview

Truepic Vision is a digital inspection platform that provides a quick and convenient way to receive verified, trustworthy images directly from your customer. We offer you the same trusted result as traditional site inspections, but get it done virtually — saving you time, money, and productivity in the process.

The Truepic Vision API enables you to programmatically perform most of the functionalities that exists on the Vision Dashboard. The API works with any system that accepts RESTful API.

What can the API do?

👍

Common API requests

  • Create new inspection requests
  • Customize list items to each inspection requests
  • Webhooks. Get notified of inspection activities: status updates, new photos uploaded, test results
  • View the details of an an existing request, including the photos, test results, and metadata
  • Generate a PDF Report
  • Request more photos
  • Close an inspection request
📘

Less common API requests

  • Get a list of inspections that can be filtered or sorted
  • Add a custom text/email message to the request
  • Add a list to the request with complete control over line items and required items (optional)
  • Update the app user's information
  • Send a reminder to start the inspection
  • View all lists
  • View all the items within a list
  • Teams. Create and update team settings, upload logos, and setting automated reminders
🚧

What is not possible with the API

  • Search inspection requests
  • Add an internal note to an inspection
  • Add an internal note to an image
  • Override a test result
  • Manage your users

Integration milestones and timelines

Example workflows that are possible through an integration.

  • Example 1. An app user fills out a web form themselves. After submitting that form, an inspection request is automatically sent to the app user to perform an inspection.
  • Example 2. An app user fills out a mobile web form. The smart link is presented to them right after they complete the form without having to receive a separate text/email. The app user taps the link to perform the inspection.
  • Example 3. In addition to the above, automatically close inspection requests that did not have any test warnings or failures. Push inspection requests that have test warnings or failures into a manual queue for additional review, highlighting the images and tests that need review.

Typical Milestones

Level

What does the integration include?

1

Use the API to create inspections, but complete everything else within the Vision Dashboard.

2

In addition to Level 1, get notifications about inspections so that your users know when to login to the Vision Dashboard to take action.
• Example: notify me when an inspection is ready for review.
• Example: notify me when photos have failed tests.

3

In addition to #2, review and close the inspection from within your own information system.

4

In addition to #3, perform additional actions
• Example: generating a PDF or downloading images, and storing the data in your own server.
• Example: sending reminders to start the inspection.
• Example: requesting more photos.

Typical Timelines

Timelines greatly depend on the your resource capacity and integration goals.

Time PeriodDescription
2 weeksTo create inspection requests, we recommend dedicating 1-2 developers for one 2-week sprint.
1 weekTo stand up a webhook callback URL, we recommend dedicating 1-2 developers for one 1-week sprint.
4 weeksTo retrieve and display the basic details of an inspection request, we recommend two 2-week sprints for 2 developers. A lot depends on the planned UI and the infrastructure / ingestion pipeline that is already in place. If you already have pictures, data, and a map, it will be a lot easier to get going.
2-8 weeksTo add inspection details to your own distributed report after review, it depends on the pipeline and reports that you have already set up. If you already support photos and extra data, it may only be one more sprint at most. But if you do not have a pipeline setup, this could take another 2+ sprints.

What’s Next