---
title: "Read a weekly payer follow-up with the account ID and the access token returned when it was started: whether payment is settled, each application's status (not_checked, received, in_review, needs_documents, approved with its effective date, denied, no_record), whether we write and submit it (work: write_and_submit, with submitted_on empty until it is submitted) or it was already submitted (work: follow_up), what we still need from you before we submit one we write (waiting_on_you), the payer's reference or representative, missing documents, the last and next check, and the log of every check (date, method, who checked, what the payer said); the roster's changes from weekly monitoring; and the deadlines within 30 and 90 days."
method: GET
path: "/v1/payer-follow-ups/{id}"
tags: ["Payer follow-ups", "Payments"]
---

# Read a weekly payer follow-up with the account ID and the access token returned when it was started: whether payment is settled, each application's status (not_checked, received, in_review, needs_documents, approved with its effective date, denied, no_record), whether we write and submit it (work: write_and_submit, with submitted_on empty until it is submitted) or it was already submitted (work: follow_up), what we still need from you before we submit one we write (waiting_on_you), the payer's reference or representative, missing documents, the last and next check, and the log of every check (date, method, who checked, what the payer said); the roster's changes from weekly monitoring; and the deadlines within 30 and 90 days.

`GET /v1/payer-follow-ups/{id}`

## Request

- Base URL: `https://www.licium.ai`
- URL: `https://www.licium.ai/v1/payer-follow-ups/{id}`
- Auth: none required

Send the access token (header X-Payer-Follow-Up-Token, Authorization: Bearer, or ?token= as in emailed links) or use a session signed in with the follow-up's email; an email address alone is not accepted. standing: awaiting_payment (nothing is checked), active, paused (subscription payment not current, or Stripe bills less than the plan; payment.billing_status short), ended, payment_problem. Each application's coverage: not_started, covered (checked weekly), paid_checks, renewal_needed (per-application plan past 120 days; renewal has the price and path), paused, ended (group plan, six months on the pending line), decided. calendar lists deadlines within 30 days (and past ones) and in 31 to 90 days: Medicare revalidation, group revalidation, license expiry, CAQH re-attestation.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `token` string

## Headers

- `X-Payer-Follow-Up-Token` string

## Response `200`

The follow-up.

- object
  - `success` unknown
  - `data` object
    - `account_id` string, uuid
    - `plan` 'group' | 'per_application' | 'application_bundle'
    - `monitoring` boolean
    - `standing` 'awaiting_payment' | 'active' | 'paused' | 'ended' | 'payment_problem'
    - `payment` object
      - `status` 'awaiting_payment' | 'paid' | 'failed' | 'mismatch'
      - `paid_at` string, nullable
      - `first_amount_cents` integer
      - `monthly_amount_cents` integer
      - `subscription_status` string, nullable
      - `current_period_end` string, nullable
      - `cancel_at_period_end` boolean
      - `manage_url` string, uri, nullable: Customer billing page: card, invoices, cancel from the next period.
      - `billing_status` 'ok' | 'short': short: Stripe now bills less than the plan; checks are paused until it is fixed.
    - `summary` object: Applications per status.
    - `applications` object[]
      - `id` string, uuid
      - `npi` string
      - `clinician_name` string, nullable
      - `payer` string
      - `state` string
      - `submitted_on` string, date, nullable: Null on an application bundle item until it is submitted.
      - `work` 'follow_up' | 'write_and_submit': write_and_submit: an application bundle item we write and submit.
      - `documents_from` unknown
      - `status` 'not_checked' | 'received' | 'in_review' | 'needs_documents' | 'approved' | 'denied' | 'no_record'
      - `effective_date` string, date, nullable
      - `reference_or_rep` string, nullable
      - `missing_documents` string, nullable
      - `last_checked_at` string, nullable
      - `next_check_at` string, nullable
      - `coverage` 'not_started' | 'covered' | 'paid_checks' | 'renewal_needed' | 'paused' | 'ended' | 'decided'
      - `paid_checks_remaining` integer
      - `renewal` object, nullable
        - `unit_cents` integer
        - `path` string
      - `checks` object[]
        - `checked_at` string
        - `method` 'portal' | 'phone' | 'email'
        - `checked_by` string
        - `status` string
        - `payer_said` string
        - `reference_or_rep` string, nullable
        - `missing_documents` string, nullable
        - `effective_date` string, nullable
        - `source_note` string, nullable
      - `waiting_on_you` string[]: An application we write and submit, paid and not submitted yet: what we still need from you or the clinician before we submit it (a document, CAQH access, an explanation, a signature or attestation), in plain sentences. Empty otherwise.
    - `roster` object[]
      - `npi` string
      - `name` string, nullable
      - `caqh_attested_on` string, nullable
      - `pending_line` boolean
      - `pending_left_reason` unknown
    - `calendar` object
      - `within_30_days` object[]
      - `within_90_days` object[]
    - `roster_changes` object[]
      - `detected_at` string
      - `npi` string
      - `provider_name` string, nullable
      - `label` string
      - `before` string, nullable
      - `after` string, nullable
      - `source_url` string, nullable
      - `read_at` string, nullable
    - `documents` object, nullable: Application bundle, once paid: how many documents we need (required), still missing, received, accepted and asked for again, and path (the documents page). The list itself: GET /v1/payer-follow-ups/{id}/documents.
      - `required` integer
      - `missing` integer
      - `received` integer
      - `accepted` integer
      - `needs_resend` integer
      - `path` string
    - `firm` object, nullable: The credentialing firm this follow-up is run for, or null.
      - `name` string
      - `reply_to_email` string
      - `callback_number` string, nullable
    - `sample` boolean: A sample made for a demonstration: every name, number and status in it is made up, and nothing is checked.
    - `next` string
    - `authorized_by` 'token' | 'session' | 'ops' | 'firm' | 'firm_session': What opened this read: the access token sent, or a session signed in with the follow-up's email (ops: an operator, read only; firm: the access token of the credentialing firm it is run for, read only; firm_session: a session signed in with that firm's email, read only).

## Other responses

- `401`: Send the access token, or sign in with the follow-up's email.
- `404`: Follow-up not found, or the token does not open it.
- `429`: Too many requests. Try again in one hour.
- `503`: Could not read the follow-up. 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)