Create an inspection

<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp isRefPage "><head><meta charset="utf-8"><meta name="readme-deploy" content="5.326.0"><meta name="readme-subdomain" content="truepic-vision"><meta name="readme-repo" content="truepic-vision-47f42fda4344"><meta name="readme-version" content="3"><title>Create an inspection</title><meta name="description" content=""><meta property="og:title" content="Create an inspection"><meta property="og:description" content=""><meta property="og:site_name" content="Vision"><meta name="twitter:title" content="Create an inspection"><meta name="twitter:description" content=""><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png"><meta name="twitter:image" content="https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/707fad0e172b1f6d73f8a7e001d0e47b461626e20d70fa293f983316f6af74da-small-truepic_vision_logo_black_fav.png" type="image/png"><link rel="canonical" href="https://vision.truepic.dev/reference/post_inspections"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1744299492101"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="Footer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.8eec92324fbd959e749d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.9aa7b166787ce8dbf7dc.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.b046de036f947dd91787.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3073.317cd602cc699f456e75.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.eb492ea5d8641ee3dc4f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.250d10a2b892bd7a6237.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.6617aa9d6a5d87fd6a4b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.56a94f46d7930b3ee929.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.2fdd0d1ed25537838fd5.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.c6b4a4514e2581e40b1d.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.417c0a41cba2a37aa480.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.1e1760fbed3f42ccb29a.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.7f3b970f2b860b8bf73e.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.96b8d6f5010e5cdcba70.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d60db46666e2ba9dde2d.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.90004d413377087b5509.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.53ca1ea5a2b02b3a5244.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.4f86b948be2b6bace77b.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.146900a26b0ca17faad7.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.b558f2c382bb8c222ba8.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"> <link data-chunk="core-icons-book-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.8eec92324fbd959e749d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Footer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"><style title="rm-custom-css">:root{--project-color-primary:#ffffff;--project-color-inverse:#222;--recipe-button-color:#1a6dff;--recipe-button-color-hover:#0041b3;--recipe-button-color-active:#002e80;--recipe-button-color-focus:rgba(26, 109, 255, 0.25);--recipe-button-color-disabled:#e6efff}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#ffffff;--project-color-inverse:#222}a{color:var(--color-link-primary,#1a6dff)}a:hover{color:var(--color-link-primary-darken-5,#0041b3)}a.text-muted:hover{color:var(--color-link-primary,#1a6dff)}.btn.btn-primary{background-color:#1a6dff}.btn.btn-primary:hover{background-color:#0041b3}.theme-line #hub-landing-top h2{color:#1a6dff}#hub-landing-top .btn:hover{color:#1a6dff}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#fff}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#fff,#ded3d3)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#fff}.theme-line header#hub-header #header-top .btn{background-color:#fff}header#hub-header #header-top #header-logo{width:176px;height:40px;margin-top:0;background-image:url(https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#fff}#subheader-links a.active{color:#fff!important;box-shadow:inset 0 -2px 0 #fff}#subheader-links a:hover{color:#fff!important;box-shadow:inset 0 -2px 0 #fff;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#1a6dff}section#hub-discuss .discussion a .discuss-body h4{color:#1a6dff}section#hub-discuss .discussion a:hover .discuss-body h4{color:#0041b3}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#1a6dff}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#1a6dff}#hub-search-results h3 em{color:#1a6dff}.main_background,.tag-item{background:#1a6dff!important}.main_background:hover{background:#0041b3!important}.main_color{color:#fff!important}.border_bottom_main_color{border-bottom:2px solid #fff}.main_color_hover:hover{color:#fff!important}section#hub-discuss h1{color:#1a6dff}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#1a6dff;background-color:#1a6dff}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#0041b3;border-color:#0041b3}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#1a6dff;color:#1a6dff}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#1a6dff);border-color:var(--project-color-primary,#1a6dff)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#0041b3;border-color:#0041b3}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#1a6dff;fill:var(--project-color-primary,#1a6dff)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#1a6dff}.main-color-accent{border-bottom:3px solid #fff;padding-bottom:8px}</style><meta name="loadedProject" content="truepic-vision"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.326.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-line header-solid header-bg-size-auto header-bg-pos-tl header-overlay-blueprint reference-layout-row lumosity-light hub-full"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_light ThemeContext_line" style="--color-primary:#ffffff;--color-primary-inverse:#384248;--color-primary-alt:#ded3d3;--color-primary-darken-10:#e6e6e6;--color-primary-darken-20:#cccccc;--color-primary-alpha-25:rgba(255, 255, 255, 0.25);--color-link-primary:#1a6dff;--color-link-primary-darken-5:#005dff;--color-link-primary-darken-10:#0053e6;--color-link-primary-darken-20:#0041b3;--color-link-primary-alpha-50:rgba(26, 109, 255, 0.5);--color-link-primary-alpha-25:rgba(26, 109, 255, 0.25);--color-link-background:rgba(26, 109, 255, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><div class="SuperHub2RNxzk6HzHiJ"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/docs" target="_self"><img alt="Vision" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Docs</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option data-url="/v2/reference" value="2">v2</option><option selected="" data-url="#" value="3">v3</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://status.truepic.com" rel="noopener" target="_blank" to="https://status.truepic.com">Status ↗︎</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://vision.truepic.com" rel="noopener" target="_blank" to="https://vision.truepic.com">Log In ↗︎</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/docs" target="_self"><img alt="Vision" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-references Header-left-nav-icon10glJKFwewOv"></i>API Reference</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://status.truepic.com" target="_self" to="https://status.truepic.com">Status ↗︎</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://vision.truepic.com" target="_self" to="https://vision.truepic.com">Log In ↗︎</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav aria-label="Primary navigation" class="Header-leftADQdGVqx1wqU" role="navigation"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md VersionDropdown1GXDUTxJ1T95 rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span class="Truncate1OzxBYrNNfH3" style="--Truncate-max-width:150px">v3</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 9 6 6 6-6" class="icon-stroke-width"></path></svg></span></button></div><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/docs" target="_self"><i class="icon-guides"></i><span>Docs</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Create an inspection</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"><div class="SuperHubSearchI_obvfvvQi4g" id="AppSearch" role="tabpanel" tabindex="0"><div data-focus-guard="true" tabindex="-1" style="width:1px;height:0px;padding:0;overflow:hidden;position:fixed;top:1px;left:1px"></div><div data-focus-guard="true" tabindex="-1" style="width:1px;height:0px;padding:0;overflow:hidden;position:fixed;top:1px;left:1px"></div><div data-focus-lock-disabled="disabled" class="SuperHubSearch-container2BhYey2XE-Ij"><div class="SuperHubSearch-col1km8vLFgOaYj"><div class="SearchBoxnZBxftziZGcz"><input type="search" aria-label="Search" autoCapitalize="off" autoComplete="off" autoCorrect="off" spellcheck="false" tabindex="0" aria-required="false" class="Input Input_md SearchBox-inputR4jffU8l10iF" value=""/></div><div class="SearchTabs3rNhUK3HjrRJ"><div class="Tabs Tabs-list" role="tablist"><div aria-label="All" aria-selected="true" class="SearchTabs-tab1TrpmhQv840T Tabs-listItem Tabs-listItem_active" role="tab" tabindex="1"><span class="SearchTabs-tab1TrpmhQv840T"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="search" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M11 19a8 8 0 1 0 0-16 8 8 0 0 0 0 16ZM21 21l-4.35-4.35" class="icon-stroke-width"></path></svg></span>All</span></div><div aria-label="Pages" aria-selected="false" class="SearchTabs-tab1TrpmhQv840T Tabs-listItem" role="tab" tabindex="1"><span class="SearchTabs-tab1TrpmhQv840T"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="custom-pages" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9l-7-7Z" class="icon-stroke-width"></path><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M13 2v7h7M12 11.333V12M12 18v.667M9.407 12.407l.473.473M14.12 17.12l.473.473M8.333 15H9M15 15h.667M9.407 17.593l.473-.473M14.12 12.88l.473-.473" class="icon-stroke-width"></path></svg></span>Pages</span></div></div></div><div class="rm-SearchModal-empty SearchResults35_kFOb1zvxX SearchResults_emptyiWzyXErtNcQJ"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a rm-SearchModal-empty-icon icon icon-search" data-name="search" role="img" style="--icon-color:inherit;--icon-size:var(--icon-md);--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M11 19a8 8 0 1 0 0-16 8 8 0 0 0 0 16ZM21 21l-4.35-4.35" class="icon-stroke-width"></path></svg></span><h6 class="Title Title6 rm-SearchModal-empty-text">Start typing to search…</h6></div></div></div><div data-focus-guard="true" tabindex="-1" style="width:1px;height:0px;padding:0;overflow:hidden;position:fixed;top:1px;left:1px"></div></div></div></div></div></header><main class="rm-ReferenceMain rm-ReferenceMain-SuperHub rm-Container rm-Container_flex " id="Explorer"><nav aria-label="Secondary navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj" id="reference-sidebar" role="navigation"><div class="Main-QuickNav-container1OiLvjSDusO6"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Vision API - V3</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Inspections" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inspections</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/post_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections-inspectionid-complete"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Complete an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of inspection requests</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspections-inspectionid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections-inspectionid-export"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Export a PDF of an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid-export"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Export a PDF of an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid-listitemid-ca-vin-vinnumber"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Request details about a vehicle</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspections-inspectionid-inspection-type"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update the type of an existing inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Lists" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Lists</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_org-asset-assettype-upload"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Upload an example photo</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get lists</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Teams" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Teams</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams-teamid-assets-assettype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Upload team assets</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of teams</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organization-teams-teamid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organizationid-organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of teams</span><button aria-label="Deprecated Endpoint" class="Sidebar-link-deprecated3sPW_eEHvANR" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-hidden="true"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></button></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_organization-teams-teamid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_operations-operationid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Operations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Operations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_operations-operationid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an existing operation to track its progress</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-welcome"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-welcome"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send the original inspection request via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-request"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a request for more photos/videos via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-reminder"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a reminder to start the inspection via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-reminder-to-finish"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a reminder to finish the inspection via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_api_status"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for General" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">General</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_api_status"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get API Status</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Inspection Types" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inspection Types</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of inspection types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an inspection type by id</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Message Template Sets" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Message Template Sets</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of message template sets</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a message template set by id</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_open-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for OpenAPI" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">OpenAPI</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_open-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get the public Vision OpenAPI definition</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=truepic-vision" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><div align="start" class="Flex Flex_row SuperHubReference-article-container3-0_Qiq3UBH5" justify="between" style="--flex-gap:var(--md);flex-grow:1"><article class="rm-Article" id="content"><header class="headline-container21aRBSn8Bqg6 " data-raycast-oas="/versions/3/apis/vision-api-v3.json"><div class="headline-container-grid-itemGdPV-VbhShYs button-containerobFfV0vf6giV"><div class="reference-flyout"><button aria-label="Toggle reference sidebar" class="icon-menu reference-sidebar-mobile-button26mqim6Chewq " type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><nav aria-label="Secondary navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj mobile" id="reference-sidebar" role="navigation"><div class="ref-QuickNav-mobile-containerARtvyEDVpRhW"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Vision API - V3</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Inspections" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inspections</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/post_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections-inspectionid-complete"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Complete an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of inspection requests</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspections-inspectionid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspections-inspectionid-export"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Export a PDF of an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid-export"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Export a PDF of an inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspections-inspectionid-listitemid-ca-vin-vinnumber"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Request details about a vehicle</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspections-inspectionid-inspection-type"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update the type of an existing inspection</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Lists" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Lists</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_org-asset-assettype-upload"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Upload an example photo</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_lists"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get lists</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_lists-listid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete a list</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Teams" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Teams</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_organization-teams-teamid-assets-assettype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Upload team assets</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of teams</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organization-teams-teamid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_organizationid-organization-teams"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of teams</span><button aria-label="Deprecated Endpoint" class="Sidebar-link-deprecated3sPW_eEHvANR" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-hidden="true"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></button></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_organization-teams-teamid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update team</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_operations-operationid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Operations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Operations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_operations-operationid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an existing operation to track its progress</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-welcome"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-welcome"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send the original inspection request via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-request"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a request for more photos/videos via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-reminder"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a reminder to start the inspection via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_text-reminder-to-finish"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send a reminder to finish the inspection via text/email.</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_api_status"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for General" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">General</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_api_status"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get API Status</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Inspection Types" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inspection Types</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspection-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of inspection types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get an inspection type by id</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_inspection-types-inspectiontypeid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete an inspection type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/post_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Message Template Sets" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Message Template Sets</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/post_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_message-template-sets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a list of message template sets</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get a message template set by id</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/put_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/delete_message-template-sets-messagetemplatesetid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete a message template set</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/get_open-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for OpenAPI" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">OpenAPI</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/get_open-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get the public Vision OpenAPI definition</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=truepic-vision" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav></div></div></div><header id="content-head"><h1>Create an inspection</h1></header></div><div class="headline-container-article-info2GaOf2jMpV0r"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post headline-container-api-method1Hc-Fm7uaccR" data-testid="http-method">post</span> <span class="headline-container-article-info-url2nV_XrjpFuVQ" data-testid="serverurl" title="https://vision-api.truepic.com/v3/inspections">https://vision-api.truepic.com/v3/inspections</span></div></header><div class="ModalWrapper" id="response-schema-modal-target"></div></article><div id="ReferencePlayground" class="rm-Playground PlaygroundC7DInM9NFvBg "><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Language</div></header><div class="LanguagePickerSIxXDuYmeYsW rm-LanguagePicker"><div class="LanguagePicker-languages1qVVo_v6AlP9"><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton_active rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-curl"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Shell</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-node"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Node</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-ruby"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Ruby</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-php"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>PHP</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-python"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Python</button><div class="LanguagePicker-divider Dropdown Dropdown_closed"><button aria-label="More Languages" aria-haspopup="dialog" class="Button Button_md LanguagePicker-more2w3Eqm0IH_K7 rm-LanguageButton-more Dropdown-toggle Button_primary_ghost Button_primary" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="more-vertical" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-label="More ellipsis"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M12 13a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 6a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 20a1 1 0 1 0 0-2 1 1 0 0 0 0 2Z" class="icon-stroke-width"></path></svg></span></button></div></div></div></section><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><section class="APIAuth rm-APIAuth" data-testid="api-auth"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Credentials</div></header><section align="stretch" class="Flex Flex_row InputGroup " justify="between" style="--flex-gap:var(--xs)"><header align="start" class="Flex Flex_row InputGroup-dropdown-parent" justify="between" style="--flex-gap:var(--xs)"><div class="InputGroup-dropdown Dropdown Dropdown_closed"><button class="Button Button_sm InputGroup-button Dropdown-toggle" data-testid="api-auth-security-button" aria-haspopup="dialog"><span>Bearer</span><i class="icon-chevron-down"></i></button></div></header><div class="InputGroup-input-parent "><div class="InputGroup-dropdown-inputs "><input type="text" autoComplete="off" class="InputGroup-input " id="APIAuth-token" placeholder="token" required="" spellcheck="false" value=""/><button aria-label="Hide" class="Button Button_xs rm-APIAuth-lock undefined Button_minimum Button_minimum_text Button_uppercase" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="lock" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M19 11H5a2 2 0 0 0-2 2v7a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7a2 2 0 0 0-2-2ZM7 11V7a5 5 0 1 1 10 0v4" class="icon-stroke-width"></path></svg></span></button><i aria-label="Information" class="InfoPop-helpIconrmWTyT_Hj2Cl icon-help-circle undefined" role="button"></i></div></div></section></section></section><section class="Playground-section3VTXuaYZivJK Playground-section_sticky_fBLN0qIkmEd " data-notranslate="true"><section class="APIResponse3FBSi0-qfTQs rm-PlaygroundResponse"><header align="center" class="Flex Flex_row APIResponse-header3Y3zkft15LCF" justify="between" style="--flex-gap:var(--md)"><div><button class="Button Button_xs APIResponse-header-tab31M7P70x-CKu APIResponse-header-tab-active36LB45PMYTuB APIResponse-header-tab-disabled_gfqRzz9FpgZ Button_minimum_ghost Button_minimum Button_uppercase" disabled="" type="button">RESPONSE</button></div></header><div align="center" class="Flex Flex_col APIResponse-empty3Qdzfpq_JjNF" justify="between" style="--flex-gap:var(--md)"><div>Click <code class="APIResponse-empty-tryit2H55vIRfRhS3">Try It!</code> to start a request and see the response here!</div></div></section></section></div></div><div class="ModalWrapper" id="response-headers-modal-root"></div><div class="ModalWrapper" id="tutorialmodal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-desktop" id="QuickNav-modal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-mobile" id="QuickNav-mobile-modal-root"></div></main><footer aria-label="Status banner" class="Footer2U8XAPoGhlgO AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"678159561b3f5c002432f874","title":"Start Here","slug":"documentation","order":0,"reference":false,"version":"678159571b3f5c002432f8d1","project":"6464e41aeec964003faf6b06","createdAt":"2023-05-17T14:26:35.355Z","__v":0,"pages":[{"_id":"6797fff1dc78b500388819b7","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Introduction","icon":"","type":"basic","slug":"introduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f874","createdAt":"2025-01-27T21:51:45.775Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f8b9","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Vision API Overview","icon":"","type":"basic","slug":"api-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started","category":"678159561b3f5c002432f874","createdAt":"2024-09-11T05:08:48.577Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f881","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Started","icon":"","type":"basic","slug":"get-started","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started","category":"678159561b3f5c002432f874","createdAt":"2023-07-05T21:40:16.932Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f883","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Webhooks","icon":"","type":"basic","slug":"webhooks","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"webhook-setup","category":"678159561b3f5c002432f874","createdAt":"2023-07-05T21:41:00.104Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f880","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"API v2 to v3 Migration","icon":"","type":"basic","slug":"v2-v3-migration","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"v2-v3-migration-guide","category":"678159561b3f5c002432f874","createdAt":"2023-06-12T17:37:17.462Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"678159561b3f5c002432f876","title":"Inspections","slug":"main-category","order":1,"reference":false,"project":"6464e41aeec964003faf6b06","version":"678159571b3f5c002432f8d1","createdAt":"2023-05-25T23:40:39.232Z","__v":0,"pages":[{"_id":"678159571b3f5c002432f882","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Inspections","icon":"","type":"basic","slug":"create-inspections","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-inspection","category":"678159561b3f5c002432f876","createdAt":"2023-07-05T21:40:53.860Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f88a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Send Texts and Emails","icon":"","type":"basic","slug":"customer-communications","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f876","createdAt":"2023-07-12T17:11:39.276Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f886","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Inspection Alerts","icon":"","type":"basic","slug":"inspection-alerts","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"alerts","category":"678159561b3f5c002432f876","createdAt":"2023-07-05T21:44:04.123Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f887","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Inspections","icon":"","type":"basic","slug":"update-inspections","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-inspection","category":"678159561b3f5c002432f876","createdAt":"2023-07-05T21:44:44.276Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f884","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search Inspections","icon":"","type":"basic","slug":"search-inspections","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"review-inspections","category":"678159561b3f5c002432f876","createdAt":"2023-07-05T21:41:07.065Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"678159571b3f5c002432f888","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"View Inspections","icon":"","type":"basic","slug":"view-inspections","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f876","createdAt":"2023-07-05T21:44:57.602Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"67a24da2c4220f0053a05d9f","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Inspection Management","icon":"","type":"basic","slug":"inspection-management","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f876","createdAt":"2025-02-04T17:25:54.958Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"678159561b3f5c002432f878","title":"Mobile Integration","slug":"embedding","order":4,"reference":false,"project":"6464e41aeec964003faf6b06","version":"678159571b3f5c002432f8d1","createdAt":"2024-07-25T13:40:31.318Z","__v":0,"pages":[{"_id":"678159571b3f5c002432f8a5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Add Inspections via WebView","icon":"","type":"basic","slug":"embedded-vision","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"embed-vision","category":"678159561b3f5c002432f878","createdAt":"2024-07-25T13:34:15.360Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"678159561b3f5c002432f877","title":"Vision API - V3","slug":"vision-api-v3-1","order":9999,"reference":true,"project":"6464e41aeec964003faf6b06","version":"678159571b3f5c002432f8d1","createdAt":"2023-07-17T19:31:51.824Z","__v":0,"pages":[{"_id":"678159571b3f5c002432f88f","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Inspections","icon":"","type":"basic","slug":"inspections-all","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Inspections","link_url":"","link_external":false,"previousSlug":"inspections-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:53.008Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f898","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Create an inspection","icon":"","type":"endpoint","slug":"post_inspections","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_inspections","link_url":"","link_external":false,"previousSlug":"post_inspections-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.019Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f899","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Complete an inspection","icon":"","type":"endpoint","slug":"post_inspections-inspectionid-complete","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_inspections-inspectionid-complete","link_url":"","link_external":false,"previousSlug":"post_inspections-inspectionid-complete-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.020Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f897","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list of inspection requests","icon":"","type":"endpoint","slug":"get_inspections","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspections","link_url":"","link_external":false,"previousSlug":"get_inspections-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.018Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f89a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get an inspection","icon":"","type":"endpoint","slug":"get_inspections-inspectionid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspections-inspectionid","link_url":"","link_external":false,"previousSlug":"get_inspections-inspectionid-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.020Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f89b","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update an inspection","icon":"","type":"endpoint","slug":"put_inspections-inspectionid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_inspections-inspectionid","link_url":"","link_external":false,"previousSlug":"put_inspections-inspectionid-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.022Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f89d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Export a PDF of an inspection","icon":"","type":"endpoint","slug":"post_inspections-inspectionid-export","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_inspections-inspectionid-export","link_url":"","link_external":false,"previousSlug":"post_inspections-inspectionid-export-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.023Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f89c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Export a PDF of an inspection","icon":"","type":"endpoint","slug":"get_inspections-inspectionid-export","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspections-inspectionid-export","link_url":"","link_external":false,"previousSlug":"get_inspections-inspectionid-export-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.022Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f89e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Request details about a vehicle","icon":"","type":"endpoint","slug":"get_inspections-inspectionid-listitemid-ca-vin-vinnumber","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspections-inspectionid-listitemid-ca-vin-vinnumber","link_url":"","link_external":false,"previousSlug":"get_inspections-inspectionid-listitemid-ca-vin-vinnumber-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.024Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8a0","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update the type of an existing inspection","icon":"","type":"endpoint","slug":"put_inspections-inspectionid-inspection-type","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_inspections-inspectionid-inspection-type","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2023-08-03T02:27:33.986Z","parentDoc":"678159571b3f5c002432f88f","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f88b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Lists","icon":"","type":"basic","slug":"lists","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Lists","link_url":"","link_external":false,"previousSlug":"lists-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:53.007Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f8bc","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Create a list","icon":"","type":"endpoint","slug":"post_lists","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_lists","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.794Z","parentDoc":"678159571b3f5c002432f88b","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8d0","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Upload an example photo","icon":"","type":"endpoint","slug":"post_org-asset-assettype-upload","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_org-asset-assettype-upload","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-12-05T22:21:58.766Z","parentDoc":"678159571b3f5c002432f88b","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f891","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list","icon":"","type":"endpoint","slug":"get_lists-listid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_lists-listid","link_url":"","link_external":false,"previousSlug":"get_lists-listid-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.015Z","parentDoc":"678159571b3f5c002432f88b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f890","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get lists","icon":"","type":"endpoint","slug":"get_lists","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_lists","link_url":"","link_external":false,"previousSlug":"get_lists-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.014Z","parentDoc":"678159571b3f5c002432f88b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8bd","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update a list","icon":"","type":"endpoint","slug":"put_lists-listid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_lists-listid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.795Z","parentDoc":"678159571b3f5c002432f88b","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8be","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Delete a list","icon":"","type":"endpoint","slug":"delete_lists-listid","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_lists-listid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.796Z","parentDoc":"678159571b3f5c002432f88b","isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f8a1","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Teams","icon":"","type":"basic","slug":"teams","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Teams","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2023-08-03T21:05:30.627Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f8c9","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Create a team","icon":"","type":"endpoint","slug":"post_organization-teams","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_organization-teams","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.155Z","parentDoc":"678159571b3f5c002432f8a1","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8cd","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Upload team assets","icon":"","type":"endpoint","slug":"post_organization-teams-teamid-assets-assettype","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_organization-teams-teamid-assets-assettype","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.158Z","parentDoc":"678159571b3f5c002432f8a1","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8ca","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list of teams","icon":"","type":"endpoint","slug":"get_organization-teams","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_organization-teams","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.156Z","parentDoc":"678159571b3f5c002432f8a1","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8cb","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a team","icon":"","type":"endpoint","slug":"get_organization-teams-teamid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_organization-teams-teamid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.156Z","parentDoc":"678159571b3f5c002432f8a1","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8a4","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list of teams","icon":"","type":"endpoint","slug":"get_organizationid-organization-teams","order":4,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"get_organizationid-organization-teams","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2023-10-26T13:25:38.615Z","parentDoc":"678159571b3f5c002432f8a1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8cc","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update team","icon":"","type":"endpoint","slug":"put_organization-teams-teamid","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_organization-teams-teamid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.157Z","parentDoc":"678159571b3f5c002432f8a1","isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f8a2","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Operations","icon":"","type":"basic","slug":"operations","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Operations","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2023-08-08T18:37:53.736Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f8a3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get an existing operation to track its progress","icon":"","type":"endpoint","slug":"get_operations-operationid","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_operations-operationid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2023-08-08T18:37:54.159Z","parentDoc":"678159571b3f5c002432f8a2","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f88c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Text","icon":"","type":"basic","slug":"text","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Text","link_url":"","link_external":false,"previousSlug":"text-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:53.007Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f892","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Send the original inspection request via text/email.","icon":"","type":"endpoint","slug":"put_text-welcome","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_text-welcome","link_url":"","link_external":false,"previousSlug":"put_text-welcome-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.015Z","parentDoc":"678159571b3f5c002432f88c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f893","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Send a request for more photos/videos via text/email.","icon":"","type":"endpoint","slug":"put_text-request","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_text-request","link_url":"","link_external":false,"previousSlug":"put_text-request-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.016Z","parentDoc":"678159571b3f5c002432f88c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f894","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Send a reminder to start the inspection via text/email.","icon":"","type":"endpoint","slug":"put_text-reminder","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_text-reminder","link_url":"","link_external":false,"previousSlug":"put_text-reminder-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.016Z","parentDoc":"678159571b3f5c002432f88c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"67ad2283d0b79a0018c72992","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Send a reminder to finish the inspection via text/email.","icon":"","type":"endpoint","slug":"put_text-reminder-to-finish","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_text-reminder-to-finish","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2025-02-12T22:36:51.940Z","parentDoc":"678159571b3f5c002432f88c","isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f88d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"General","icon":"","type":"basic","slug":"general","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__General","link_url":"","link_external":false,"previousSlug":"general-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:53.007Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f895","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get API Status","icon":"","type":"endpoint","slug":"get_api_status","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_","link_url":"","link_external":false,"previousSlug":"get_-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.017Z","parentDoc":"678159571b3f5c002432f88d","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f8ba","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Inspection Types","icon":"","type":"basic","slug":"inspection-types","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Inspection Types","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.657Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f8c0","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Create an inspection type","icon":"","type":"endpoint","slug":"post_inspection-types","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_inspection-types","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.797Z","parentDoc":"678159571b3f5c002432f8ba","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8bf","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list of inspection types","icon":"","type":"endpoint","slug":"get_inspection-types","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspection-types","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.797Z","parentDoc":"678159571b3f5c002432f8ba","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c1","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get an inspection type by id","icon":"","type":"endpoint","slug":"get_inspection-types-inspectiontypeid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_inspection-types-inspectiontypeid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.798Z","parentDoc":"678159571b3f5c002432f8ba","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c2","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update an inspection type","icon":"","type":"endpoint","slug":"put_inspection-types-inspectiontypeid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_inspection-types-inspectiontypeid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.798Z","parentDoc":"678159571b3f5c002432f8ba","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8ce","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Delete an inspection type","icon":"","type":"endpoint","slug":"delete_inspection-types-inspectiontypeid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_inspection-types-inspectiontypeid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-11-19T19:47:08.166Z","parentDoc":"678159571b3f5c002432f8ba","isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f8bb","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"Message Template Sets","icon":"","type":"basic","slug":"message-template-sets","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Message Template Sets","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.658Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f8c4","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Create a message template set","icon":"","type":"endpoint","slug":"post_message-template-sets","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_message-template-sets","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.799Z","parentDoc":"678159571b3f5c002432f8bb","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c3","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a list of message template sets","icon":"","type":"endpoint","slug":"get_message-template-sets","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_message-template-sets","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.799Z","parentDoc":"678159571b3f5c002432f8bb","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c5","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get a message template set by id","icon":"","type":"endpoint","slug":"get_message-template-sets-messagetemplatesetid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_message-template-sets-messagetemplatesetid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.799Z","parentDoc":"678159571b3f5c002432f8bb","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c6","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Update a message template set","icon":"","type":"endpoint","slug":"put_message-template-sets-messagetemplatesetid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_message-template-sets-messagetemplatesetid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.800Z","parentDoc":"678159571b3f5c002432f8bb","isBodyEmpty":true,"children":[]},{"_id":"678159571b3f5c002432f8c7","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Delete a message template set","icon":"","type":"endpoint","slug":"delete_message-template-sets-messagetemplatesetid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_message-template-sets-messagetemplatesetid","link_url":"","link_external":false,"previousSlug":"","category":"678159561b3f5c002432f877","createdAt":"2024-09-27T17:48:49.800Z","parentDoc":"678159571b3f5c002432f8bb","isBodyEmpty":true,"children":[]}]},{"_id":"678159571b3f5c002432f88e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"678159561b3f5c002432f87b"},"title":"OpenAPI","icon":"","type":"basic","slug":"open-api","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__OpenAPI","link_url":"","link_external":false,"previousSlug":"openapi-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:53.008Z","mdx":{},"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"678159571b3f5c002432f896","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"678159561b3f5c002432f87b"},"title":"Get the public Vision OpenAPI definition","icon":"","type":"endpoint","slug":"get_open-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_open-api","link_url":"","link_external":false,"previousSlug":"get_open-api-1","category":"678159561b3f5c002432f877","createdAt":"2023-07-17T19:31:54.018Z","parentDoc":"678159571b3f5c002432f88e","mdx":{},"isBodyEmpty":true,"children":[]}]}]}]},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"ZmU5NDQyMTZjMTFiNDU0Y2Y5NzNhMDEzZDdlMzI2MjZiODJjZjM4YWQzMjdlNmIzMmJjODg1YzE0NWUyNTgyMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjQ2NGU0MWFlZWM5NjQwMDNmYWY2YjA2KSwodmVyc2lvbjpub25lLHZlcnNpb246Njc4MTU5NTcxYjNmNWMwMDI0MzJmOGQxKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":false,"logs":false,"custompages":true,"tutorials":false},"id":"6464e41aeec964003faf6b06","name":"Vision","subdomain":"truepic-vision","subpath":"","nav_names":{"docs":"Docs","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"truepic-vision"},"version":"3"}},"apiDefinitions":[],"customBlocks":[],"document":{"allow_crawlers":"enabled","category":{"uri":"/versions/3/categories/reference/Vision API - V3"},"content":{"body":null,"excerpt":null,"link":{"url":null,"new_tab":false},"next":{"description":null,"pages":[]}},"href":{"dash":"https://dash.readme.com/project/truepic-vision/v3/refs/post_inspections"},"metadata":{"description":null,"image":{"uri":null,"url":null},"keywords":null,"title":null},"parent":{"uri":"/versions/3/reference/inspections-all"},"privacy":{"view":"public"},"project":{"name":"Vision","subdomain":"truepic-vision","uri":"/projects/me"},"renderable":{"status":true,"error":null,"message":null},"slug":"post_inspections","state":"current","title":"Create an inspection","type":"endpoint","updated_at":"2025-02-28T11:46:47.436Z","uri":"/versions/3/reference/post_inspections","api_config":null,"api":{"method":"post","path":"/inspections","schema":{"openapi":"3.0.0","info":{"title":"Vision API - V3","description":"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.\n\nTo begin using our API, please contact us to request access. We will issue you a `client_id` and `client_secret` for authorization, as well as team and inspection type IDs that you will need when making requests.\n\nAuthorization is done via OAuth 2's [client credentials flow](https://auth0.com/docs/flows/concepts/client-credentials). Click the \"Authorize\" button below for more details.\n","contact":{"name":"Truepic","email":"clientsupport@truepic.com"},"version":"3.35.0"},"servers":[{"url":"https://vision-api.truepic.com/v3","description":"Production"}],"components":{"parameters":{"organizationId":{"name":"organizationId","in":"path","description":"The ID of the existing organization.","required":true,"schema":{"type":"integer","example":123}},"inspectionId":{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}},"listId":{"name":"listId","in":"path","description":"The ID of the existing list.","required":true,"schema":{"type":"integer","example":123}},"listItemId":{"name":"listItemId","in":"path","description":"The ID of the existing list item (entry in a list).","required":true,"schema":{"type":"integer","example":123}},"operationId":{"name":"operationId","in":"path","description":"The ID of the existing operation.","required":true,"schema":{"type":"integer","example":123}},"verificationCode":{"name":"verificationCode","in":"path","description":"The unique alphanumeric identifier of the photo/video.","required":true,"schema":{"type":"string","example":"a8ic9o07p1"}},"page":{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}},"responses":{"ErrorBadRequest":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"ErrorUnauthorized":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"ErrorForbidden":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"ErrorNotFound":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"ErrorPreconditionFailed":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"ErrorUnhandled":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"schemas":{"AlertTrigger":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"ChangeInspectionTypeBody":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}/inspection-type","properties":{"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"}},"required":["inspection_type_id"],"type":"object","x-readme-ref-name":"ChangeInspectionTypeBody"},"ContentAnalysisDetails":{"additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"ContentAnalysisExpectedValue":{"anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"ContentAnalysisResultDetails":{"additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"result":{"anyOf":[{"type":"number"},{"type":"string"},{"nullable":true},{"items":{"items":{"type":"string"},"type":"array"},"type":"array"}],"description":"The result of the content analysis test. Will be a number representing the number on the vehicle odometer for ODOMETER tests. Will be a string representing the VIN number on the vehicle for VIN tests. Will be an array of strings for each condition"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["result","type"],"type":"object","x-readme-ref-name":"ContentAnalysisResultDetails"},"ContentAnalysisType":{"description":"The possible types of content analysis tests.","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"},"CreateAPICredentialsResult":{"additionalProperties":false,"description":"The response body for POST /auth/auth0","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"client_id":{"description":"The client id for the organization's Vision API access.","type":"string"},"client_secret":{"description":"The client secret for the organization's Vision API access.","type":"string"},"created_at":{"description":"The date the API credentials and bot were created.","format":"datetime","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","client_id","client_secret","created_at","message","response_code"],"type":"object","x-readme-ref-name":"CreateAPICredentialsResult"},"CreateCustomFieldOptionSetProps":{"additionalProperties":false,"properties":{"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"}},"required":["name","options"],"type":"object","x-readme-ref-name":"CreateCustomFieldOptionSetProps"},"CreateInspectionBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"assigned_to_member_user":{"description":"The user to assign the inspection to. Can be either a user ID or an email address.","type":"string"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"include_list":{"description":"This must be set to `true` when including items in the `list` object.","type":"boolean","default":false,"example":false},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"list":{"additionalProperties":false,"description":"Populate this object with list items to prompt the user for specific photos, videos, or questions during the inspection.","properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"}},"type":"object","x-readme-ref-name":"CreateInspectionBody"},"CreateInspectionResult":{"additionalProperties":false,"description":"Response body for POST /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"alert":{"additionalProperties":false,"properties":{"config":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"failures":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"},"recommendation":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"warnings":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object","x-readme-ref-name":"InspectionAlertResult"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object","x-readme-ref-name":"Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"list":{"additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object","x-readme-ref-name":"InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this organization has been soft-deleted.","example":true,"type":"boolean"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object","x-readme-ref-name":"Organization"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"Team"},"outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object","x-readme-ref-name":"Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this action has been soft-deleted","example":true,"type":"boolean"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object","x-readme-ref-name":"TimelineAction"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","has_survey_available","id","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","organization","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"CreateInspectionResult"},"CreateInspectionTypeBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language"],"type":"object","x-readme-ref-name":"CreateInspectionTypeBody"},"CreateInternalNoteBody":{"additionalProperties":false,"description":"The request body for POST /inspections/{inspectionId}/internal-note","properties":{"note":{"description":"The note to add to the inspection.","type":"string"}},"required":["note"],"type":"object","x-readme-ref-name":"CreateInternalNoteBody"},"CreateListBody":{"description":"Request Body for POST /inspections","x-readme-ref-name":"CreateListBody","additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["items","name"],"type":"object"},"CreateListPayload":{"additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["items","name"],"type":"object","x-readme-ref-name":"CreateListPayload"},"CreateMessageTemplateSetBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"}},"required":["name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject"],"type":"object","x-readme-ref-name":"CreateMessageTemplateSetBody"},"CreateTeamParams":{"additionalProperties":false,"properties":{"copy_inspection_type_assignments":{"description":"Whether to copy inspection type assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"copy_user_assignments":{"description":"Whether to copy user assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"template_team_id":{"description":"The ID of the team you want to use as a template for this new team","example":1843,"type":"number"}},"type":"object","x-readme-ref-name":"CreateTeamParams"},"CreateTextMatchingSetProps":{"additionalProperties":false,"properties":{"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"}},"required":["name","strings","type"],"type":"object","x-readme-ref-name":"CreateTextMatchingSetProps"},"CustomField":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"CustomFieldEntryMethods":{"enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"CustomFieldOption":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"CustomFieldOptionSet":{"additionalProperties":false,"description":"A set of possible options that a user can select from when creating an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this option custom field option set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this custom field option set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this custom field option set.","example":542,"type":"number"},"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"},"organization_id":{"description":"The id of the organization that owns this custom field option set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","options","organization_id","updated_at"],"type":"object","x-readme-ref-name":"CustomFieldOptionSet"},"EmailToken":{"additionalProperties":false,"description":"An email token used for unsubscribing and resubscribing from emails","properties":{"email_address":{"description":"The email address that this token will unsubscribe/resubscribe","format":"email","type":"string"},"exp":{"description":"The unix timestamp when this token expires.","example":5102023224,"type":"number"},"inspection_id":{"description":"The inspection id for the email this token will be attached to.","example":542,"type":"number"},"organization_id":{"description":"The id of the organization that this token will unsubscribe the email from.","example":123,"type":"number"}},"required":["organization_id","inspection_id","email_address","exp"],"type":"object","x-readme-ref-name":"EmailToken"},"ExportInspectionPDFBody":{"additionalProperties":false,"description":"Request body for POST /inspections/{inspectionId}/export","properties":{"async":{"description":"Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\\n\\nIf `false` (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.\\n\\nIf `true`, the PDF is queued for asynchronous export and an `Operation` is returned to track its progress. This is recommended.","example":true,"type":"boolean"},"filter":{"additionalProperties":false,"description":"Filters to limit what's included in the PDF.","properties":{"photos":{"description":"Limit the PDF to a subset of photos/videos. A list of IDs of photso/videos to include in the PDF.","items":{"type":"number"},"type":"array"}},"required":["photos"],"type":"object"}},"required":["async","filter"],"type":"object","x-readme-ref-name":"ExportInspectionPDFBody"},"GetAPICredentialsResult":{"description":"The response body for GET /auth/auth0","x-readme-ref-name":"GetAPICredentialsResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"client_id":{"description":"The client id for the organization's Vision API access.","type":"string"},"client_secret":{"description":"The client secret for the organization's Vision API access.","type":"string"},"created_at":{"description":"The date the API credentials and bot were created.","format":"datetime","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","client_id","client_secret","created_at","message","response_code"],"type":"object"},"GetBearerInspectionResult":{"additionalProperties":false,"description":"Response Body for GET /inspections/bearer","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"The Inspection schema with all properties optional","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"}},"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetBearerInspectionResult"},"GetCustomFieldOptionSetResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of Custom Field Option Sets with associated Inspection Types","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this option custom field option set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this custom field option set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this custom field option set.","example":542,"type":"number"},"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"},"organization_id":{"description":"The id of the organization that owns this custom field option set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","options","organization_id","updated_at"],"type":"object","x-readme-ref-name":"PopulatedCustomFieldOptionSet"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetCustomFieldOptionSetResult"},"GetCustomFieldOptionSetsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetCustomFieldOptionSetsResult"},"GetInspectionResult":{"additionalProperties":false,"description":"Response Body for GET /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"alert":{"additionalProperties":false,"properties":{"config":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"failures":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"},"recommendation":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"warnings":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object","x-readme-ref-name":"InspectionAlertResult"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object","x-readme-ref-name":"Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"list":{"additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object","x-readme-ref-name":"InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this organization has been soft-deleted.","example":true,"type":"boolean"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object","x-readme-ref-name":"Organization"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"Team"},"outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object","x-readme-ref-name":"Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this action has been soft-deleted","example":true,"type":"boolean"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object","x-readme-ref-name":"TimelineAction"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","has_survey_available","id","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","organization","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetInspectionResult"},"GetInspectionTypeResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","language","created_at","updated_at","custom_fields","list","message_template_set"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetInspectionTypeResult"},"GetInspectionTypesResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language","created_at","updated_at"],"type":"object","x-readme-ref-name":"InspectionTypeData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetInspectionTypesResult"},"GetInspectionsResult":{"additionalProperties":false,"description":"Response Body for GET /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetInspectionsResult"},"GetListResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetListResult"},"GetListsResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetListsResult"},"GetLoggedInUserResult":{"additionalProperties":false,"description":"The result for GET /auth/user","properties":{"user":{"additionalProperties":false,"properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"decodedToken":{"additionalProperties":false,"description":"An email token used for unsubscribing and resubscribing from emails","properties":{"email_address":{"description":"The email address that this token will unsubscribe/resubscribe","format":"email","type":"string"},"exp":{"description":"The unix timestamp when this token expires.","example":5102023224,"type":"number"},"inspection_id":{"description":"The inspection id for the email this token will be attached to.","example":542,"type":"number"},"organization_id":{"description":"The id of the organization that this token will unsubscribe the email from.","example":123,"type":"number"}},"required":["organization_id","inspection_id","email_address","exp"],"type":"object","x-readme-ref-name":"EmailToken"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"group":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object","x-readme-ref-name":"SerializedGroup"},"hasAccessToMultipleOrganizations":{"type":"boolean"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"isActiveUser":{"type":"boolean"},"isBot":{"type":"boolean"},"isCustomer":{"type":"boolean"},"isGroupMember":{"type":"boolean"},"isMemberAdmin":{"type":"boolean"},"isMemberOwnInspections":{"type":"boolean"},"isMemberReport":{"type":"boolean"},"isSuperAdmin":{"type":"boolean"},"isViewOnly":{"type":"boolean"},"jwt":{"type":"string"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization":{"additionalProperties":false,"properties":{"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"}},"required":["id","is_mfa_required"],"type":"object"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"organizationsUserHasAccessTo":{"items":{"type":"number"},"type":"array"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"provider":{"additionalProperties":false,"description":"Auth0 IDP information","properties":{"connection":{"description":"Auth0 connection name","type":"string"},"isSocial":{"description":"Whether social login was used","type":"boolean"},"provider":{"description":"The type of provider used","type":"string"},"user_id":{"description":"The identifier for the user","type":"string"}},"required":["connection","isSocial","provider","user_id"],"type":"object","x-readme-ref-name":"Provider"},"roles":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the role.","example":"VISION_AGENT_ADMIN","enum":["SUPER_ADMIN","VISION_AGENT_ADMIN","VISION_AGENT","VISION_CONSUMER","AUTH0_BOT","GROUP_AGENT","VISION_AGENT_OWN_INSPECTIONS","VIEW_ONLY","VISION_AGENT_REPORT"],"type":"string","x-readme-ref-name":"VisionRole"},"name":{"description":"The human-readable name of the role.","example":"Administrator","type":"string"}},"required":["id","id_internal","name"],"type":"object"},"type":"array"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"teams":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"items":{},"type":"array"}]},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","decodedToken","group","hasAccessToMultipleOrganizations","id","isActiveUser","isBot","isOrganization","isGroupMember","isMemberAdmin","isMemberOwnInspections","isMemberReport","isSuperAdmin","isViewOnly","organizationsUserHasAccessTo","roles","teams","updated_at"],"type":"object"}},"required":["user"],"type":"object","x-readme-ref-name":"GetLoggedInUserResult"},"GetMessageTemplateResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSetData"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetMessageTemplateResult"},"GetMessageTemplateSetsResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSetData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetMessageTemplateSetsResult"},"GetOperationResult":{"additionalProperties":false,"description":"The response body for GET /operations/{operationId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object","x-readme-ref-name":"Operation"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetOperationResult"},"GetTeamResult":{"additionalProperties":false,"description":"The response body for the GET /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"groups":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"inspection_types":{"items":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"type":"array"},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"list":{"items":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"type":"array"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["organization_id","is_deleted","jwt_organization_expiry","jwt_member_admin_expiry","shortname","created_at","updated_at","inspection_types"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetTeamResult"},"GetTeamsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetTeamsResult"},"GetTextMatchingSetResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"can_delete":{"type":"boolean"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this text matching set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this text matching set has been soft-deleted","example":true,"type":"boolean"},"lists":{"items":{"additionalProperties":false,"properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"modified_by_user_id":{"description":"The id of the user that last edited this text matching set.","example":542,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this text matching set","example":532,"type":"number"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"total_strings":{"type":"number"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["can_delete","created_at","created_by_user_id","id","is_deleted","lists","name","organization_id","strings","total_strings","type","updated_at"],"type":"object","x-readme-ref-name":"PopulatedTextMatchingSet"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetTextMatchingSetResult"},"GetTextMatchingSetsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetTextMatchingSetsResult"},"GetUnsubscribedEmailsResult":{"additionalProperties":false,"description":"Response Body for GET /emails/unsubscribed-email","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetUnsubscribedEmailsResult"},"GetVehicleDetailsResult":{"additionalProperties":false,"description":"The response body for GET /inspections/{inspectionId}/{listItemId}/ca/vin/{vinNumber}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"details":{"description":"Further vehicle details, format defined by vendor","type":"object"},"request_dates":{"description":"The timestamps of all of the requests to the VIN API service","example":["2022-09-28 20:21:07.96","2022-09-28 20:22:10.73","2022-09-29 11:30:50.298"],"format":"date-time[]","items":{"type":"string"},"type":"array"}},"required":["request_dates","details"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetVehicleDetailsResult"},"Group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object","x-readme-ref-name":"Group"},"Inspection":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"}},"required":["app_opened","assigned_to_member_user_id","created_at","created_by_member_user_id","custom_field_values","id","inspection_status_id","inspection_type_id","is_deleted","is_expired","organization_id","send_methods","team_id","updated_at"],"type":"object","x-readme-ref-name":"Inspection"},"InspectionAlertConfig":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"InspectionAlertResult":{"additionalProperties":false,"properties":{"config":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"failures":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"},"recommendation":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"warnings":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object","x-readme-ref-name":"InspectionAlertResult"},"InspectionListItemWithPhotos":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object","x-readme-ref-name":"InspectionListItemWithPhotos"},"InspectionPlatform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"InspectionStatus":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"InspectionStatus"},"InspectionStatusId":{"description":"The possible statuses for an inspection.","enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"InspectionTruepic":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"InspectionType":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"InspectionTypeData":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language","created_at","updated_at"],"type":"object","x-readme-ref-name":"InspectionTypeData"},"List":{"additionalProperties":false,"description":"A list of photos/videos and questions to prompt the customer for during an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","is_deleted","name","organization_id","type","updated_at"],"type":"object","x-readme-ref-name":"List"},"ListItem":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"ListItemGroups":{"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"ListItemPayload":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"ListItemQuestion":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"ListItemQuestionChoice":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"ListItemType":{"enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"ListType":{"enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"LocalizationLanguages":{"enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"MessageTemplateSet":{"additionalProperties":false,"description":"A set of templates used for messages sent via email or text to an app user","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"MessageTemplateSetData":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSetData"},"ObjectDetectionApplianceObject":{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"},"ObjectDetectionAutomotiveObject":{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},"ObjectDetectionCategory":{"description":"The possible statuses for an inspection.","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"ObjectDetectionConfig":{"additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"ObjectDetectionJewelryObject":{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},"ObjectDetectionObject":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"ObjectDetectionRealEstateObject":{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},"ObjectDetectionWarningMethodology":{"description":"The possible statuses for an inspection.","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"},"Operation":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object","x-readme-ref-name":"Operation"},"Organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this organization has been soft-deleted.","example":true,"type":"boolean"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object","x-readme-ref-name":"Organization"},"Outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object","x-readme-ref-name":"Outcome"},"OutcomeSet":{"additionalProperties":false,"description":"A set of outcomes possible when closing an inspection. Specific to each organization.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"PaginationFiltering":{"additionalProperties":{"additionalProperties":false,"description":"The key is the property name to filter by.","properties":{"<":{"description":"Value must be less than this.","type":"string"},"<=":{"description":"Value must be less than or equal to this.","type":"string"},"=":{"description":"Value must equal this","type":"string"},">":{"description":"Value must be greater than this.","type":"string"},">=":{"description":"Value must be greater or equal to than this.","type":"string"},"in":{"description":"Value must be at least one of these","items":{"type":"string"},"type":"array"},"is":{"description":"Value must be this.","type":"string"},"is not":{"description":"Value must not be this.","type":"string"}},"type":"object"},"description":"General format for filtering results.","type":"object","x-readme-ref-name":"PaginationFiltering"},"PaginationQuery":{"additionalProperties":false,"description":"General format for paginated queries to limit the number of results returned.","properties":{"number":{"default":1,"description":"The page number to return.","example":1,"type":"number"},"size":{"default":20,"description":"The number of results to return per page.","example":25,"type":"number"}},"required":["number","size"],"type":"object","x-readme-ref-name":"PaginationQuery"},"PaginationResult":{"additionalProperties":false,"description":"General format for paginated API results","properties":{"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["result","totalResults","total","pageCount"],"type":"object","x-readme-ref-name":"PaginationResult"},"PaginationSorting":{"additionalProperties":{"description":"The key is the property name to sort by. 'asc' to sort ascending. 'desc' to sort descending.","enum":["asc","desc"],"type":"string"},"description":"General format for sorting results. The order of properties given is important, as sorting is applied in the order specified.","type":"object","x-readme-ref-name":"PaginationSorting"},"PopulatedCustomField":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"PopulatedCustomFieldOptionSet":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this option custom field option set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this custom field option set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this custom field option set.","example":542,"type":"number"},"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"},"organization_id":{"description":"The id of the organization that owns this custom field option set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","options","organization_id","updated_at"],"type":"object","x-readme-ref-name":"PopulatedCustomFieldOptionSet"},"PopulatedTeam":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"groups":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"inspection_types":{"items":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"type":"array"},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"list":{"items":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"type":"array"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","inspection_types","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"PopulatedTeam"},"PopulatedTextMatchingSet":{"additionalProperties":false,"properties":{"can_delete":{"type":"boolean"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this text matching set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this text matching set has been soft-deleted","example":true,"type":"boolean"},"lists":{"items":{"additionalProperties":false,"properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"modified_by_user_id":{"description":"The id of the user that last edited this text matching set.","example":542,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this text matching set","example":532,"type":"number"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"total_strings":{"type":"number"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["can_delete","created_at","created_by_user_id","id","is_deleted","lists","name","organization_id","strings","total_strings","type","updated_at"],"type":"object","x-readme-ref-name":"PopulatedTextMatchingSet"},"PostOrgAssetResult":{"additionalProperties":false,"description":"The response body for POST /org-asset/{assetType}/upload","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"org_asset":{"type":"string"},"org_asset_square":{"type":"string"}},"required":["org_asset"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"PostOrgAssetResult"},"PostTeamAssetByTypeResult":{"additionalProperties":false,"description":"The response body for POST /organization-teams/{teamId}/assets/{assetType}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"An array of urls for different resolutions of the uploaded asset","items":{"type":"string"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"PostTeamAssetByTypeResult"},"Provider":{"additionalProperties":false,"description":"Auth0 IDP information","properties":{"connection":{"description":"Auth0 connection name","type":"string"},"isSocial":{"description":"Whether social login was used","type":"boolean"},"provider":{"description":"The type of provider used","type":"string"},"user_id":{"description":"The identifier for the user","type":"string"}},"required":["connection","isSocial","provider","user_id"],"type":"object","x-readme-ref-name":"Provider"},"PsqlTimestamps":{"additionalProperties":false,"description":"A generic type for the fields applied to every table in the PSQL database.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","updated_at"],"type":"object","x-readme-ref-name":"PsqlTimestamps"},"ResponseData":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},"SendFinishReminderTextBody":{"description":"The request body for PUT /text/reminder-to-finish","x-readme-ref-name":"SendFinishReminderTextBody","additionalProperties":false,"properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"},"SendFinishReminderTextResult":{"description":"The response body for PUT /text/reminder-to-finish","x-readme-ref-name":"SendFinishReminderTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"},"SendReleaseNotesEmailBody":{"additionalProperties":false,"description":"Request Body for POST /emails/release-notes","properties":{"body":{"description":"The text body of the email","type":"string"},"subject":{"description":"The subject for the email (also used as the header in the email content)","type":"string"},"superAdminsOnly":{"default":true,"description":"When true (or excluded), will only send the release notes email to Super Admins. If you want to send it to all Vision Dashboard users, you must explicitly set this to false","type":"boolean"}},"required":["subject","body","superAdminsOnly"],"type":"object","x-readme-ref-name":"SendReleaseNotesEmailBody"},"SendReminderTextBody":{"description":"The request body for PUT /text/reminder","x-readme-ref-name":"SendReminderTextBody","additionalProperties":false,"properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"},"SendReminderTextResult":{"description":"The response body for PUT /text/reminder","x-readme-ref-name":"SendReminderTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"},"SendRequestMoreTextBody":{"additionalProperties":false,"description":"The request body for PUT /text/request","properties":{"include_list":{"description":"Set to true when sending list items in the `list` property.","example":true,"type":"boolean","default":false},"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"list":{"additionalProperties":false,"description":"A list with attached list items. This can be used to mark existing list items as incomplete, or to add new list items to the list, or both.","properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object","x-readme-ref-name":"SendRequestMoreTextBody"},"SendRequestMoreTextResult":{"description":"The response body for PUT /text/request","x-readme-ref-name":"SendRequestMoreTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"},"SendWelcomeTextBody":{"additionalProperties":false,"description":"The request body for PUT /text/welcome","properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object","x-readme-ref-name":"SendWelcomeTextBody"},"SendWelcomeTextResult":{"additionalProperties":false,"description":"The response body for PUT /text/welcome","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"SendWelcomeTextResult"},"SerializedGroup":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object","x-readme-ref-name":"SerializedGroup"},"SuccessfulCreationResponseData":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"id":{"description":"The ID of the newly created resource","example":5,"type":"number"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","id","message","response_code"],"type":"object","x-readme-ref-name":"SuccessfulCreationResponseData"},"Team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"Team"},"TestResult":{"description":"The possible results of a single test on a Truepic (blurriness, geo, ris, etc.)","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"TextMatchingExpectedValues":{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"},"TextMatchingSet":{"additionalProperties":false,"description":"A set of possible strings that the content analysis will look for in the OCR result *","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this text matching set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this text matching set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this text matching set.","example":542,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this text matching set","example":532,"type":"number"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","strings","type","updated_at"],"type":"object","x-readme-ref-name":"TextMatchingSet"},"TimelineAction":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this action has been soft-deleted","example":true,"type":"boolean"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object","x-readme-ref-name":"TimelineAction"},"Truepic":{"additionalProperties":false,"description":"A photo or video (if enabled for the organization) from an inspection request.","properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"Truepic"},"UniqueID2":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"UnsubscribedEmail":{"additionalProperties":false,"description":"An entry marking an email address that has unsubscribed from emails from a specific organization.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email_address":{"description":"The email address that has unsubscribed.","example":"bob@aol.com","format":"email","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"organization_id":{"description":"The id of the organization that this email has unsubscribed from.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","email_address","id","organization_id","updated_at"],"type":"object","x-readme-ref-name":"UnsubscribedEmail"},"UpdateInspectionBody":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}","properties":{"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"}},"required":["organization_address","organization_address_lat","organization_address_lng"],"type":"object","x-readme-ref-name":"UpdateInspectionBody"},"UpdateInspectionResult":{"additionalProperties":false,"description":"The response body for PUT /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection request","example":1843,"type":"number"}},"required":["id"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"UpdateInspectionResult"},"UpdateInternalNoteBody":{"x-readme-ref-name":"UpdateInternalNoteBody","additionalProperties":false,"description":"The request body for POST /inspections/{inspectionId}/internal-note","properties":{"note":{"description":"The note to add to the inspection.","type":"string"}},"required":["note"],"type":"object"},"UpdateTeamRequestBody":{"additionalProperties":false,"description":"The request body for the PUT /teams/{teamId} endpoint","properties":{"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"type":"object","x-readme-ref-name":"UpdateTeamRequestBody"},"UpdateTeamResult":{"additionalProperties":false,"description":"The response body for the PUT /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"type":"number"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"UpdateTeamResult"},"User":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"VerificationResult":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"VisionRole":{"description":"The possible roles in the Vision system","enum":["SUPER_ADMIN","VISION_AGENT_ADMIN","VISION_AGENT","VISION_CONSUMER","AUTH0_BOT","GROUP_AGENT","VISION_AGENT_OWN_INSPECTIONS","VIEW_ONLY","VISION_AGENT_REPORT"],"type":"string","x-readme-ref-name":"VisionRole"}},"securitySchemes":{"AccessToken":{"type":"http","description":"Authorization is done via OAuth 2's [client credentials flow](https://auth0.com/docs/flows/concepts/client-credentials).\n\nIn short, using the `client_id` and `client_secret` we issue you, you request an access token from our authorization service. You then include this access token in subsequent API requests in the `Authorization: Bearer {access_token}` header.\n\nEach access token is valid for 72 hours, and should be stored on your end so that it can be used for all API requests in that time frame. The time of expiration is included in both the authorization service response (`expires_in`) and decoded JWT access token (`exp`). There's no need to generate a new access token for every API request. When the access token has expired (or is close to expiring), simply make another request to our authorization service for a new one.\n\nAn access token can be generated by making a `POST` request to our authorization service's [token endpoint](https://auth0.com/docs/api/authentication?http#client-credentials-flow):\n\n```\nhttps://vision-auth.truepic.com/oauth/token\n```\n\nInclude the following `application/x-www-form-urlencoded` payload:\n\n```\n{\n audience: 'https://vision-api.truepic.com',\n grant_type: 'client_credentials',\n client_id: '{CLIENT_ID}',\n client_secret: '{CLIENT_SECRET}'\n}\n```","scheme":"bearer","bearerFormat":"JWT"},"OAuth2ClientCredentials":{"type":"oauth2","description":"See `AccessToken` above.","flows":{"clientCredentials":{"tokenUrl":"https://vision-auth.truepic.com/oauth/token","scopes":{}}}}}},"paths":{"/inspections":{"get":{"tags":["Inspections"],"summary":"Get a list of inspection requests","responses":{"200":{"description":"The request for a list of inspection requests was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"Response Body for GET /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetInspectionsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"team_id","in":"query","description":"The ID of the team to return inspection requests created under.\n\nIf not set, inspection requests from all teams are returned.\n","schema":{"type":"integer","example":123}},{"name":"filter","in":"query","explode":true,"style":"deepObject","description":"Filters to limit the results returned.","schema":{"type":"object","properties":{"team_id":{"type":"object","description":"Filter by the ID of the team.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"status":{"type":"object","description":"Filter by the ID of the status.","properties":{"=":{"type":"integer","example":3},"in":{"type":"array","items":{"type":"integer"},"example":[1,2]}}},"member":{"type":"object","description":"Filter by the ID of the member who created the inspection request. Same as `created_by_member`.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"created_by_member":{"type":"object","description":"Filter by the ID of the member who created the inspection request. Same as `member`.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"assigned_to_member":{"type":"object","description":"Filter by the ID of the member who is currently assigned to the inspection request.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"unique_id":{"type":"object","description":"Filter by the identifier that you use to reference the customer in your system.","properties":{"=":{"type":"string","example":"abc123"}}},"unique_id_two":{"type":"object","description":"Filter by the second identifier that you use to reference the customer in your system.","properties":{"=":{"type":"string","example":"def456"}}},"custom_field_1":{"type":"object","description":"Filter by first custom field specified on the inspection type.","properties":{"=":{"type":"string","example":"abc123"}}},"custom_field_2":{"type":"object","description":"Filter by the second custom field specified on the inspection type.","properties":{"=":{"type":"string","example":"def456"}}},"photos":{"type":"object","description":"Filter by whether the inspection request has photos/videos or not.","properties":{"is":{"nullable":true,"example":null},"is not":{"nullable":true,"example":null}}},"verification":{"type":"object","description":"Filter by the aggregate verification result of all photos/videos.","properties":{"in":{"type":"array","items":{"type":"string","enum":["pass","fail","warn"]},"example":"pass"}}},"group_id":{"type":"object","description":"Filter by the ID of the group that self-initiated the inspection request.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"inspection_type":{"type":"object","description":"Filter by the ID of the inspection type.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"outcome":{"type":"object","description":"Filter by the ID of an outcome.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"created_at":{"type":"object","description":"Filter by the date/time when the inspection request was created.","properties":{">":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},">=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"}}},"scheduled_for":{"type":"object","description":"Filter by the date/time when the inspection is scheduled for.","properties":{">":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},">=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"}}}}}},{"$ref":"","name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"status":{"type":"string","description":"Sort by the name of the status.","enum":["asc","desc"],"example":"asc"},"inspection_type":{"type":"string","description":"Sort by the name of the inspection type.","enum":["asc","desc"],"example":"asc"},"member":{"type":"string","description":"Sort by the last name of the member who created the inspection request. Same as `created_by_member`.","enum":["asc","desc"],"example":"asc"},"created_by_member":{"type":"string","description":"Sort by the last name of the member who created the inspection request. Same as `member`.","enum":["asc","desc"],"example":"asc"},"assigned_to_member":{"type":"string","description":"Sort by the last name of the member who is currently assigned to the inspection request.","enum":["asc","desc"],"example":"asc"},"photos":{"type":"string","description":"Sort by the date/time when the last photo/video was uploaded.","enum":["asc","desc"],"example":"asc"},"verification":{"type":"string","description":"Sort by the aggregate verification result of all photos/videos.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the inspection request was created.","enum":["asc","desc"],"example":"asc"},"scheduled_for":{"type":"string","description":"Sort by the date/time when the inspection request was scheduled.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}]},"post":{"tags":["Inspections"],"summary":"Create an inspection","responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"Response body for POST /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"alert":{"additionalProperties":false,"properties":{"config":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"failures":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"},"recommendation":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"warnings":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object","x-readme-ref-name":"InspectionAlertResult"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object","x-readme-ref-name":"Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"list":{"additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object","x-readme-ref-name":"InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this organization has been soft-deleted.","example":true,"type":"boolean"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object","x-readme-ref-name":"Organization"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"Team"},"outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object","x-readme-ref-name":"Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this action has been soft-deleted","example":true,"type":"boolean"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object","x-readme-ref-name":"TimelineAction"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","has_survey_available","id","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","organization","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"CreateInspectionResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"include","in":"query","description":"The top-level `result` fields to include in the response.\n\nIf not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.\n","schema":{"type":"array","items":{"type":"string"},"example":["customer_first_name","customer_last_name","organization_team","inspection_type"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"assigned_to_member_user":{"description":"The user to assign the inspection to. Can be either a user ID or an email address.","type":"string"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"include_list":{"description":"This must be set to `true` when including items in the `list` object.","type":"boolean","default":false,"example":false},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"list":{"additionalProperties":false,"description":"Populate this object with list items to prompt the user for specific photos, videos, or questions during the inspection.","properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"}},"type":"object","x-readme-ref-name":"CreateInspectionBody"}}}}}},"/inspections/{inspectionId}/complete":{"post":{"tags":["Inspections"],"summary":"Complete an inspection","description":"Finish an inspection request and set it to Ready for Review. The inspection request must be In Progress, otherwise a `400` error will be returned.","responses":{"200":{"description":"The inspection request was successfully finished and set to Ready for Review.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}}]}},"/inspections/{inspectionId}":{"get":{"tags":["Inspections"],"summary":"Get an inspection","responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"Response Body for GET /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"alert":{"additionalProperties":false,"properties":{"config":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"failures":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"},"recommendation":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult"},"warnings":{"items":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["photo_id","test_key"],"type":"object","x-readme-ref-name":"AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object","x-readme-ref-name":"InspectionAlertResult"},"app_opened":{"default":false,"description":"Whether the Vision app has been opened by the customer","example":true,"type":"boolean"},"assigned_to_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object","x-readme-ref-name":"Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":{"default":false,"description":"Represents if the inspection has been soft-deleted","example":true,"type":"boolean"},"is_expired":{"default":false,"description":"Whether the inspection has expired","example":true,"type":"boolean"},"list":{"additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object","x-readme-ref-name":"InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the features that are enabled for this organization.","properties":{"ask_for_app_review":{"description":"When true instructs the app to ask the user for a review for the Truepic Vision app after an inspection has been completed.","example":false,"type":"boolean"},"content_analysis":{"additionalProperties":false,"description":"A configuration object showing the content analysis features that are enabled for this organization.","properties":{"ODOMETER":{"description":"Whether odometer detection is enabled for this organization","example":true,"type":"boolean"},"TEXT_MATCHING":{"description":"Whether text matching is enabled for this organization","example":true,"type":"boolean"},"VIN":{"description":"Whether VIN detection is enabled for this organization","example":true,"type":"boolean"}},"required":["ODOMETER","TEXT_MATCHING","VIN"],"type":"object"},"object_detection":{"additionalProperties":false,"description":"A configuration object showing the object detection features that are enabled for this organization.","properties":{"auto":{"description":"Whether the automotive object detection feature is enabled for this organization","example":true,"type":"boolean"},"jewelry":{"description":"Whether the jewelry detection feature is enabled for this organization","example":true,"type":"boolean"},"real_estate":{"description":"Whether the real estate object detection feature is enabled for this organization","example":true,"type":"boolean"}},"required":["auto","jewelry","real_estate"],"type":"object"},"vehicle_details":{"description":"Whether vehicle detection is enabled for this organization.","example":true,"type":"boolean"}},"required":["vehicle_details","ask_for_app_review"],"type":"object"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this organization has been soft-deleted.","example":true,"type":"boolean"},"is_mfa_required":{"default":false,"description":"Whether multi-factor authentication is required for user login.","example":true,"type":"boolean"},"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object","x-readme-ref-name":"Organization"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object","x-readme-ref-name":"Team"},"outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object","x-readme-ref-name":"Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"archived":{"description":"Whether the Truepic has been archived","example":true,"type":"boolean","default":false},"blockchain_status":{"description":"The status of a blockchain test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"capture_integrity_status":{"description":"The status of a capture integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"description":"The status of a content analysis test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"description":"The status of a datetime test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_integrity_status":{"description":"The status of a device integrity test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"description":"The status of a geolocation test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":{"description":"Whether this Truepic has been deleted.","example":true,"type":"boolean","default":false},"is_rooted":{"description":"Whether the device that captured the Truepic is rooted","example":true,"type":"boolean","default":false},"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":{"description":"Whether the transfer from Lens is complete for this Truepic.","example":true,"type":"boolean","default":false},"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"description":"The status of an object detection test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":{"description":"Whether the Truepic is still uploading","example":true,"type":"boolean","default":false},"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"description":"The status of a picture-of-paper test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis ,etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"description":"The status of a reverse-image-search test on this Truepic.","example":"P","enum":["P","W","F","U","N"],"type":"string","x-readme-ref-name":"TestResult"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":{"description":"Whether the status for this Truepic has been overridden","example":true,"type":"boolean","default":false},"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object","x-readme-ref-name":"InspectionTruepic"},"type":"array"},"platform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string","x-readme-ref-name":"InspectionPlatform"},"property_uid":{"description":"The Source7 `property_uid` for this inspection. Used to identify map appliances to a common location (business or residence) for appliance object detection tests.","example":"23523f23-23f23f23-f23f23f23-r23t33f","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object","x-readme-ref-name":"InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this action has been soft-deleted","example":true,"type":"boolean"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object","x-readme-ref-name":"TimelineAction"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"description":"The aggregate verification result of all photos/videos","enum":["pass","fail","warn"],"type":"string","x-readme-ref-name":"VerificationResult","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","has_survey_available","id","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","organization","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetInspectionResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}},{"name":"include","in":"query","description":"The top-level `result` fields to include in the response.\n\nIf not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.\n","schema":{"type":"array","items":{"type":"string"},"example":["customer_first_name","customer_last_name","organization_team","inspection_type"]}}]},"put":{"tags":["Inspections"],"summary":"Update an inspection","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}","properties":{"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"inspection_status_id":{"description":"The id of the inspection status this inspection is in.","example":4,"enum":[1,2,3,4,5,6,7],"type":"number","x-readme-ref-name":"InspectionStatusId"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"}},"required":["organization_address","organization_address_lat","organization_address_lng"],"type":"object","x-readme-ref-name":"UpdateInspectionBody"}}}},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for PUT /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection request","example":1843,"type":"number"}},"required":["id"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"UpdateInspectionResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}}]}},"/inspections/{inspectionId}/export":{"get":{"tags":["Inspections"],"description":"Exactly the same as the matching `POST` endpoint, but is limited in the amount of data that can be passed in the query string due to the maximum URL length allowed by browsers. Use the `POST` endpoint to send larger payloads.","summary":"Export a PDF of an inspection","parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}},{"name":"async","in":"query","description":"Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\n\nIf `0` (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.\n\nIf `1`, the PDF is queued for asynchronous export and an `Operation` is returned to track its progress. This is recommended.\n","schema":{"type":"boolean","example":true}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"Filters to limit what's included in the PDF.","schema":{"type":"object","required":["photos"],"properties":{"photos":{"type":"array","description":"Limit the PDF to a subset of photos/videos.","items":{"type":"integer","description":"The ID of a photo/video to include in the PDF.","example":123}}}}},{"name":"tz","in":"query","description":"The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC.","schema":{"type":"string","example":"America/New_York"}}],"responses":{"200":{"description":"The PDF was successfully exported synchronously.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"The PDF was successfully queued for asynchronous export.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","required":["result"],"properties":{"result":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object","x-readme-ref-name":"Operation"}}}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"post":{"tags":["Inspections"],"description":"Exactly the same as the matching `GET` endpoint, but allows for a larger payload, as it's sent in the body instead of the query string.","summary":"Export a PDF of an inspection","parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"The PDF was successfully exported synchronously.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"The PDF was successfully queued for asynchronous export.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","required":["result"],"properties":{"result":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object","x-readme-ref-name":"Operation"}}}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request body for POST /inspections/{inspectionId}/export","properties":{"async":{"description":"Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\\n\\nIf `false` (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.\\n\\nIf `true`, the PDF is queued for asynchronous export and an `Operation` is returned to track its progress. This is recommended.","example":true,"type":"boolean"},"filter":{"additionalProperties":false,"description":"Filters to limit what's included in the PDF.","properties":{"photos":{"description":"Limit the PDF to a subset of photos/videos. A list of IDs of photso/videos to include in the PDF.","items":{"type":"number"},"type":"array"}},"required":["photos"],"type":"object"}},"required":["async","filter"],"type":"object","x-readme-ref-name":"ExportInspectionPDFBody"}}}}}},"/inspections/{inspectionId}/{listItemId}/ca/vin/{vinNumber}":{"get":{"tags":["Inspections"],"summary":"Request details about a vehicle","responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /inspections/{inspectionId}/{listItemId}/ca/vin/{vinNumber}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"details":{"description":"Further vehicle details, format defined by vendor","type":"object"},"request_dates":{"description":"The timestamps of all of the requests to the VIN API service","example":["2022-09-28 20:21:07.96","2022-09-28 20:22:10.73","2022-09-29 11:30:50.298"],"format":"date-time[]","items":{"type":"string"},"type":"array"}},"required":["request_dates","details"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetVehicleDetailsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}},{"name":"listItemId","in":"path","description":"The ID of the existing list item (entry in a list).","required":true,"schema":{"type":"integer","example":123}},{"name":"vinNumber","in":"path","description":"A Vehicle Identification Number used to uniquely identify a vehicle","required":true,"schema":{"type":"string","example":"5UXWX7C44CL737653"}},{"name":"retry","in":"query","description":"If set to true, then the vehicle information will be re-fetched\nfrom the source, rather than taken from the cache.\n","schema":{"type":"boolean","example":true}}]}},"/inspections/{inspectionId}/inspection-type":{"put":{"tags":["Inspections"],"summary":"Update the type of an existing inspection","description":"Updates the type of an existing inspection. The inspection type can only be changed to a inspection type that is assigned to the inspection's team. Changing the type of an inspection will delete any already-uploaded Truepics and will automatically re-send the request email/text to the customer. This endpoint will also set the inspection status to `Created`. Closed or Canceled inspections cannot have their inspection type changed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}/inspection-type","properties":{"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"}},"required":["inspection_type_id"],"type":"object","x-readme-ref-name":"ChangeInspectionTypeBody"}}}},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}}]}},"/org-asset/{assetType}/upload":{"post":{"tags":["Lists"],"summary":"Upload an example photo","description":"This endpoint will return image URLs for a resized 1000px max width/height version and a 320x320 thumbnail version. These URLs can be used in the payload of the \"PUT/POST /lists/{listID}\" endpoint to attach an example photo to a list item. This endpoint currently only accepts png/jpg files, with a max file size of 100MB. There are no limits on uploaded image dimensions.","parameters":[{"in":"path","name":"assetType","description":"The type of asset being uploaded","schema":{"type":"string","enum":["list-item-example-photo"]},"required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"asset":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for POST /org-asset/{assetType}/upload","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"org_asset":{"type":"string"},"org_asset_square":{"type":"string"}},"required":["org_asset"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"PostOrgAssetResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/organization-teams":{"post":{"tags":["Teams"],"summary":"Create a team","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"copy_inspection_type_assignments":{"description":"Whether to copy inspection type assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"copy_user_assignments":{"description":"Whether to copy user assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"template_team_id":{"description":"The ID of the team you want to use as a template for this new team","example":1843,"type":"number"}},"type":"object","x-readme-ref-name":"CreateTeamParams"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"get":{"tags":["Teams"],"summary":"Get a list of teams","responses":{"200":{"description":"The request for a list of existing teams was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetTeamsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `name` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the team.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the team was created.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","explode":true,"description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}},{"name":"excludeNestedData","in":"query","description":"Exclude nested team data (lists, message templates, etc.) in the response body.","schema":{"type":"boolean"}}]}},"/organization-teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get a team","responses":{"200":{"description":"The request for a specific team was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for the GET /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_smart_link_branch_key":{"description":"The cleartext custom Branch key to use when generating an inspection smart link. This value is never stored directly in the database; rather, it's stored encrypted as `custom_smart_link_branch_key_encrypted`.","type":"string","nullable":true},"custom_smart_link_branch_key_encrypted":{"description":"The encrypted custom Branch key from `custom_smart_link_branch_key`.","type":"string","nullable":true},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"15162711526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"groups":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"include_list":{"description":"Whether to include the inspection type's list by default with new inspection requests.","example":true,"type":"boolean","default":false},"inspection_types":{"items":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"type":"array"},"is_deleted":{"description":"Whether or not this config has been soft-deleted","example":true,"type":"boolean","default":false},"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"list":{"items":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"type":"array"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"twilio_contact_number":{"description":"The Twilio phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":{"description":"Whether video is enabled as a capture method in the app.","example":true,"type":"boolean","default":false}},"required":["organization_id","is_deleted","jwt_organization_expiry","jwt_member_admin_expiry","shortname","created_at","updated_at","inspection_types"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetTeamResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]},"put":{"tags":["Teams"],"summary":"Update team","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The request body for the PUT /teams/{teamId} endpoint","properties":{"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"type":"object","x-readme-ref-name":"UpdateTeamRequestBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for the PUT /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"type":"number"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"UpdateTeamResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]}},"/organization-teams/{teamId}/assets/{assetType}":{"post":{"tags":["Teams"],"summary":"Upload team assets","description":"Upload a team logo or icon image. Accepts PNG files only. Logo images must be at least 369x102 (WxH). Icon images must be at least 180x180.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"asset":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for POST /organization-teams/{teamId}/assets/{assetType}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"An array of urls for different resolutions of the uploaded asset","items":{"type":"string"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"PostTeamAssetByTypeResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"assetType","in":"path","required":true,"description":"The type of asset to upload","schema":{"type":"string","enum":["icon","logo"]}},{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]}},"/{organizationId}/organization-teams":{"get":{"tags":["Teams"],"summary":"Get a list of teams","responses":{"200":{"description":"The request for a list of existing teams was successful.","content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetTeamsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"organizationId","in":"path","description":"The ID of the existing organization.","required":true,"schema":{"type":"integer","example":123}},{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `name` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the team.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the team was created.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","explode":true,"description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}},{"name":"excludeNestedData","in":"query","description":"Exclude nested team data (lists, message templates, etc.) in the response body.","schema":{"type":"boolean"}}],"deprecated":true}},"/lists":{"get":{"tags":["Lists"],"summary":"Get lists","parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the list.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the list was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the list was updated.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetListsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"post":{"tags":["Lists"],"summary":"Create a list","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request Body for POST /inspections","x-readme-ref-name":"CreateListBody","additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["items","name"],"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created list"}}}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/lists/{listId}":{"get":{"tags":["Lists"],"summary":"Get a list","parameters":[{"name":"listId","in":"path","description":"The ID of the existing list.","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetListsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"put":{"tags":["Lists"],"summary":"Update a list","parameters":[{"name":"listId","in":"path","description":"The ID of the existing list.","required":true,"schema":{"type":"integer","example":123}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request Body for POST /inspections","x-readme-ref-name":"CreateListBody","additionalProperties":false,"properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["items","name"],"type":"object"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"delete":{"tags":["Lists"],"summary":"Delete a list","parameters":[{"name":"listId","in":"path","description":"The ID of the existing list.","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/operations/{operationId}":{"get":{"tags":["Operations"],"summary":"Get an existing operation to track its progress","parameters":[{"name":"operationId","in":"path","description":"The ID of the existing operation.","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /operations/{operationId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object","x-readme-ref-name":"Operation"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetOperationResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/text/welcome":{"put":{"tags":["Text"],"summary":"Send the original inspection request via text/email.","description":"The inspection request must be in a state of Created or Started.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The request body for PUT /text/welcome","properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object","x-readme-ref-name":"SendWelcomeTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for PUT /text/welcome","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"SendWelcomeTextResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/text/request":{"put":{"tags":["Text"],"summary":"Send a request for more photos/videos via text/email.","description":"The inspection request must be in a state of Created, Started, In Progress, or Ready for Review. If in Ready for Review, the status is moved back to In Progress. To mark a list item as incomplete, include a list and set the `incomplete` property on the list item to `true`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The request body for PUT /text/request","properties":{"include_list":{"description":"Set to true when sending list items in the `list` property.","example":true,"type":"boolean","default":false},"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"list":{"additionalProperties":false,"description":"A list with attached list items. This can be used to mark existing list items as incomplete, or to add new list items to the list, or both.","properties":{"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"additionalProperties":false,"description":"A question on a list item","properties":{"answer":{"anyOf":[{"nullable":true},{"type":"string"},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"If type is `TEXT`, will be the app user's text string answer to the question. If type is `MULTIPLE_CHOICE`, will be an array containing a list of selected answers. Will be `null` if the question has not yet been answered."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"anyOf":[{"nullable":true},{"additionalProperties":false,"properties":{"allow_multiple":{"description":"Whether to allow the app user to select multiple answers.","example":true,"type":"boolean"},"choices":{"description":"The list of answers the app user has chosen for the question","items":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object","x-readme-ref-name":"ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"}],"description":"If type is `MULTIPLE_CHOICE`, will be an array containing a list of possible answers. Will be `null` if the type is `TEXT`"},"type":{"description":"The type of question this list item is. Must me `MULTIPLE_CHOICE` or `TEXT`","enum":["MULTIPLE_CHOICE","TEXT"],"example":"TEXT","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object","x-readme-ref-name":"ListItemQuestion"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"}},"required":["id","is_required","name","type"],"type":"object","x-readme-ref-name":"ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object","x-readme-ref-name":"SendRequestMoreTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"description":"The response body for PUT /text/request","x-readme-ref-name":"SendRequestMoreTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/text/reminder":{"put":{"tags":["Text"],"summary":"Send a reminder to start the inspection via text/email.","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"The request body for PUT /text/reminder","x-readme-ref-name":"SendReminderTextBody","additionalProperties":false,"properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"description":"The response body for PUT /text/reminder","x-readme-ref-name":"SendReminderTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/text/reminder-to-finish":{"put":{"tags":["Text"],"summary":"Send a reminder to finish the inspection via text/email.","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"The request body for PUT /text/reminder-to-finish","x-readme-ref-name":"SendFinishReminderTextBody","additionalProperties":false,"properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"description":"The response body for PUT /text/reminder-to-finish","x-readme-ref-name":"SendFinishReminderTextResult","additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/":{"get":{"tags":["General"],"summary":"Get API Status","description":"Can also use /online path","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/inspection-types":{"get":{"tags":["Inspection Types"],"summary":"Get a list of inspection types","parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the list.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the list was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the list was updated.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language","created_at","updated_at"],"type":"object","x-readme-ref-name":"InspectionTypeData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetInspectionTypesResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"post":{"tags":["Inspection Types"],"summary":"Create an inspection type","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language"],"type":"object","x-readme-ref-name":"CreateInspectionTypeBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created inspection type"}}}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/inspection-types/{inspectionTypeId}":{"get":{"tags":["Inspection Types"],"summary":"Get an inspection type by id","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object","x-readme-ref-name":"CustomFieldOption"},"type":"array"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"},"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object","x-readme-ref-name":"UniqueID2"},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"additionalProperties":false,"description":"The alert configuration that is used by this inspection type.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this alert has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Fraud Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_integrity","test_distance_from_address","test_geolocationlocation","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object","x-readme-ref-name":"InspectionAlertConfig"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}},"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object","x-readme-ref-name":"ListItemGroups"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":{"description":"Whether this inspection type is deleted","example":true,"type":"boolean","default":false},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object","x-readme-ref-name":"InspectionType"},"type":"array"},"is_deleted":{"default":false,"description":"Whether or not this list has been soft-deleted","example":true,"type":"boolean"},"items":{"items":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"The condition id used to create conditional list items","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the condition","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information.","additionalProperties":false,"properties":{"expected":{"description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests.","example":"DG1FGA21D4TD173601","anyOf":[{"type":"string"},{"nullable":true},{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array","x-readme-ref-name":"TextMatchingExpectedValues"}],"x-readme-ref-name":"ContentAnalysisExpectedValue"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"description":"The type of the content analysis test. Must be VIN or ODOMETER .","example":"VIN","enum":["ODOMETER","VIN","TEXT_MATCHING"],"type":"string","x-readme-ref-name":"ContentAnalysisType"}},"required":["type"],"type":"object","x-readme-ref-name":"ContentAnalysisDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":{"description":"Whether or not this item has been soft-deleted","example":true,"type":"boolean","default":false},"is_required":{"description":"Whether the photo/video/question is required to finish the inspection.","example":true,"type":"boolean","default":false},"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"description":"An object containing information about the expected items in a Truepic.","additionalProperties":false,"properties":{"category":{"description":"The category of item expected in this list item","example":"jewelry","enum":["jewelry","auto","real_estate","appliance"],"type":"string","x-readme-ref-name":"ObjectDetectionCategory"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"anyOf":[{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string","x-readme-ref-name":"ObjectDetectionAutomotiveObject"},{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string","x-readme-ref-name":"ObjectDetectionJewelryObject"},{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string","x-readme-ref-name":"ObjectDetectionRealEstateObject"},{"enum":["air_conditioner","heat_pump","boiler","clothes_dryer","cooktop","dishwasher","furnace","microwave","range","refrigerator","washing_machine","water_heater_electric","water_heater_gas"],"type":"string","x-readme-ref-name":"ObjectDetectionApplianceObject"}],"x-readme-ref-name":"ObjectDetectionObject"},"type":"array"},"warn_if":{"description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected. Not applicable when `category` is `appliance`","enum":["NONE","ANY"],"type":"string","x-readme-ref-name":"ObjectDetectionWarningMethodology"}},"required":["category"],"type":"object","x-readme-ref-name":"ObjectDetectionConfig"},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"description":"The type of the list item.","enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string","x-readme-ref-name":"ListItemType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object","x-readme-ref-name":"ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE","enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string","x-readme-ref-name":"ListType"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"description":"The message template set associated with this Inspection Type","additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":{"default":false,"description":"Whether or not this message template set has been soft-deleted","example":true,"type":"boolean"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSet"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set":{"description":"The outcome set that is used by this inspection type.","additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":{"default":false,"description":"Whether or not this outcome set has been soft-deleted","example":true,"type":"boolean"},"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object","x-readme-ref-name":"OutcomeSet"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","language","created_at","updated_at","custom_fields","list","message_template_set"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetInspectionTypeResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"put":{"tags":["Inspection Types"],"summary":"Update an inspection type","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"description":"The entry method for the custom field","enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string","x-readme-ref-name":"CustomFieldEntryMethods"},"is_required":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean","default":false},"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object","x-readme-ref-name":"CustomField"},"type":"array"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.","enum":["en","es","fr-ca"],"type":"string","x-readme-ref-name":"LocalizationLanguages"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language"],"type":"object","x-readme-ref-name":"CreateInspectionTypeBody"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"delete":{"tags":["Inspection Types"],"summary":"Delete an inspection type","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/message-template-sets":{"get":{"tags":["Message Template Sets"],"summary":"Get a list of message template sets","parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the list.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the list was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the list was updated.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSetData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object","x-readme-ref-name":"GetMessageTemplateSetsResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"post":{"tags":["Message Template Sets"],"summary":"Create a message template set","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"}},"required":["name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject"],"type":"object","x-readme-ref-name":"CreateMessageTemplateSetBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created message template set"}}}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}},"/message-template-sets/{messageTemplateSetId}":{"get":{"tags":["Message Template Sets"],"summary":"Get a message template set by id","parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object","x-readme-ref-name":"MessageTemplateSetData"}},"required":["api_version","message","response_code","result"],"type":"object","x-readme-ref-name":"GetMessageTemplateResult"}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"put":{"tags":["Message Template Sets"],"summary":"Update a message template set","parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user. Only sent for text messages (not emails)","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"}},"required":["name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject"],"type":"object","x-readme-ref-name":"CreateMessageTemplateSetBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}},"delete":{"tags":["Message Template Sets"],"summary":"Delete a message template set","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"}]}}}},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}},"parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}]}},"/open-api":{"get":{"tags":["OpenAPI"],"summary":"Get the public Vision OpenAPI definition","responses":{"200":{"description":"Returns an OpenAPI object detailing all public Vision API endpoints"},"400":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":400},"message":{"example":"Inspection ID missing"}}}]}}}},"401":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":401},"message":{"example":"Unauthorized"}}}]}}}},"403":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":403},"message":{"example":"Forbidden"}}}]}}}},"404":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":404},"message":{"example":"Not Found "}}}]}}}},"412":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":412},"message":{"example":"Not a mobile number"}}}]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"2.2.8","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object","x-readme-ref-name":"ResponseData"},{"type":"object","properties":{"response_code":{"example":500},"message":{"example":"An error occurred"}}}]}}}}}}}},"security":[{"AccessToken":[]},{"OAuth2ClientCredentials":[]}]},"stats":{"additional_properties":true,"callbacks":false,"circular_references":false,"common_parameters":false,"discriminators":false,"links":false,"polymorphism":true,"server_variables":false,"style":false,"webhooks":false,"xml":false,"references":true},"source":"rdme","uri":"/versions/3/apis/vision-api-v3.json"},"connections":{"recipes":[]}},"meta":{"baseUrl":"/","description":"","hidden":false,"image":[],"metaTitle":"Create an inspection","robots":"index","slug":"post_inspections","title":"Create an inspection","type":"reference"},"oauth":false,"rdmd":{"baseUrl":"/","body":"","dehydrated":{"toc":"","body":""},"mdx":true,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"lazyImages":true,"normalize":true,"safeMode":false,"settings":{"position":false},"theme":"light","customBlocks":{},"resourceID":"/versions/3/reference/post_inspections","resourceType":"page","components":{},"baseUrl":"/","terms":[{"_id":"6464e41aeec964003faf6b07","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"server","type":"","_id":"64937ac8b5465f0305c3bb70","name":"subdomain","default":"my-subdomain","apiSetting":"64936ae7b5465f0305c2b8bf"},{"source":"server","type":"","_id":"64937b61d8fcb5003d661c4f","name":"organization-slug","default":"my-org-slug","apiSetting":"64936ae7b5465f0305c2b8c0"},{"source":"security","type":"http","_id":"66abf221e06d8f001d24719b","name":"apiKey","scheme":"bearer","apiSetting":"66abf220e06d8f001d247198"},{"source":"security","type":"http","_id":"67abd3cea601f30010043cf4","name":"AccessToken","scheme":"bearer","apiSetting":"64ac27a651ba5f07331fac3a"},{"source":"security","type":"oauth2","_id":"67abd3cea601f30010043cf3","name":"OAuth2ClientCredentials","apiSetting":"64ac27a651ba5f07331fac3a"}]}},"terms":[{"_id":"6464e41aeec964003faf6b07","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"server","type":"","_id":"64937ac8b5465f0305c3bb70","name":"subdomain","default":"my-subdomain","apiSetting":"64936ae7b5465f0305c2b8bf"},{"source":"server","type":"","_id":"64937b61d8fcb5003d661c4f","name":"organization-slug","default":"my-org-slug","apiSetting":"64936ae7b5465f0305c2b8c0"},{"source":"security","type":"http","_id":"66abf221e06d8f001d24719b","name":"apiKey","scheme":"bearer","apiSetting":"66abf220e06d8f001d247198"},{"source":"security","type":"http","_id":"67abd3cea601f30010043cf4","name":"AccessToken","scheme":"bearer","apiSetting":"64ac27a651ba5f07331fac3a"},{"source":"security","type":"oauth2","_id":"67abd3cea601f30010043cf3","name":"OAuth2ClientCredentials","apiSetting":"64ac27a651ba5f07331fac3a"}]}},"sidebar":[{"pages":[],"title":"ReadMeConfig","uri":"/versions/3/categories/reference/ReadMeConfig"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"inspections-all","title":"Inspections","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_inspections","title":"Create an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_inspections","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_inspections-inspectionid-complete","title":"Complete an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_inspections-inspectionid-complete","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspections","title":"Get a list of inspection requests","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspections","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspections-inspectionid","title":"Get an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspections-inspectionid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_inspections-inspectionid","title":"Update an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_inspections-inspectionid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_inspections-inspectionid-export","title":"Export a PDF of an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_inspections-inspectionid-export","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspections-inspectionid-export","title":"Export a PDF of an inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspections-inspectionid-export","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspections-inspectionid-listitemid-ca-vin-vinnumber","title":"Request details about a vehicle","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspections-inspectionid-listitemid-ca-vin-vinnumber","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_inspections-inspectionid-inspection-type","title":"Update the type of an existing inspection","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_inspections-inspectionid-inspection-type","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspections-all"}],"uri":"/versions/3/reference/inspections-all","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"lists","title":"Lists","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_lists","title":"Create a list","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_lists","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_org-asset-assettype-upload","title":"Upload an example photo","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_org-asset-assettype-upload","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_lists-listid","title":"Get a list","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_lists-listid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_lists","title":"Get lists","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_lists","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_lists-listid","title":"Update a list","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_lists-listid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete_lists-listid","title":"Delete a list","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/versions/3/reference/delete_lists-listid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/lists"}],"uri":"/versions/3/reference/lists","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"teams","title":"Teams","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_organization-teams","title":"Create a team","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_organization-teams","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_organization-teams-teamid-assets-assettype","title":"Upload team assets","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_organization-teams-teamid-assets-assettype","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_organization-teams","title":"Get a list of teams","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_organization-teams","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_organization-teams-teamid","title":"Get a team","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_organization-teams-teamid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"},{"deprecated":true,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_organizationid-organization-teams","title":"Get a list of teams","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_organizationid-organization-teams","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_organization-teams-teamid","title":"Update team","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_organization-teams-teamid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/teams"}],"uri":"/versions/3/reference/teams","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"operations","title":"Operations","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_operations-operationid","title":"Get an existing operation to track its progress","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_operations-operationid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/operations"}],"uri":"/versions/3/reference/operations","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"text","title":"Text","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_text-welcome","title":"Send the original inspection request via text/email.","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_text-welcome","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/text"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_text-request","title":"Send a request for more photos/videos via text/email.","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_text-request","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/text"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_text-reminder","title":"Send a reminder to start the inspection via text/email.","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_text-reminder","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/text"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_text-reminder-to-finish","title":"Send a reminder to finish the inspection via text/email.","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_text-reminder-to-finish","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/text"}],"uri":"/versions/3/reference/text","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"general","title":"General","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_api_status","title":"Get API Status","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_api_status","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/general"}],"uri":"/versions/3/reference/general","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"inspection-types","title":"Inspection Types","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_inspection-types","title":"Create an inspection type","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_inspection-types","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspection-types"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspection-types","title":"Get a list of inspection types","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspection-types","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspection-types"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_inspection-types-inspectiontypeid","title":"Get an inspection type by id","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_inspection-types-inspectiontypeid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspection-types"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_inspection-types-inspectiontypeid","title":"Update an inspection type","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_inspection-types-inspectiontypeid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspection-types"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete_inspection-types-inspectiontypeid","title":"Delete an inspection type","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/versions/3/reference/delete_inspection-types-inspectiontypeid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/inspection-types"}],"uri":"/versions/3/reference/inspection-types","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"message-template-sets","title":"Message Template Sets","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"post_message-template-sets","title":"Create a message template set","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/versions/3/reference/post_message-template-sets","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/message-template-sets"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_message-template-sets","title":"Get a list of message template sets","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_message-template-sets","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/message-template-sets"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_message-template-sets-messagetemplatesetid","title":"Get a message template set by id","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_message-template-sets-messagetemplatesetid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/message-template-sets"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"put_message-template-sets-messagetemplatesetid","title":"Update a message template set","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/versions/3/reference/put_message-template-sets-messagetemplatesetid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/message-template-sets"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete_message-template-sets-messagetemplatesetid","title":"Delete a message template set","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/versions/3/reference/delete_message-template-sets-messagetemplatesetid","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/message-template-sets"}],"uri":"/versions/3/reference/message-template-sets","category":"/versions/3/categories/reference/Vision API - V3","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"open-api","title":"OpenAPI","type":"basic","updatedAt":"2025-02-28T11:46:49.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get_open-api","title":"Get the public Vision OpenAPI definition","type":"endpoint","updatedAt":"2025-02-28T11:46:49.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/versions/3/reference/get_open-api","category":"/versions/3/categories/reference/Vision API - V3","parent":"/versions/3/reference/open-api"}],"uri":"/versions/3/reference/open-api","category":"/versions/3/categories/reference/Vision API - V3","parent":null}],"title":"Vision API - V3","uri":"/versions/3/categories/reference/Vision API - V3"}],"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.326.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"6464e41aeec964003faf6b07","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"server","type":"","_id":"64937ac8b5465f0305c3bb70","name":"subdomain","default":"my-subdomain","apiSetting":"64936ae7b5465f0305c2b8bf"},{"source":"server","type":"","_id":"64937b61d8fcb5003d661c4f","name":"organization-slug","default":"my-org-slug","apiSetting":"64936ae7b5465f0305c2b8c0"},{"source":"security","type":"http","_id":"66abf221e06d8f001d24719b","name":"apiKey","scheme":"bearer","apiSetting":"66abf220e06d8f001d247198"},{"source":"security","type":"http","_id":"67abd3cea601f30010043cf4","name":"AccessToken","scheme":"bearer","apiSetting":"64ac27a651ba5f07331fac3a"},{"source":"security","type":"oauth2","_id":"67abd3cea601f30010043cf3","name":"OAuth2ClientCredentials","apiSetting":"64ac27a651ba5f07331fac3a"}]},"project":{"_id":"6464e41aeec964003faf6b06","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#ffffff","main_alt":"","header_text":"","body_highlight":"#1a6dff","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"line","colorScheme":"system","overlay":"blueprint","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":false,"logo":["https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png","c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png",351,80,"#40404f","https://files.readme.io/0354de3e98ce16399d000a86bc02277ab36da5841e602fccd56c30aaeef2b21a-truepic_vision_logo_black_REV.png","679b92a756bd6400247781bc"],"loginLogo":[],"logo_white":["https://files.readme.io/7bfa4f03a564a1d5a1a1b09ee65118bead7418041489d1cf86629e96f9696967-small-truepic_vision_logo_white_REV.png","7bfa4f03a564a1d5a1a1b09ee65118bead7418041489d1cf86629e96f9696967-small-truepic_vision_logo_white_REV.png",353,80,"#ffffff","https://files.readme.io/a1a35e7c9401493f58c4cf3132ad48c90c1aa010f533df402a64dc437a082883-truepic_vision_logo_white_REV.png","679b92bc82b36c006172daae"],"logo_white_use":false,"logo_large":true,"favicon":["https://files.readme.io/707fad0e172b1f6d73f8a7e001d0e47b461626e20d70fa293f983316f6af74da-small-truepic_vision_logo_black_fav.png","707fad0e172b1f6d73f8a7e001d0e47b461626e20d70fa293f983316f6af74da-small-truepic_vision_logo_black_fav.png",31,32,"#ffffff","https://files.readme.io/b1137a7940a07dee29635316f5437dd72b21e415636fd5ce0d7ec70f6558e8ce-truepic_vision_logo_black_fav.png","679b92ff3b13ba0030db5a2f"],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"html","buttonPrimary":"","buttonSecondary":"none"},"title":"The Truepic Developer Hub","text":"Welcome to the Truepic developer hub. You'll find comprehensive guides and documentation to help you start working with Truepic as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"6464e41aeec964003faf6b08"}],"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"vision.truepic.dev","childrenProjects":[],"derivedPlan":"startup2018","description":"","error404":"","experiments":[],"first_page":"docs","flags":{"allowApiExplorerJsonEditor":false,"allowDarkMode":true,"allowReusableOTPs":false,"alwaysShowDocPublishStatus":false,"allowXFrame":false,"correctnewlines":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"migrationRun":false,"migrationSwaggerRun":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"owlbotAi":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"superHub":true,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":true,"apiV2":false,"git":{"read":false,"write":false},"dashQuickstart":false,"superHubBeta":false,"disableAutoTranslate":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false},"fullBaseUrl":"https://vision.truepic.dev/","git":{"migration":{"createRepository":{"start":"2025-02-13T15:13:46.080Z","end":"2025-02-13T15:13:46.556Z","status":"successful"},"transformation":{"end":"2025-02-13T15:13:47.040Z","start":"2025-02-13T15:13:46.738Z","status":"successful"},"migratingPages":{"end":"2025-02-13T15:13:47.971Z","start":"2025-02-13T15:13:47.098Z","status":"successful"},"enableSuperhub":{"start":"2025-02-13T15:17:40.619Z","status":"successful","end":"2025-02-13T15:17:40.620Z"}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"6464e41aeec964003faf6b07","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"html","alignment":"left","html":"Something here"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":false,"logs":false,"custompages":true,"tutorials":false},"name":"Vision","nav_names":{"docs":"Docs","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":false,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":139},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":true,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"678159571b3f5c002432f8d1","version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["678159561b3f5c002432f874","678159561b3f5c002432f874","678159561b3f5c002432f875","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","678159561b3f5c002432f876","649353fa568fd2001df219ad","64935b2dcfe53800710196aa","64a5e3e1557b73006c076ae9","64a5e3e65cd783006a1dbc84","64a5e3f2eddb8700677703cb","64a5f16f78ed85002a18f6d3","64b15ce67bad3a00183d7c10","64b18076b598b4000b91d985","678159561b3f5c002432f877","678159561b3f5c002432f878","66abe6d806811b000f3c440e","678159561b3f5c002432f879","678159561b3f5c002432f87a","67818e7e1432db007477bfad","67818e85e0f2e50024ce7356"],"pdfStatus":"","project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2025-01-10T17:31:01.362Z","__v":1,"updatedAt":"2025-03-14T13:44:09.408Z","forked_from":"6464e41beec964003faf6b0c","apiRegistries":[{"name":"vision-api-v3.json","url":"1945vmrm7opk8x4"}]},"subdomain":"truepic-vision","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[{"type":"url","text":"Status ↗︎","url":"https://status.truepic.com"},{"type":"url","text":"Log In ↗︎","url":"https://vision.truepic.com"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2025-02-13T18:09:26.006Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"","versions":[{"_id":"64b15ca6c61225003be1d730","version":"0","version_clean":"0.0.0","codename":"v1","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["64b15ca6c61225003be1d704","64b15ca6c61225003be1d704","6464e41beec964003faf6b10","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","64b15ca6c61225003be1d705","649353fa568fd2001df219ad","64b15ca6c61225003be1d706","64b15ca6c61225003be1d707","64a5e3e65cd783006a1dbc84","64b15ca6c61225003be1d708","64b15ca6c61225003be1d709","64b15ca6c61225003be1d732","64b182550fbc1a0051765ff5"],"project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2023-07-14T14:33:10.269Z","__v":0,"updatedAt":"2025-03-14T14:02:43.795Z","forked_from":"6464e41beec964003faf6b0c","pdfStatus":"","apiRegistries":[{"name":"vision-api-v3","url":"4da24m5pnlva1"}]},{"_id":"6464e41beec964003faf6b0c","version":"1.1-v3-old","version_clean":"1.1.0-v3-old","codename":"v1.1","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["6464e41beec964003faf6b0e","6464e41beec964003faf6b0e","6464e41beec964003faf6b10","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","646ff1f7da741c0012bfc734","649353fa568fd2001df219ad","64935b2dcfe53800710196aa","64a5e3e1557b73006c076ae9","64a5e3e65cd783006a1dbc84","64a5e3f2eddb8700677703cb","64a5f16f78ed85002a18f6d3","64b15ce67bad3a00183d7c10","64b18076b598b4000b91d985","64b5972723955f000b5cd0c0","66a255cfbebd2b0018356197","66abe6d806811b000f3c440e","66abe95f0bf23000184611b3","66abf220e06d8f001d24719a"],"project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2023-05-17T14:26:35.306Z","__v":1,"updatedAt":"2025-03-14T14:05:43.969Z","pdfStatus":"","apiRegistries":[]},{"_id":"64ac27a651ba5f07331fac7a","version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["64ac27a651ba5f07331fac31","64ac27a651ba5f07331fac31","6464e41beec964003faf6b10","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","64ac27a651ba5f07331fac32","64ac27a651ba5f07331fac33","64ac27a651ba5f07331fac34","64ac27a651ba5f07331fac35","64ac27a651ba5f07331fac36","64ac27a651ba5f07331fac37","64ac27a651ba5f07331fac38","64ac27a651ba5f07331fac7c"],"project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2023-07-10T15:45:42.049Z","__v":0,"updatedAt":"2025-03-14T13:44:14.711Z","forked_from":"6464e41beec964003faf6b0c","pdfStatus":"","apiRegistries":[{"name":"vision-api-v2-deprecated","url":"1xqfgm712q2a5"}]},{"_id":"678159571b3f5c002432f8d1","version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["678159561b3f5c002432f874","678159561b3f5c002432f874","678159561b3f5c002432f875","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","678159561b3f5c002432f876","649353fa568fd2001df219ad","64935b2dcfe53800710196aa","64a5e3e1557b73006c076ae9","64a5e3e65cd783006a1dbc84","64a5e3f2eddb8700677703cb","64a5f16f78ed85002a18f6d3","64b15ce67bad3a00183d7c10","64b18076b598b4000b91d985","678159561b3f5c002432f877","678159561b3f5c002432f878","66abe6d806811b000f3c440e","678159561b3f5c002432f879","678159561b3f5c002432f87a","67818e7e1432db007477bfad","67818e85e0f2e50024ce7356"],"pdfStatus":"","project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2025-01-10T17:31:01.362Z","__v":1,"updatedAt":"2025-03-14T13:44:09.408Z","forked_from":"6464e41beec964003faf6b0c","apiRegistries":[{"name":"vision-api-v3.json","url":"1945vmrm7opk8x4"}]}],"variableDefaults":[{"source":"server","type":"","_id":"64937ac8b5465f0305c3bb70","name":"subdomain","default":"my-subdomain","apiSetting":"64936ae7b5465f0305c2b8bf"},{"source":"server","type":"","_id":"64937b61d8fcb5003d661c4f","name":"organization-slug","default":"my-org-slug","apiSetting":"64936ae7b5465f0305c2b8c0"},{"source":"security","type":"http","_id":"66abf221e06d8f001d24719b","name":"apiKey","scheme":"bearer","apiSetting":"66abf220e06d8f001d247198"},{"source":"security","type":"http","_id":"67abd3cea601f30010043cf4","name":"AccessToken","scheme":"bearer","apiSetting":"64ac27a651ba5f07331fac3a"},{"source":"security","type":"oauth2","_id":"67abd3cea601f30010043cf3","name":"OAuth2ClientCredentials","apiSetting":"64ac27a651ba5f07331fac3a"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"3"},"description":null,"glossary":[{"_id":"6464e41aeec964003faf6b07","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"homepage_url":null,"id":"6464e41aeec964003faf6b06","name":"Vision","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"truepic-vision","suggested_edits":"disabled","uri":"/projects/me","variable_defaults":[{"name":"subdomain","default":"my-subdomain","source":"server","type":"","id":"64937ac8b5465f0305c3bb70"},{"name":"organization-slug","default":"my-org-slug","source":"server","type":"","id":"64937b61d8fcb5003d661c4f"},{"name":"apiKey","scheme":"bearer","source":"security","type":"http","id":"66abf221e06d8f001d24719b"},{"name":"AccessToken","scheme":"bearer","source":"security","type":"http","id":"67abd3cea601f30010043cf4"},{"name":"OAuth2ClientCredentials","source":"security","type":"oauth2","id":"67abd3cea601f30010043cf3"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"enabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"enabled","migrated":"successful"},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"disabled","response_examples":"expanded","response_schemas":"expanded"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2025-02-13T18:09:26.006Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#ffffff","link_color":"#1a6dff","theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"large","dark_mode":{"uri":"/images/679b92bc82b36c006172daae","url":"https://files.readme.io/7bfa4f03a564a1d5a1a1b09ee65118bead7418041489d1cf86629e96f9696967-small-truepic_vision_logo_white_REV.png","name":"7bfa4f03a564a1d5a1a1b09ee65118bead7418041489d1cf86629e96f9696967-small-truepic_vision_logo_white_REV.png","width":353,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/a1a35e7c9401493f58c4cf3132ad48c90c1aa010f533df402a64dc437a082883-truepic_vision_logo_white_REV.png"}},"main":{"uri":"/images/679b92a756bd6400247781bc","url":"https://files.readme.io/c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png","name":"c898fa8d9d015fefedc8349c8f7c28bb4aed819adc0f985398074e4386911002-small-truepic_vision_logo_black_REV.png","width":351,"height":80,"color":"#40404f","links":{"original_url":"https://files.readme.io/0354de3e98ce16399d000a86bc02277ab36da5841e602fccd56c30aaeef2b21a-truepic_vision_logo_black_REV.png"}},"favicon":{"uri":"/images/679b92ff3b13ba0030db5a2f","url":"https://files.readme.io/707fad0e172b1f6d73f8a7e001d0e47b461626e20d70fa293f983316f6af74da-small-truepic_vision_logo_black_fav.png","name":"707fad0e172b1f6d73f8a7e001d0e47b461626e20d70fa293f983316f6af74da-small-truepic_vision_logo_black_fav.png","width":31,"height":32,"color":"#ffffff","links":{"original_url":"https://files.readme.io/b1137a7940a07dee29635316f5437dd72b21e415636fd5ce0d7ec70f6558e8ce-truepic_vision_logo_black_fav.png"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"overlay":{"fill":"auto","type":"blueprint","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"documentation","left":[],"logo_link":"landing_page","right":[{"type":"link_url","title":"Status ↗︎","url":"https://status.truepic.com","custom_page":null},{"type":"link_url","title":"Log In ↗︎","url":"https://vision.truepic.com","custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Docs","visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"git":{"connection":{"repository":{},"status":"inactive"}}}},"version":{"_id":"678159571b3f5c002432f8d1","version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["678159561b3f5c002432f874","678159561b3f5c002432f874","678159561b3f5c002432f875","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","678159561b3f5c002432f876","649353fa568fd2001df219ad","64935b2dcfe53800710196aa","64a5e3e1557b73006c076ae9","64a5e3e65cd783006a1dbc84","64a5e3f2eddb8700677703cb","64a5f16f78ed85002a18f6d3","64b15ce67bad3a00183d7c10","64b18076b598b4000b91d985","678159561b3f5c002432f877","678159561b3f5c002432f878","66abe6d806811b000f3c440e","678159561b3f5c002432f879","678159561b3f5c002432f87a","67818e7e1432db007477bfad","67818e85e0f2e50024ce7356"],"pdfStatus":"","project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2025-01-10T17:31:01.362Z","__v":1,"updatedAt":"2025-03-14T13:44:09.408Z","forked_from":"6464e41beec964003faf6b0c","apiRegistries":[{"name":"vision-api-v3.json","url":"1945vmrm7opk8x4"}]}},"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/reference/post_inspections","version":{"_id":"678159571b3f5c002432f8d1","version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["678159561b3f5c002432f874","678159561b3f5c002432f874","678159561b3f5c002432f875","6464e41beec964003faf6b19","646509af895dab167b90b6cb","646527cc7546180161b620d5","6467e90bcafa9e0073837f0f","6467ef24b9cbed0034f4d171","6467ef4dcf0035007b41f54f","646baa5401b224007adb85c9","646bb3e3a7d719000b714e45","678159561b3f5c002432f876","649353fa568fd2001df219ad","64935b2dcfe53800710196aa","64a5e3e1557b73006c076ae9","64a5e3e65cd783006a1dbc84","64a5e3f2eddb8700677703cb","64a5f16f78ed85002a18f6d3","64b15ce67bad3a00183d7c10","64b18076b598b4000b91d985","678159561b3f5c002432f877","678159561b3f5c002432f878","66abe6d806811b000f3c440e","678159561b3f5c002432f879","678159561b3f5c002432f87a","67818e7e1432db007477bfad","67818e85e0f2e50024ce7356"],"pdfStatus":"","project":"6464e41aeec964003faf6b06","releaseDate":"2023-05-17T14:26:35.306Z","createdAt":"2025-01-10T17:31:01.362Z","__v":1,"updatedAt":"2025-03-14T13:44:09.408Z","forked_from":"6464e41beec964003faf6b0c","apiRegistries":[{"name":"vision-api-v3.json","url":"1945vmrm7opk8x4"}]},"versions":{"total":4,"page":1,"per_page":100,"paging":{"next":null,"previous":null,"first":"/truepic-vision/api-next/v2/versions?per_page=100&page=1","last":null},"data":[{"base":"1.1-v3-old","display_name":"v1","git":{"latest_commit":{"created_at":"2025-02-13T15:16:15.000Z","hash":"6281c69d4813825ebca12e9c32026aa4e43f512b"},"branch_ref":"refs/heads/v0"},"name":"0","privacy":{"view":"hidden"},"release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-03-14T14:02:43.795Z","uri":"/versions/0"},{"base":null,"display_name":"v1.1","git":{"latest_commit":{"created_at":"2025-02-13T19:55:31.000Z","hash":"3017f22e998ece4f90412862613f11dc84e183f1"},"branch_ref":"refs/heads/v1.1-v3-old"},"name":"1.1-v3-old","privacy":{"view":"hidden"},"release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-03-14T14:05:43.969Z","uri":"/versions/1.1-v3-old"},{"base":"1.1-v3-old","display_name":null,"git":{"latest_commit":{"created_at":"2025-02-13T15:15:44.000Z","hash":"c2f5bbea010debe6a64aaca6d39fe879090095a6"},"branch_ref":"refs/heads/v2"},"name":"2","privacy":{"view":"public"},"release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-03-14T13:44:14.711Z","uri":"/versions/2"},{"base":"1.1-v3-old","display_name":null,"git":{"latest_commit":{"created_at":"2025-04-10T18:01:48.000Z","hash":"11562f23b9c8f6c55d7625dd821678f2cc0bd13e"},"branch_ref":"refs/heads/v3"},"name":"3","privacy":{"view":"default"},"release_stage":"release","source":"readme","state":"current","updated_at":"2025-03-14T13:44:09.408Z","uri":"/versions/3"}]}}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,1126,6563,9772,4904,7449,7372,187,734,954,1167,2395,9321,3073,1008,7188,5753,2852,2249,3901,7783,1456,4935,4287,4201,1936,5798,5948,8230,1313,1202,1343,6060,3906,3787,1666,3221,7327,7717,5359,3307,7356,9575,2144,9141,2447,3859,5408,2637,2402,2578,1080,9852,8684,1731,678,4467,7031,2616,3412,3556,8063,4793,8899,3626]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","routes-Reference","core-icons-alert-circle-svg","core-icons-more-vertical-svg","core-icons-lock-svg","routes-Landing","routes-PageNotFound","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","RMDX","core-icons-arrow-right-svg","routes-Changelog","Post","CustomPage","core-icons-chevron-down-svg","routes-Discuss","Page","core-icons-eye-off-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","List","core-icons-webhook-svg","routes-Tutorials","core-icons-message-circle-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-key-svg","core-icons-arrow-up-right-svg","core-icons-star-svg","New","core-icons-book-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.9aa7b166787ce8dbf7dc.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.b046de036f947dd91787.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3073.317cd602cc699f456e75.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.eb492ea5d8641ee3dc4f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.250d10a2b892bd7a6237.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.6617aa9d6a5d87fd6a4b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.56a94f46d7930b3ee929.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.2fdd0d1ed25537838fd5.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.c6b4a4514e2581e40b1d.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.417c0a41cba2a37aa480.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.1e1760fbed3f42ccb29a.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.7f3b970f2b860b8bf73e.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/8230.96b8d6f5010e5cdcba70.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d60db46666e2ba9dde2d.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.90004d413377087b5509.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.53ca1ea5a2b02b3a5244.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.4f86b948be2b6bace77b.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.146900a26b0ca17faad7.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.b558f2c382bb8c222ba8.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"></script> <script async data-chunk="core-icons-book-svg" src="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"></script></div><script async="async" src="https://www.googletagmanager.com/gtag/js?id=G-T0RCJ81RS4"></script><script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-T0RCJ81RS4');</script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"ZmU5NDQyMTZjMTFiNDU0Y2Y5NzNhMDEzZDdlMzI2MjZiODJjZjM4YWQzMjdlNmIzMmJjODg1YzE0NWUyNTgyMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjQ2NGU0MWFlZWM5NjQwMDNmYWY2YjA2KSwodmVyc2lvbjpub25lLHZlcnNpb246Njc4MTU5NTcxYjNmNWMwMDI0MzJmOGQxKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:6464e41aeec964003faf6b06),(version:none,version:678159571b3f5c002432f8d1),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":false,"logs":false,"custompages":true,"tutorials":false},"id":"6464e41aeec964003faf6b06","name":"Vision","subdomain":"truepic-vision","subpath":"","nav_names":{"docs":"Docs","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json"></script></body></html>

CINXE.COM

Create an inspection