Properties
| Name | Type | Description |
|---|---|---|
| account_id | string | |
| created_at | string | |
| company | stringnull | |
| plan | object | |
| monitoring | boolean | |
| access | array | |
| standing | object | awaiting_payment: nothing is checked yet. active: checks run. paused: a subscription payment is not current. ended: the subscription ended. payment_problem: the payment failed or needs a person. |
| payment | object | |
| price | object | |
| summary | object | How many applications have each status. |
| applications | array | |
| roster | array | |
| monitoring_state | object | Weekly roster monitoring (group plan, or added on the per-application plan). |
| calendar | object | Deadlines within 30 days (and past ones) and in 31 to 90 days. |
| roster_changes | array | |
| documents | objectnull | Application bundle: how many documents we need, still missing, received, accepted and asked for again, and path (the documents page). The list: GET /v1/payer-follow-ups/{id}/documents. |
| firm | objectnull | The credentialing firm this follow-up is run for, or null. |
| sample | boolean | A sample made for a demonstration: every name, number and status in it is made up, and nothing is checked. |
| notify | object | Optional. Who gets this follow-up's emails: practice (default) sends them to email; platform_only sends every email (payment confirmation, missing documents, document requests and reminders, roster ch |
| notify_email | stringnull | platform_only: where every email goes. |
| webhook | objectnull | The status webhook: its address and when it was last set, or null when none is set. Never the signing secret. |
| clinician_tasks | array | Application bundle: the steps only a clinician can do for the applications we write (for example attesting the CAQH profile, or signing in a payer's own system). We text and email the clinician a link |
| next | string | What happens next, in one sentence. |
| authorized_by | object | What opened this read: token (the access token sent) or session (signed in with the follow-up's email). firm: the access token of the credentialing firm it is run for, read only. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/licium-ai/json-schema/licium-ai-payer-follow-up-status-schema.json",
"title": "PayerFollowUpStatus",
"x-generated": "2026-11-15",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/licium-ai-openapi.json#/components/schemas/PayerFollowUpStatus",
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"company": {
"type": [
"string",
"null"
]
},
"plan": {
"enum": [
"group",
"per_application",
"application_bundle"
]
},
"monitoring": {
"type": "boolean"
},
"access": {
"type": "array",
"items": {
"enum": [
"portal_user",
"pecos_surrogate",
"delegation_letter",
"caqh_admin",
"call_only"
]
}
},
"standing": {
"enum": [
"awaiting_payment",
"active",
"paused",
"ended",
"payment_problem"
],
"description": "awaiting_payment: nothing is checked yet. active: checks run. paused: a subscription payment is not current. ended: the subscription ended. payment_problem: the payment failed or needs a person."
},
"payment": {
"type": "object",
"properties": {
"status": {
"enum": [
"awaiting_payment",
"paid",
"failed",
"mismatch"
]
},
"paid_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"first_amount_cents": {
"type": "integer"
},
"monthly_amount_cents": {
"type": "integer"
},
"subscription_status": {
"type": [
"string",
"null"
]
},
"current_period_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"cancel_at_period_end": {
"type": "boolean"
},
"manage_url": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Billing page: card, invoices, cancel from the next period (subscriptions only)."
},
"billing_status": {
"enum": [
"ok",
"short"
],
"description": "short: the subscription now bills less than the plan; checks are paused until it is fixed."
}
}
},
"price": {
"$ref": "#/$defs/PayerFollowUpPrice"
},
"summary": {
"type": "object",
"description": "How many applications have each status.",
"properties": {
"not_checked": {
"type": "integer"
},
"received": {
"type": "integer"
},
"in_review": {
"type": "integer"
},
"needs_documents": {
"type": "integer"
},
"approved": {
"type": "integer"
},
"denied": {
"type": "integer"
},
"no_record": {
"type": "integer"
},
"no_decision": {
"type": "integer"
}
}
},
"applications": {
"type": "array",
"items": {
"$ref": "#/$defs/PayerFollowUpApplication"
}
},
"roster": {
"type": "array",
"items": {
"type": "object",
"properties": {
"npi": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"caqh_attested_on": {
"type": [
"string",
"null"
],
"format": "date"
},
"pending_line": {
"type": "boolean"
},
"pending_left_reason": {
"enum": [
"decided",
"six_months",
null
]
}
}
}
},
"monitoring_state": {
"type": "object",
"description": "Weekly roster monitoring (group plan, or added on the per-application plan).",
"properties": {
"active": {
"type": "boolean"
},
"last_run_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"next_run_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"calendar": {
"type": "object",
"description": "Deadlines within 30 days (and past ones) and in 31 to 90 days.",
"properties": {
"within_30_days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"medicare_revalidation",
"group_revalidation",
"license_expiry",
"caqh_reattestation"
]
},
"npi": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"date": {
"type": "string",
"format": "date"
},
"days_left": {
"type": "integer",
"description": "Negative when past."
},
"label": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
}
}
}
},
"within_90_days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"medicare_revalidation",
"group_revalidation",
"license_expiry",
"caqh_reattestation"
]
},
"npi": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"date": {
"type": "string",
"format": "date"
},
"days_left": {
"type": "integer",
"description": "Negative when past."
},
"label": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"roster_changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detected_at": {
"type": "string"
},
"npi": {
"type": "string"
},
"provider_name": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"before": {
"type": [
"string",
"null"
]
},
"after": {
"type": [
"string",
"null"
]
},
"source_url": {
"type": [
"string",
"null"
]
},
"read_at": {
"type": [
"string",
"null"
]
}
}
}
},
"documents": {
"type": [
"object",
"null"
],
"description": "Application bundle: how many documents we need, still missing, received, accepted and asked for again, and path (the documents page). The list: GET /v1/payer-follow-ups/{id}/documents.",
"properties": {
"required": {
"type": "integer"
},
"missing": {
"type": "integer"
},
"received": {
"type": "integer"
},
"accepted": {
"type": "integer"
},
"needs_resend": {
"type": "integer"
},
"path": {
"type": "string"
}
}
},
"firm": {
"type": [
"object",
"null"
],
"description": "The credentialing firm this follow-up is run for, or null.",
"properties": {
"name": {
"type": "string"
},
"reply_to_email": {
"type": "string"
},
"callback_number": {
"type": [
"string",
"null"
]
}
}
},
"sample": {
"type": "boolean",
"description": "A sample made for a demonstration: every name, number and status in it is made up, and nothing is checked."
},
"notify": {
"enum": [
"practice",
"platform_only",
"webhook_only"
],
"description": "Optional. Who gets this follow-up's emails: practice (default) sends them to email; platform_only sends every email (payment confirmation, missing documents, document requests and reminders, roster changes, the Monday status email, stopped applications) only to notify_email, your platform's address, marked with the practice it is about, and never to email; webhook_only sends no email at all (webhook_url is required) and status reaches you by the webhook and GET /v1/payer-follow-ups/{id}."
},
"notify_email": {
"type": [
"string",
"null"
],
"description": "platform_only: where every email goes."
},
"webhook": {
"type": [
"object",
"null"
],
"required": [
"url",
"updated_at"
],
"description": "The status webhook: its address and when it was last set, or null when none is set. Never the signing secret.",
"properties": {
"url": {
"type": "string"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"clinician_tasks": {
"type": "array",
"description": "Application bundle: the steps only a clinician can do for the applications we write (for example attesting the CAQH profile, or signing in a payer's own system). We text and email the clinician a link with each step, what to tap and its deadline, remind them, and mark a step done only once we have confirmed it. Empty otherwise.",
"items": {
"type": "object",
"required": [
"id",
"npi",
"clinician",
"kind",
"title",
"status",
"words",
"due_at",
"applications",
"contact_needed"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"npi": {
"type": "string"
},
"clinician": {
"type": [
"string",
"null"
]
},
"kind": {
"enum": [
"caqh_id",
"caqh_attest",
"ia_surrogacy",
"pecos_sign",
"tmhp_sign",
"pave_sign",
"nygov_account",
"emedny_submit",
"promise_sign",
"flmmis_fingerprints",
"payer_contract"
]
},
"title": {
"type": "string",
"description": "The step in the clinician's words."
},
"status": {
"enum": [
"upcoming",
"to_do",
"said_done",
"done"
],
"description": "upcoming: we ask the clinician when it is time; to_do: asked and being reminded; said_done: the clinician says it is done and we are confirming it; done: confirmed."
},
"words": {
"type": "string",
"description": "Where it stands, in plain words."
},
"due_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"asked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_reminded_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"reminders": {
"type": "integer"
},
"said_done_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"done_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"payer": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
},
"contact_needed": {
"type": "boolean",
"description": "true: we cannot reach this clinician; add their mobile number or email with POST /v1/payer-follow-ups/{id}/signers."
},
"email_needed": {
"type": "boolean",
"description": "true with contact_needed when their mobile number is already on file: the steps go by email, so add their email with POST /v1/payer-follow-ups/{id}/signers."
}
}
}
},
"next": {
"type": "string",
"description": "What happens next, in one sentence."
},
"authorized_by": {
"enum": [
"token",
"session",
"ops",
"firm",
"firm_session"
],
"description": "What opened this read: token (the access token sent) or session (signed in with the follow-up's email). firm: the access token of the credentialing firm it is run for, read only."
}
},
"$defs": {
"PayerFollowUpApplication": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The application. Webhook events name it as data.application_id."
},
"npi": {
"type": "string"
},
"clinician_name": {
"type": [
"string",
"null"
],
"description": "As the national NPI registry has it, once read."
},
"payer": {
"type": "string"
},
"state": {
"type": "string"
},
"submitted_on": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Null on an application bundle item until it is submitted."
},
"work": {
"enum": [
"follow_up",
"write_and_submit"
],
"description": "write_and_submit: an application bundle item we write and submit."
},
"documents_from": {
"enum": [
"caqh",
"send",
null
]
},
"payer_reference": {
"type": [
"string",
"null"
],
"description": "As you sent it."
},
"notes": {
"type": [
"string",
"null"
],
"description": "As you sent them."
},
"status": {
"enum": [
"not_checked",
"received",
"in_review",
"needs_documents",
"approved",
"denied",
"no_record",
"no_decision"
],
"description": "See the status list in the guide: approved and denied are final; no_decision is final unless reopened."
},
"effective_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Approved: the effective date the payer gave."
},
"reference_or_rep": {
"type": [
"string",
"null"
],
"description": "The payer's reference number or the representative's name, from the latest check."
},
"missing_documents": {
"type": [
"string",
"null"
],
"description": "needs_documents: what the payer is missing."
},
"last_checked_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The latest check, or the latest status page read that found the same answer."
},
"next_check_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When it is checked next (null once decided, stopped, or not covered): every 30 minutes, day and night for a payer that posts its status online, otherwise every check_every_days days."
},
"check_every_days": {
"type": "integer",
"minimum": 1,
"maximum": 7,
"description": "Days between the checks that are not status page reads, as set at intake (7: weekly)."
},
"closed_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When it was decided or stopped."
},
"coverage": {
"enum": [
"not_started",
"covered",
"paused",
"ended",
"decided",
"stopped"
],
"description": "covered: checked until decided; decided; stopped: closed with no decision (see stopped); paused: payment not current; ended: group plan, six months on the pending line; not_started: awaiting payment."
},
"stopped": {
"type": [
"object",
"null"
],
"description": "Status no_decision: why the checks stopped, when, and until when it can be reopened at no charge (reopen_path, null once the 30 days have passed).",
"properties": {
"reason": {
"enum": [
"no_record",
"twelve_months"
]
},
"at": {
"type": "string",
"format": "date-time"
},
"reopen_until": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"reopen_path": {
"type": [
"string",
"null"
],
"description": "POST it with the access token to reopen."
}
}
},
"checks": {
"type": "array",
"description": "Every answer, newest first.",
"items": {
"$ref": "#/$defs/PayerFollowUpCheck"
}
},
"waiting_on_you": {
"type": "array",
"items": {
"type": "string"
},
"description": "An application we write and submit, paid and not submitted yet: what we still need from you or the clinician. Empty otherwise."
},
"submission": {
"type": [
"object",
"null"
],
"description": "An application we write and submit: where its writing, signing and sending stand. Null before we start it, and on an application you submitted yourself.",
"required": [
"step",
"words",
"channel",
"sent_at",
"delivered_at",
"signer",
"clinician_to_do",
"events"
],
"properties": {
"step": {
"enum": [
"preparing",
"needs_signer",
"waiting_signature",
"signed",
"sending",
"sent",
"delivered",
"needs_attention"
],
"description": "preparing, needs_signer (we need the signer's email or mobile: POST /v1/payer-follow-ups/{id}/signers), waiting_signature, signed, sending, sent, delivered, or needs_attention (we are fixing something before it goes out)."
},
"words": {
"type": "string",
"description": "The step in plain words."
},
"channel": {
"enum": [
"email",
"fax",
"mail",
"web",
null
],
"description": "How it goes to the payer: email, fax, mail, or web (submitted on the payer's own website or enrollment portal)."
},
"clinician_to_do": {
"type": [
"object",
"null"
],
"description": "When the payer's own system needs the clinician (signing the program's own email, or submitting from their own account): where, and the steps in order. Null otherwise.",
"properties": {
"where": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"sent_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"delivered_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"signer": {
"type": [
"object",
"null"
],
"description": "Who signs it and where the signing stands; GET /v1/payer-follow-ups/{id}/signers has the contacts.",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"waiting_contact",
"sent",
"opened",
"verified",
"signed",
"declined",
"expired",
"voided",
null
]
},
"contact_needed": {
"type": "boolean",
"description": "true: say who signs with POST /v1/payer-follow-ups/{id}/signers."
}
}
},
"events": {
"type": "array",
"description": "What happened, oldest first.",
"items": {
"type": "object",
"required": [
"at",
"words"
],
"properties": {
"at": {
"type": "string",
"format": "date-time"
},
"words": {
"type": "string"
}
}
}
}
}
},
"now_doing": {
"anyOf": [
{
"$ref": "#/$defs/PayerFollowUpNowDoing"
},
{
"type": "null"
}
],
"description": "What is happening on it right now, or the last thing done, with that record's time. Null when no record says anything yet."
},
"receipts": {
"type": "array",
"description": "Each message that went to the payer about it (status email, automated call, the written application), newest first, with sent, arrived and answered.",
"items": {
"$ref": "#/$defs/PayerFollowUpMessageReceipt"
}
},
"overlaps": {
"type": "array",
"description": "Another open application for the same clinician, payer and state: one that may have been started twice. Empty otherwise.",
"items": {
"$ref": "#/$defs/PayerFollowUpOverlap"
}
}
}
},
"PayerFollowUpCheck": {
"type": "object",
"description": "One answer from the payer. A status page read that finds what the latest check already says adds to reads and last_read_at instead of a new entry.",
"properties": {
"checked_at": {
"type": "string",
"format": "date-time"
},
"reads": {
"type": "integer",
"minimum": 1,
"description": "How many reads found this same answer."
},
"last_read_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"method": {
"enum": [
"portal",
"phone",
"email"
],
"description": "portal: the payer's status page or portal."
},
"checked_by": {
"type": "string"
},
"status": {
"enum": [
"received",
"in_review",
"needs_documents",
"approved",
"denied",
"no_record"
]
},
"payer_said": {
"type": "string",
"description": "What the payer said, in its words."
},
"reference_or_rep": {
"type": [
"string",
"null"
],
"description": "The payer's reference number or the representative's name."
},
"missing_documents": {
"type": [
"string",
"null"
]
},
"effective_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"source_note": {
"type": [
"string",
"null"
],
"description": "Where the answer came from (for a status page: its name, address and read time)."
}
}
},
"PayerFollowUpMessageReceipt": {
"type": "object",
"required": [
"channel",
"what",
"to",
"steps"
],
"description": "One message that went to the payer about the application, with its three steps.",
"properties": {
"channel": {
"enum": [
"email",
"phone",
"fax",
"mail",
"web"
]
},
"what": {
"type": "string",
"description": "Status question, Automated status call, Status call, or Written application."
},
"to": {
"type": "string",
"description": "The payer's inbox address, its line's name, or the payer."
},
"steps": {
"type": "array",
"minItems": 3,
"maxItems": 3,
"description": "sent, arrived and answered, in that order.",
"items": {
"type": "object",
"required": [
"step",
"label",
"state",
"at",
"words"
],
"properties": {
"step": {
"enum": [
"sent",
"arrived",
"answered"
]
},
"label": {
"type": "string",
"description": "The step's name for the channel: Sent, Called, Reached a person, Fax line confirmed, Delivered, Answered, Payer has it."
},
"state": {
"enum": [
"done",
"waiting",
"failed",
"not_tracked"
],
"description": "not_tracked: the channel gives no receipt for this step (an email's arrival is known only once the payer replies)."
},
"at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"words": {
"type": "string",
"description": "What the record says about the step, such as \"no one came on the line\" or \"Gave the status: in review\"."
}
}
}
}
}
},
"PayerFollowUpNowDoing": {
"type": "object",
"required": [
"kind",
"words",
"at",
"live",
"from"
],
"description": "What is happening on the application right now, or the last thing done, read from the records the checks leave (a call on the line, a status email and its replies, a status page or portal read, the written application's send). Never typed by a person.",
"properties": {
"kind": {
"enum": [
"dialing",
"phone_menu",
"on_hold",
"on_call",
"talking",
"callback_wait",
"call_recording",
"call_retry",
"email_approval",
"email_sending",
"email_waiting",
"email_acknowledged",
"reply_reading",
"email_other_way",
"page_reading",
"page_read",
"portal_read",
"email_answered",
"call_answered",
"person_checked",
"person_confirming",
"queued",
"submission",
"waiting_practice",
"scheduled",
"decided",
"stopped",
"not_started",
"paused",
"ended",
"faxing",
"fax_waiting",
"fax_failed",
"fax_reading"
],
"description": "For example on_hold, phone_menu, talking (a representative came on), callback_wait, email_waiting, email_acknowledged, reply_reading, page_read, portal_read, call_answered, person_confirming, queued (a check that is due, or one a person makes), submission, waiting_practice, scheduled, decided, stopped, not_started."
},
"words": {
"type": "string",
"description": "One sentence without a time, such as \"On hold with Aetna provider services\" or \"Read Medicare's status page\"."
},
"at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When it started or happened: the call's start, the email's sending, the page's read. A future time is a planned check. Null when no record carries a time."
},
"live": {
"type": "boolean",
"description": "true while it is happening (a call on the line, a reply or a page being read, a person confirming an answer)."
},
"from": {
"enum": [
"call",
"status_email",
"email_reply",
"status_page",
"portal",
"check",
"check_task",
"submission",
"follow_up",
"fax"
],
"description": "The record the line is read from."
}
}
},
"PayerFollowUpOverlap": {
"type": "object",
"required": [
"application_i
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/licium-ai/json-schema/licium-ai-payer-follow-up-status-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/licium-ai-payer-follow-up-status"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.