--- title: "Get EndUser background check dashboard payload" method: GET path: "/api/end_users/{end_user_heron_id}/background_check" tags: ["EndUsers"] --- # Get EndUser background check dashboard payload `GET /api/end_users/{end_user_heron_id}/background_check` Get the background check results for an end user, including the screening run status, each subject's identity matches and records, and the outcome of each policy check. ## Path parameters - `end_user_heron_id` string, required ## Query parameters - `include_section_detail` boolean ## Response `200` OK - BackgroundCheckResponseSchema — Dates use YYYY-MM-DD. Amounts are decimal strings. Nullable source fields return null. SSNs remain masked; full SSNs never appear. - `end_user_id` string, required — Heron ID of the end user - `overall` BackgroundCheckOverall - `check_counts` BackgroundCheckCheckCounts, required - `fail` integer, required — Number of failed policy checks. - `pass` integer, required — Number of passed policy checks. - `review` integer, required — Number of policy checks requiring review. - `result` 'passed' | 'failed' | 'review_required' | 'missing_data', required — Headline result: passed, review_required, failed, or missing_data. - `severity` 'none' | 'low' | 'medium' | 'high', required — Highest severity found: none, low, medium, or high. - `policy` BackgroundCheckPolicy - `checks` BackgroundCheckCheck[], required — One entry per configured policy check. - `area` string, required — Display group for the policy check. - `area_sub` string, nullable — Display subgroup for the policy check; null when the check has none. - `auto_reason` string, nullable — Explanation for the automated policy outcome; null when unavailable. - `auto_status` 'pass' | 'failed' | 'review_required' | 'missing_data', required — Automated outcome: pass, review_required, failed, or missing_data. - `check_text` string, required — Human-readable description of what the policy check evaluates. - `evidence_subjects` BackgroundCheckEvidence[], required — Per-subject pointers to the findings that produced the policy outcome. - `filtered` boolean, required — True when record_indices is a matched subset. An empty filtered list means no records matched. - `record_indices` integer[], required — Indices into the cited section's records array. - `section` string, nullable — Section key containing the cited evidence; null when no section applies. - `subject_key` 'owner_1' | 'owner_2' | 'business' | 'any_owner' | 'submission' | 'null', nullable — Evidence subject: owner_1, owner_2, business, any_owner, or submission. - `id` string, required — Stable check ID in : form. - `override` BackgroundCheckOverride - `at` string, date-time, required — When the reviewer applied the override. - `by` string, required — Reviewer who applied the override. - `status` 'pass' | 'failed' | 'review_required' | 'missing_data', required — Reviewer-selected outcome replacing the automated result. - `rule` string, nullable — Configured threshold or rule expression; null when the check has none. - `signal` string, required — Underlying attribute evaluated by the policy check. - `result` 'passed' | 'failed' | 'review_required' | 'missing_data', required — Worst configured policy outcome: passed, review_required, failed, or missing_data. - `processing_stage` 'searching' | 'pulling_reports' | 'analysing' | 'null', nullable — While processing: searching, pulling_reports, or analysing. Null otherwise. - `status` 'never_run' | 'processing' | 'succeeded' | 'failed' | 'missing_input_data', required — Run lifecycle: never_run, processing, succeeded, failed, or missing_input_data. - `subjects` BackgroundCheckSubject[], required — One entry per searched subject: owner_1, owner_2 when present, and business. - `application` BackgroundCheckApplication, required — The application identity used for the search. All fields are nullable; SSNs remain masked. - `address` string, nullable — Application address used to search this subject; null when unavailable. - `business_name` string, nullable — Application business name; null for person subjects. - `date_of_birth` string, date, nullable — Date of birth; null when unavailable. - `ein` string, nullable — Employer Identification Number used for the search; null when unavailable. - `email` string, nullable — Email address; null when unavailable. - `name` string, nullable — Application person name; null for business subjects. - `owner` string, nullable — Named owner used when searching a business subject; null for person subjects. - `phone` string, nullable — Phone number; null when unavailable. - `ssn` string, nullable — Masked SSN. Only the first five digits are ever held or returned; the full SSN never appears. - `state` string, nullable — Application state; null when unavailable. - `candidates` BackgroundCheckCandidate[], required — Every deduplicated candidate returned across the subject's searches, with its match score. - `address` string, nullable — Candidate address returned by the search. - `aka_names` string[] — Also-known-as names on the candidate. - `basis` string, nullable — Search basis that returned the candidate, such as the matching name variant. - `duns_numbers` string[] — D&B DUNS numbers from the business candidate; empty for person candidates. - `entity_id` string, nullable — Source entity identifier; null when unavailable. - `group_id` string, nullable — Source record-group identifier; null when unavailable. - `id` string, required — Stable candidate reference: source entity ID, or group ID as fallback. - `is_limited` boolean, nullable — Whether the candidate is a limited-data record; null when unknown. - `matched_address` string, nullable — Non-primary address that matched the search; null when the primary address matched. - `matched_aka_name` string, nullable — Also-known-as name that matched the search; null when the primary name matched. - `name` string, nullable — Candidate name returned by the search. - `rank` integer, nullable — Candidate's position in the search results. - `relevance` integer, nullable — Source relevance score for the search hit. - `score` CandidateScore - `anchor_trace` CandidateAnchorTrace - `anchor` 'ein' | 'corp_number_echo', required — Identifier that resolved the match outright: ein or corp_number_echo. - `guard_field` 'business_name' | 'address' | 'owner' | 'null', nullable — Candidate field used to guard the anchor match; null when no guard was needed. - `guard_strength` number, nullable — Guard field's comparison strength; null when no guard was evaluated. - `permitted` boolean, required — False records an anchor-grade identifier the guard denied. - `anchored_by` string, nullable — The anchor identifier that resolved the match (e.g. ein); winner-only. - `cap_trace` CandidateCapTrace - `cap` number, required — The cap the total was clamped to, as a fraction. - `conflict` 'zero_floor', required — Conflicting field that caused the score cap. - `uncapped_total` number, required — The uncapped total, as a fraction. - `capped_by` string, nullable — Names the clamp when the total isn't the contribution sum (e.g. zero_floor); null otherwise. - `contributions` CandidateScoreContribution[], required — Per-field ledger of contributions to the candidate's match score. - `allocation` number, required — Fraction of the 100-point maximum. - `application_value` string, nullable — The compared application value when it differs from the hoisted application block; null otherwise. - `candidate_value` string, nullable — Candidate value compared for this contribution; null when absent. - `cause` 'missing_application_value' | 'missing_candidate_value' | 'null', nullable — Why an absent verdict has no evidence; null on scoreable rows. - `field` string, required — Application field evaluated by this contribution. - `identifier_source` 'sos_registry' | 'clear_filing' | 'null', nullable — For an identifier-echo corroboration (corp_number_echo), which system supplied the re-searched number; null on other rows. - `kind` 'field' | 'corroboration' | 'quality' | 'penalty', required — Contribution type: field (a direct comparison), corroboration, penalty, or quality. - `points` number, required — This row's contribution to the total, as a fraction. - `strength` number, nullable — Comparator strength in [-1, 1]; null when the field wasn't comparable (fall back to the verdict). - `trace` CandidateFieldTrace - `base` number, required — Comparator strength before named modifiers are applied. - `components` CandidateTraceComponent[], required — Per-part evidence used to derive the strength. - … - `mode` 'exact' | 'similarity' | 'stepped' | 'composite', required — How the strength was derived: exact, similarity, stepped, or composite. - `modifiers` CandidateTraceModifier[], required — Named adjustments applied to the base strength. - … - `verdict` 'agree' | 'fuzzy' | 'diverge' | 'absent', required — Comparison verdict: agree, fuzzy, diverge, or absent. - `tier` 'high' | 'medium' | 'low', required — Score tier: high, medium, or low. - `total` number, required — The match score as a fraction in [0, 1]. - `version` string, required — Match-scoring model version. - `case_ref` string, nullable — Reserved case reference; null in normal use. - `decision` BackgroundCheckDecision - `anchored_by` string, nullable — Anchor identifier that resolved the match outright: ein or corp_number_echo; null when unanchored. - `near_tie` BackgroundCheckNearTie - `flag_counts` object, nullable — Adverse-flag counts per probed candidate, keyed by candidate id; null when not probed. - `gap` number, required — Difference between the top two candidate scores. - `probed` boolean, required — True when both near-tied candidate reports were retrieved and compared. - `pooled_count` integer, nullable — Number of candidates pooled and scored. - `tie_break` 'score' | 'key_order' | 'flag_probe' | 'null', nullable — How the winner separated from the runner-up; null when there was no winner/runner-up. - `duns_numbers` string[] — D&B DUNS numbers of the resolved business. Empty for person subjects. - `key` 'owner_1' | 'owner_2' | 'business', required — Subject identifier: owner_1, owner_2, or business. - `kind` 'person' | 'business', required — Subject type: person or business. - `name` string, nullable — Resolved name on the matched record; null when unmatched. - `related_party_officers` string[] — Business-filing officers who match a related party on the deal. - `resolution` BackgroundCheckResolution, required - `aka_names` string[] — Also-known-as names on the resolved entity. - `entity_not_found` boolean, required — True when no matching entity was found. - `match_threshold` number, nullable — The deciding evidence-score floor; null on older records. - `method` string, nullable — Resolving search step: ssn_only, name_state_dob, name_address, name_state, corp_id, or manual_recovery (a reviewer manually selected the match). - `report_retry_attempted` boolean, required — True when a failed report retrieval was retried. - `report_unavailable` boolean, required — True when a match resolved but the report pull failed (distinct from a search-time error). - `score_version` string, nullable — Version of the match-scoring model; null when unavailable. - `status` 'found' | 'not_found' | 'error', required — Resolution status: found, not_found, or error. - `winner_ref` string, nullable — Ref into the subject's candidates[] for the resolved match; null when unresolved. - `role` string, nullable — Subject's role on the deal; null when unavailable. - `searches` SearchAttempt[], required — Search waterfall in attempted order, including each step's inputs and outcome. - `candidate_count` integer, required — Number of candidates this step returned. - `candidate_refs` SearchAttemptCandidateRef[], required — References into candidates for every candidate returned by this search step. - `id` string, required — Reference to the matching entry in candidates. - `matched_address` string — Address matched on this step; present only when it differs from the canonical entry. - `matched_aka_name` string — AKA name matched on this step; present only when it differs from the canonical entry. - `rank` integer — Rank on this step; present only when it differs from the canonical entry. - `relevance` integer — Relevance on this step; present only when it differs from the canonical entry. - `score_total` number — Match score on this step; present only when it differs from the canonical entry. - `inputs` SearchInputsUsed, required - `address` string, nullable — Address sent on this step; null when unused. - `address_source` 'company_physical_address' | 'company_billing_address' | 'null', nullable — Application address used: company_physical_address or company_billing_address. - `business_name` string, nullable — The business name queried on this step; null on person attempts. - `business_name_source` 'legal' | 'dba' | 'candidate_fallback' | 'linked_address_fallback' | 'null', nullable — Which name variant was queried; null on person attempts. - `corporation_id` string, nullable — Corporation identifier sent on this step; null when unused. - `date_of_birth` string, date, nullable — Date of birth sent on this step; null when unused. - `email` string, nullable — Email sent on this step; null when unused. - `filing_state` string, nullable — Filing state sent on this step; null when unused. - `fuzzy` boolean, required — True when this step allowed fuzzy matching. - `name` string, nullable — Person name sent on this step; null when unused. - `phone` string, nullable — Phone number sent on this step; null when unused. - `ssn` string, nullable — Masked SSN sent on this step; null when unused. - `state` string, nullable — State sent on this step; null when unused. - `is_resolving_match` boolean, required — True on the search step whose match became the subject resolution. - `matched_group_id` string, nullable — Opaque source group identifier for support investigations; null when unmatched. - `outcome` 'matched' | 'no_match' | 'one_candidate' | 'multiple_candidates' | 'verification_failed' | 'error', required — Search outcome: matched, no_match, one_candidate, multiple_candidates, verification_failed, or error. - `outcome_reason` SearchAttemptOutcomeReason - `details` SearchAttemptOutcomeReasonDetail[], required — Label and value pairs explaining the search outcome. - `label` string, required — Display label for the outcome detail. - `value` unknown - `label` string, required — Summary of the search outcome. - `resolved` boolean, required — True when this search confidently resolved the subject and ended the search waterfall. - `search_method` string, required — Search method: ssn_only, name_state_dob, name_address, name_state, corp_id, or manual_recovery. - `top_relevance` integer, nullable — Source relevance score of the best hit; null when no candidate was returned. - `sections` BackgroundCheckSection[], required — Report findings grouped by record type. - `addresses` ProfileAddress[] — Known addresses. Populated only on the `profile` section; empty elsewhere. - `address` string, nullable — Reported address. - `city_state` string, nullable — Reported city and state. - `first_reported_date` string, date, nullable — First reported date; null when unavailable. - `last_reported_date` string, date, nullable — Last reported date; null when unavailable. - `source` string, nullable — Source that supplied the record. - `akas` string[] — Also-known-as names. Populated only on the `profile` section; empty elsewhere. - `count` integer, required — Number of records in the section. - `emails` ProfileEmail[] — Known email addresses. Populated only on the `profile` section; empty elsewhere. - `email` string, nullable — Email address. - `source` string, nullable — Source that supplied the record. - `entry_count` integer, nullable — Number of underlying source entries before roll-up; null for sections without combined records. - `flag` 'ok' | 'fail' | 'null', nullable — Policy flag for this section: ok or fail; null when no policy check cites it. - `key` 'profile' | 'criminal' | 'bankruptcy' | 'liens' | 'ucc' | 'lawsuits' | 'marriage' | 'affiliations' | 'ofac' | 'corporate' | 'industry', required — Section identifier: profile, criminal, bankruptcy, liens, lawsuits, marriage, affiliations, ofac, corporate, ucc, or industry. - `label` string, required — Display label for the section. - `phones` ProfilePhone[] — Populated only on the `profile` section; empty elsewhere. - `carrier` string, nullable — Phone carrier; null when unavailable. - `number` string, nullable — Phone number. - `source` string, nullable — Source that supplied the record. - `type` string, nullable — Source-provided phone type. - `records` union[], required — Section rows. Fields differ by section key; the profile section has no rows. - union - CriminalRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `actual_release_date` string, date, nullable — Actual release date from custody; null when unavailable. - `arrest_date` string, date, nullable — Date of the arrest; null when unavailable. - `arresting_agency` string, nullable — Arresting agency named on the source record; null when unavailable. - `case_number` string, nullable — Court case reference; null when unavailable. - `case_status` string, nullable — The court's live case status, such as DISCHARGE or PENDING. Can resolve a case even when no disposition is recorded; null when unavailable. - `case_status_date` string, date, nullable — Date of the case status; null when unavailable. - `categories` string[] — Offence classifications: fraud, violent, dui, drug, burglary, domestic_violence, child_related, sex_offense, murder_homicide, fiduciary, or other. - `category` string, nullable — Source-provided offence category string. - `court_county` string, nullable — County of the court; null when unavailable. - `court_name` string, nullable — Court name; null when unavailable. - `crime_date` string, date, nullable — Date the offence occurred, distinct from the case filing date; null when unavailable. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `disposition` string, nullable — Case or charge outcome; null when unavailable. - `disposition_date` string, date, nullable — Date of the disposition; null when unavailable. - `entry_count` integer — Number of underlying source entries combined into this record. - `filed_date` string, date, nullable — Case filing date; null when unavailable. - `fine_amount` number, nullable — Fine imposed as a decimal string; null when unavailable. - `grade` 'felony' | 'misdemeanor' | 'petty_misdemeanor' | 'infraction' | 'unknown' — Offence grade: felony, misdemeanor, petty_misdemeanor, infraction, or unknown. - `is_dismissed` boolean — True when the case was dismissed or not prosecuted. - `is_felony` boolean — True when any charge on the case is a felony. - `is_unclassified` boolean — True when the offence could not be classified. - `number_of_counts` integer, nullable — Number of counts; null when unavailable. - `offense` string, nullable — Offence as recorded on the source document. - `offense_location` string, nullable — Where the offence took place; null when unavailable. - `parole_status` string, nullable — Parole status; null when unavailable. - `plea` string, nullable — The plea entered - the changed plea when one exists, else the original; null when unavailable. - `plea_date` string, date, nullable — Date of the plea; null when unavailable. - `probation_end_date` string, date, nullable — Probation end date - the actual end when recorded, else the scheduled end; null when unavailable. - `probation_violation` string, nullable — Probation violation as recorded on the source; null when unavailable. - `projected_release_date` string, date, nullable — Projected release date from custody, falling back to the tentative then maximum release date; null when unavailable. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `sentence` string, nullable — Sentence text; null when unavailable. - `severity` unknown - `severity_text` string, nullable — Source-provided severity string. - `shared_case_key` string, nullable — Stable key for a record that appears on both owner and business reports; null when not shared. - `shared_relationship` 'also_on_owner' | 'also_on_business' | 'null', nullable — Where the shared record also appears: also_on_business or also_on_owner; null when not shared. - `source_entries` CriminalChargeEntrySchema[] — Underlying source rows combined into this record. - … - `source_entry_id` string, nullable — Stable reference for the underlying source row; null when unavailable. - `source_entry_ids` string[] — References for the underlying source rows combined into this record. - `statute_code` string, nullable — Statute code; null when unavailable. - CriminalSectionRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `actual_release_date` string, date, nullable — Actual release date from custody; null when unavailable. - `arrest_date` string, date, nullable — Date of the arrest; null when unavailable. - `arrest_time` string, nullable — Time of the arrest; null when unavailable. - `arresting_agency` string, nullable — Arresting agency named on the source record; null when unavailable. - `booking_date` string, date, nullable — Date of the booking; null when unavailable. - `booking_location` string, nullable — Booking location; null when unavailable. - `booking_number` string, nullable — Booking reference; null when unavailable. - `booking_time` string, nullable — Time of the booking; null when unavailable. - `case_number` string, nullable — Court case reference; null when unavailable. - `case_status` string, nullable — The court's live case status, such as DISCHARGE or PENDING. Can resolve a case even when no disposition is recorded; null when unavailable. - `case_status_date` string, date, nullable — Date of the case status; null when unavailable. - `categories` string[] — Offence classifications: fraud, violent, dui, drug, burglary, domestic_violence, child_related, sex_offense, murder_homicide, fiduciary, or other. - `category` string, nullable — Source-provided offence category string. - `court_county` string, nullable — County of the court; null when unavailable. - `court_name` string, nullable — Court name; null when unavailable. - `crime_date` string, date, nullable — Date the offence occurred, distinct from the case filing date; null when unavailable. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `disposition` string, nullable — Case or charge outcome; null when unavailable. - `disposition_date` string, date, nullable — Date of the disposition; null when unavailable. - `entry_count` integer — Number of underlying source entries combined into this record. - `filed_date` string, date, nullable — Case filing date; null when unavailable. - `fine_amount` number, nullable — Fine imposed as a decimal string; null when unavailable. - `grade` 'felony' | 'misdemeanor' | 'petty_misdemeanor' | 'infraction' | 'unknown' — Offence grade: felony, misdemeanor, petty_misdemeanor, infraction, or unknown. - `is_dismissed` boolean — True when the case was dismissed or not prosecuted. - `is_felony` boolean — True when any charge on the case is a felony. - `is_unclassified` boolean — True when the offence could not be classified. - `number_of_counts` integer, nullable — Number of counts; null when unavailable. - `offense` string, nullable — Offence as recorded on the source document. - `offense_location` string, nullable — Where the offence took place; null when unavailable. - `parole_status` string, nullable — Parole status; null when unavailable. - `plea` string, nullable — The plea entered - the changed plea when one exists, else the original; null when unavailable. - `plea_date` string, date, nullable — Date of the plea; null when unavailable. - `probation_end_date` string, date, nullable — Probation end date - the actual end when recorded, else the scheduled end; null when unavailable. - `probation_violation` string, nullable — Probation violation as recorded on the source; null when unavailable. - `projected_release_date` string, date, nullable — Projected release date from custody, falling back to the tentative then maximum release date; null when unavailable. - `record_type` string, nullable — Record class: Criminal case or Arrest record. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `sentence` string, nullable — Sentence text; null when unavailable. - `severity` unknown - `severity_text` string, nullable — Source-provided severity string. - `shared_case_key` string, nullable — Stable key for a record that appears on both owner and business reports; null when not shared. - `shared_relationship` 'also_on_owner' | 'also_on_business' | 'null', nullable — Where the shared record also appears: also_on_business or also_on_owner; null when not shared. - `source_entries` CriminalChargeEntrySchema[] — Underlying source rows combined into this record. - … - `source_entry_id` string, nullable — Stable reference for the underlying source row; null when unavailable. - `source_entry_ids` string[] — References for the underlying source rows combined into this record. - `state` string, nullable — State the arrest record was reported in; null when unavailable. - `statute_code` string, nullable — Statute code; null when unavailable. - BankruptcyRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `chapter` integer, nullable — Bankruptcy chapter number; null when unavailable. - `chapter_kind` 'chapter_7' | 'chapter_11' | 'chapter_12' | 'chapter_13' | 'other' | 'unknown' — Bankruptcy chapter classification: chapter_7, chapter_11, chapter_12, chapter_13, other, or unknown. - `debtor_name` string, nullable — Debtor named on the filing. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `document_id` string, nullable — Source document reference; null when unavailable. - `filed_date` string, date, nullable — Case filing date; null when unavailable. - `is_open` boolean — True when the bankruptcy case has no terminal date. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `severity` unknown - `status` string, nullable — Source-provided bankruptcy status. - `status_kind` 'filed' | 'discharged' | 'dismissed' | 'unknown' — Bankruptcy status classification: filed, discharged, dismissed, or unknown. Filed means open. - `total_assets` number, nullable — Total scheduled assets as a decimal string; null when the filing does not record them. - `total_liabilities` number, nullable — Total scheduled liabilities as a decimal string; null when the filing does not record them. - LienJudgmentRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `amount` number, nullable — Amount on the record as a decimal string; null when unavailable. - `amount_band` 'none' | 'small' | 'medium' | 'large' — Amount band: none, small under $10,000, medium from $10,000 to $49,999.99, or large at $50,000 or more. - `case_number` string, nullable — Court case reference; null when unavailable. - `court_county` string, nullable — County of the court; null when unavailable. - `court_location` string, nullable — Location of the court; null when unavailable. - `court_name` string, nullable — Court name; null when unavailable. - `creditor_count` integer — Number of creditors on the case. - `creditor_name` string, nullable — First creditor named on the case; null when unavailable. - `debtor_name` string, nullable — Debtor named on the filing. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `entry_count` integer — Number of underlying source entries combined into this record. - `file_date` string, date, nullable — Filing date; null when unavailable. - `filing_relationship` string, nullable — Relationship to another filing: released_by or release_of; null when unlinked. - `is_federal_tax_lien` boolean — True when the filing is a federal tax lien. - `is_mca_creditor` boolean — True when the creditor is a known merchant cash advance funder. - `is_released` boolean — True when a release filing supersedes the lien. - `record_type` string, nullable — Source-provided record class. - `related_filing_number` string, nullable — Reference of the related filing; null when unlinked. - `release_date` string, date, nullable — Lien release date; null when unreleased. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `satisfaction_date` string, date, nullable — Date the debt was satisfied as recorded on the source; null when unavailable. - `severity` unknown - `shared_case_key` string, nullable — Stable key for a record that appears on both owner and business reports; null when not shared. - `shared_relationship` 'also_on_owner' | 'also_on_business' | 'null', nullable — Where the shared record also appears: also_on_business or also_on_owner; null when not shared. - `source_entries` LienJudgmentEntrySchema[] — Underlying source rows combined into this record. - … - `source_entry_ids` string[] — References for the underlying source rows combined into this record. - `status` 'open' | 'released' | 'vacated' | 'closed' — Lien status: open, released, vacated, or closed. - `type_of_filing` string, nullable — Source-provided filing type, such as JUDGMENT LIEN, FEDERAL TAX LIEN, or STATE TAX LIEN. - `type_of_satisfaction` string, nullable — How the debt was satisfied as recorded on the source; null when unavailable. - `vacate_date` string, date, nullable — Judgment vacate date; null when not vacated. - LawsuitRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `amount` number, nullable — Amount on the case as a decimal string; null when unavailable. - `amount_type` 'judgment' | 'award' | 'demand' | 'null', nullable — What the lawsuit amount represents: demand or judgment. - `case_category` string, nullable — Source-provided case category. - `case_number` string, nullable — Court case reference; null when unavailable. - `case_status` unknown - `case_sub_category` string, nullable — Source-provided case subcategory. - `case_title` string, nullable — Case title; null when unavailable. - `case_type` string, nullable — Source-provided case type. - `court_name` string, nullable — Court name; null when unavailable. - `defendant_name` string, nullable — Defendant named on the case. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `entry_count` integer — Number of underlying source entries combined into this record. - `file_date` string, date, nullable — Filing date; null when unavailable. - `is_active` boolean — True when the lawsuit appears to still be live. - `is_felony` boolean — True when the docket record is felony-graded. - `is_mca` boolean — True when the litigation was brought by a known merchant cash advance funder. - `plaintiff_name` string, nullable — Plaintiff named on the case. - `record_type` string, nullable — Record class: Lawsuit or Court docket. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `severity` unknown - `source_entries` LitigationEntrySchema[] — Underlying source rows combined into this record. - … - `source_entry_ids` string[] — References for the underlying source rows combined into this record. - `status_text` string, nullable — Source-provided status string. - MarriageRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `ceremony_type` string, nullable — Source-provided marriage ceremony type; null for divorce-only rows. - `county` string, nullable — County named on the record. - `decree_date` string, date, nullable — Divorce decree date; null for marriage-only rows. - `filing_date` string, date, nullable — Divorce filing date; null for marriage-only rows. - `is_active` boolean — True when the linked divorce case appears active. - `is_divorced` boolean — True when the marriage has a linked divorce record. - `location` string, nullable — Location named on the record. - `marriage_date` string, date, nullable — Marriage date; null for divorce-only rows. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `severity` unknown - `spouse_name` string, nullable — Spouse name; null for divorce-only rows. - AssociateRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `age` integer, nullable — Reported age of the associate. - `association_description` string, nullable — Source description of the association, such as Shared Address. - `city_state` string, nullable — Reported city and state. - `date_of_birth` string, date, nullable — Date of birth; null when unavailable. - `death_date` string, date, nullable — Reported date of death; null when unavailable. - `entity_id` string, nullable — Source entity identifier; null when unavailable. - `first_reported_date` string, date, nullable — First reported date; null when unavailable. - `is_deceased` boolean — True when the associate is reported deceased. - `is_high_risk` boolean — True when the associate is marked high risk. - `last_reported_date` string, date, nullable — Last reported date; null when unavailable. - `name` string, nullable — Name of the associate. - `relationship` string, nullable — Source-provided relationship to the subject. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `severity` unknown - `shares_address` boolean — True when the associate shares an address with the subject. - `shares_phone` boolean — True when the associate shares a phone number with the subject. - `strength_of_association` integer, nullable — Source strength score for the association; null when unavailable. - OfacRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `action_end_date` string, date, nullable — Date the excluded-party action ended. - `action_start_date` string, date, nullable — Date the excluded-party action began. - `action_term` string, nullable — Source-provided duration of the excluded-party action. - `aliases` string[] — Aliases listed on the sanctions record. - `authority` string, nullable — Authority that issued the excluded-party action, such as SAM. - `charge` string, nullable — Charge named on the excluded-party record. - `city` string, nullable — City listed on the sanctions record. - `country` string, nullable — Country listed on the sanctions record. - `document_title` string, nullable — Title of the sanctions document. - `entity_type` string, nullable — Entity type on the source record, such as INDIVIDUAL, COMPANY, or ORGANIZATION. - `finding` string, nullable — Finding stated on the excluded-party record. - `issuer` string, nullable — Issuer named on the sanctions record. - `issuer_category` string, nullable — Category of the sanctions issuer. - `name` string, nullable — Name on the sanctions or excluded-party record. - `position_role` string, nullable — Position or role listed on the sanctions record. - `publication_date` string, date, nullable — Source publication date; null when unavailable. - `publication_name` string, nullable — Publication named on the excluded-party record. - `region` string, nullable — Region listed on the sanctions record. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `sanction_full_text` string, nullable — Full text of the sanctions record. - `sanction_type` string, nullable — Type of sanction. - `severity` unknown - `source` string, nullable — Source that supplied the record. - CorporateRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `associated_business_count` integer — Number of associated businesses in the source business group. - `business_group` string, nullable — Source grouping identifier for associated businesses. - `business_name` string, nullable — The registered business name. - `corp_status` 'active' | 'dissolved' | 'inactive' | 'failed' | 'unknown' — Filing status classification: active, inactive, dissolved, failed, or unknown. Failed covers forfeited, revoked, suspended, and administratively dissolved filings. - `corporation_type` string, nullable — Source-provided corporation type, such as DOMESTIC LIMITED LIABILITY COMPANY. - `filing_date` string, date, nullable — Filing date; null when unavailable. - `filing_office_name` string, nullable — Office where the filing was recorded. - `filing_state` string, nullable — State where the filing was recorded. - `filing_state_name` string, nullable — Full name of the filing state. - `has_officers` boolean — True when the filing lists officers. - `incorporation_date` string, date, nullable — Date the entity was incorporated. - `is_failed` boolean — True when the corporate filing status is failed. - `officer_count` integer — Number of officers listed on the filing. - `officer_names` string[] — Names of officers listed on the filing. - `owner_is_officer` boolean — True when the application's named owner appears among the filing's officers. - `ownership_changed` boolean — True when officers changed across the entity's filings. - `registered_agent` string, nullable — Registered agent listed on the filing. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `severity` unknown - `source` string, nullable — Source that supplied the record. - `state_of_incorporation` string, nullable — State where the entity was incorporated. - `status` string, nullable — Source-provided corporate filing status. - `status_date` string, date, nullable — Date of the source filing status. - UCCRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `collateral_description` string, nullable — Collateral description on the filing. - `collateral_descriptions` string[] — Collateral descriptions across the filing chain. - `debtor_address` string, nullable — Address of the debtor. - `debtor_name` string, nullable — Debtor named on the filing. - `detail` BackgroundCheckRecordDetail — Supplementary source detail returned with include_section_detail=true. The summarised record is the stable typed interface. - … - `entry_count` integer — Number of underlying source entries combined into this record. - `expire_date` string, date, nullable — Filing lapse date; null when unavailable. - `file_date` string, date, nullable — Filing date; null when unavailable. - `filing_number` string, nullable — Filing reference number. - `filing_office_name` string, nullable — Office where the filing was recorded. - `filing_state` string, nullable — State where the filing was recorded. - `filing_type` string, nullable — Filing type, such as FINANCING STATEMENT, CONTINUATION, or TERMINATION. - `in_recent_cluster` boolean — True when the filing is among at least three new UCC liens in the last six months. - `is_active` boolean — True when the filing chain is active. - `is_recent` boolean — True when the filing originated recently. - `is_terminated` boolean — True when the filing chain is terminated. - `original_file_number_full` string, nullable — Full reference for the original filing in the chain. - `record_type` string, nullable — Source-provided record class. - `reference_file_number` string, nullable — Reference linking this row to the original filing in the chain. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `secured_party_address` string, nullable — Address of the secured party. - `secured_party_name` string, nullable — Name of the secured party. - `severity` unknown - `source_entries` UCCFilingEntrySchema[] — Underlying source rows combined into this record. - … - `source_entry_ids` string[] — References for the underlying source rows combined into this record. - `status` 'active' | 'terminated' | 'expired' | 'unknown' — UCC filing-chain status: active, terminated, expired, or unknown. - BusinessProfileRecordSchema — A background-check finding. Risk and severity carry the same none, low, medium, or high tier. - `business_description` string, nullable — Description of the business's activity. - `business_name` string, nullable — Business name on the record. - `primary_naics_code` string, nullable — Primary NAICS industry code. - `primary_naics_desc` string, nullable — Description of the primary NAICS industry code. - `primary_sic_code` string, nullable — Primary SIC industry code. - `primary_sic_desc` string, nullable — Description of the primary SIC industry code. - `risk` 'none' | 'low' | 'medium' | 'high' — Record risk tier. - `secondary_naics_codes` string[] — Secondary NAICS industry codes. - `secondary_sic_codes` string[] — Secondary SIC industry codes. - `severity` unknown - `source` string, nullable — Source that supplied the record. - `severity` 'none' | 'low' | 'medium' | 'high', required — Highest record severity in the section: none, low, medium, or high. - `ssn_issuance` ProfileSsnIssuance - `expiration_date` string, nullable — SSN issuance expiration date; null when unavailable. - `issuance_text` string, nullable — Source-provided SSN issuance summary. - `issue_date` string, nullable — SSN issuance date; null when unavailable. - `issue_state` string, nullable — State where the SSN was issued; null when unavailable. - `work_affiliations` WorkAffiliation[] — Populated only on the `affiliations` section; empty elsewhere. - `address` string, nullable — Address of the business; null when unavailable. - `business_name` string, nullable — Business the subject is affiliated with. - `role` string, nullable — Role at the business, such as CEO, DIRECTOR, or Registered Agent. - `since_date` string, date, nullable — Date the affiliation began; null when unavailable. - `status` string, nullable — Source-provided status of the affiliation. - `unreported_officers` string[], required — Officers on active business filings who are not listed as owners on the application. Empty for person subjects. ## Other responses - `404` — End user not found --- [API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)