---
title: "Read results, sources, read dates and progress using the request email or a session signed in with that email."
method: GET
path: "/v1/vendor-checks/{id}"
tags: ["Vendor checks"]
---

# Read results, sources, read dates and progress using the request email or a session signed in with that email.

`GET /v1/vendor-checks/{id}`

## Request

- Base URL: `https://www.licium.ai`
- URL: `https://www.licium.ai/v1/vendor-checks/{id}`
- Auth: none required

## Path parameters

- `id` string, uuid, required

## Query parameters

- `email` string, email

## Headers

- `X-Vendor-Check-Email` string, email

## Response `200`

Results appear as records are checked, with source links and read times.

- object
  - `success` unknown
  - `data` object
    - `status` 'received' | 'checking' | 'sent' | 'closed'
    - `completed_count` integer
    - `completed` boolean: The first full table is available, including any unavailable records.
    - `retrying` boolean: Unavailable records are scheduled to be checked again.
    - `email_status` 'pending' | 'sent' | 'skipped' | 'failed'
    - `estimated_seconds` integer
    - `watch` object, nullable: Record watch for this list, a paid option offered with the results. Only a list on Record watch is read again and emailed about; null when it could not be read just now.
      - `state` 'not_watched' | 'payment_pending' | 'watched' | 'ending' | 'past_due' | 'ended' | 'closed', required: not_watched: never paid. payment_pending: paid with a method that is still settling; the watch starts when it does. watched: paid, renews. ending: canceled, watched until the paid month ends. past_due: the last payment failed, so the list is not read or emailed about. ended: the subscription ended. closed: the list was closed and is not watched.
      - `until` string, date-time, nullable, required: watched: paid through. ending: the watch stops then. Otherwise null.
      - `started_at` string, date-time, nullable, required
      - `offer_url` string, uri, nullable, required: Payment page that starts Record watch for this list (not_watched, ended).
      - `manage_url` string, uri, nullable, required: Customer billing page: card, invoices, cancel (payment_pending, watched, ending, past_due).
    - `referral` object, nullable: The request email's own referral link, returned only to a signed-in session with that email. Its owner earns credit when someone who came through it makes a first payment. Null otherwise.
      - `code` string, required
      - `link` string, uri, required: The requester's own referral link.
      - `message` string, required: One line to share the link.
    - `referral_sign_in` boolean: True when the referral program is on and this reader is not a signed-in session with the request's email: sign in with it to get the referral link.
    - `rows` object[]
      - `vendor` object
      - `license` object, nullable
        - `code` 'license_record' | 'unreadable', required
        - `display` string, required: DBPR status words with expiry, or Couldn't read this right now. We'll check again.
        - `evidence` object[], required
          - `source` 'dbpr' | 'coverage' | 'historical' | 'exemption' | 'stop_work', required
          - `url` string, uri, required
          - `read_at` string, date-time, required
          - `last_updated` string, nullable, required
        - `records` object[], required
      - `workers_comp` object, nullable
        - `code` 'covered' | 'leased' | 'exemption_only' | 'no_policy_no_exemption' | 'canceled' | 'removed_from_leasing' | 'unreadable', required
        - `display` string, required: Covered; Covered through a leasing company, ends {date}; Officer exemption only, no policy; No policy, no exemption; Canceled {date}; Removed from leasing policy {date}; Couldn't read this right now. We'll check again.
        - `evidence` object[], required
          - `source` 'dbpr' | 'coverage' | 'historical' | 'exemption' | 'stop_work', required
          - `url` string, uri, required
          - `read_at` string, date-time, required
          - `last_updated` string, nullable, required
        - `records` object[], required
      - `stop_work` object, nullable
        - `code` 'open' | 'released' | 'none' | 'unreadable', required
        - `display` string, required: Open; Released {date}; None on record; Couldn't read this right now. We'll check again.
        - `evidence` object[], required
          - `source` 'dbpr' | 'coverage' | 'historical' | 'exemption' | 'stop_work', required
          - `url` string, uri, required
          - `read_at` string, date-time, required
          - `last_updated` string, nullable, required
        - `records` object[], required
      - `complete` boolean
      - `next_attempt_at` string, date-time
    - `vendor_count` integer

## Other responses

- `401`: Supply the request email or sign in with that email.
- `404`: Request not found. Check the request ID and email.
- `429`: Too many requests. Try again in one hour.
- `503`: Could not read the request. Try again in a minute.

---

[API](https://skmtc.dev/licium/apis/licium-public-api.md) · [All operations](https://skmtc.dev/licium/apis/licium-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/licium/apis/licium-public-api/revisions/d91a72f755f4?raw)