> ## Documentation Index > Fetch the complete documentation index at: https://docs.herondata.io/llms.txt > Use this file to discover all available pages before exploring further. # Get EndUser background check dashboard payload > 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. ## OpenAPI ````yaml https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check openapi: 3.0.0 info: contact: email: support@herondata.io name: Support title: Heron Data API version: '2021-07-19' servers: - description: Production url: https://app.herondata.io security: - ApiKeyAuth: - key_XXX externalDocs: description: Read Tutorial url: https://docs.herondata.io/ paths: /api/end_users/{end_user_heron_id}/background_check: get: tags: - EndUsers summary: Get EndUser background check dashboard payload description: >- 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. parameters: - description: The Heron ID of the end user in: path name: end_user_heron_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundCheckResponseSchema' description: OK '404': description: End user not found security: - ApiKeyAuth: [] components: schemas: BackgroundCheckResponseSchema: properties: end_user_id: description: Heron ID of the end user type: string overall: allOf: - $ref: '#/components/schemas/BackgroundCheckOverall' nullable: true policy: allOf: - $ref: '#/components/schemas/BackgroundCheckPolicy' nullable: true processing_stage: enum: - searching - pulling_reports - analysing - null nullable: true type: string status: enum: - never_run - processing - succeeded - failed - missing_input_data type: string subjects: items: $ref: '#/components/schemas/BackgroundCheckSubject' type: array required: - end_user_id - status - subjects type: object BackgroundCheckOverall: properties: check_counts: $ref: '#/components/schemas/BackgroundCheckCheckCounts' result: enum: - passed - failed - review_required - missing_data severity: enum: - none - low - medium - high type: string required: - check_counts - result - severity type: object BackgroundCheckPolicy: properties: checks: items: $ref: '#/components/schemas/BackgroundCheckCheck' type: array result: enum: - passed - failed - review_required - missing_data required: - checks - result type: object BackgroundCheckSubject: properties: case_ref: nullable: true type: string duns_numbers: items: type: string type: array key: enum: - owner_1 - owner_2 - business type: string kind: enum: - person - business type: string name: nullable: true type: string related_party_officers: items: type: string type: array resolution: $ref: '#/components/schemas/BackgroundCheckResolution' role: nullable: true type: string searches: items: $ref: '#/components/schemas/SearchAttempt' type: array sections: items: $ref: '#/components/schemas/BackgroundCheckSection' type: array unreported_officers: items: type: string type: array required: - key - kind - resolution - searches - sections - unreported_officers type: object BackgroundCheckCheckCounts: properties: fail: type: integer pass: type: integer review: type: integer required: - fail - pass - review type: object BackgroundCheckCheck: properties: area: type: string area_sub: nullable: true type: string auto_reason: nullable: true type: string auto_status: enum: - pass - failed - review_required - missing_data check_text: type: string evidence_subjects: items: $ref: '#/components/schemas/BackgroundCheckEvidence' type: array id: type: string override: allOf: - $ref: '#/components/schemas/BackgroundCheckOverride' nullable: true rule: nullable: true type: string signal: type: string required: - area - auto_status - check_text - evidence_subjects - id - signal type: object BackgroundCheckResolution: properties: aka_names: items: type: string type: array confidence_score: nullable: true type: number entity_not_found: type: boolean match_score: allOf: - $ref: '#/components/schemas/CandidateMatchScore' nullable: true method: nullable: true type: string report_unavailable: type: boolean status: enum: - found - not_found - error type: string required: - entity_not_found - report_unavailable - status type: object SearchAttempt: properties: candidate_count: type: integer candidates: items: $ref: '#/components/schemas/CandidateSummary' type: array inputs: $ref: '#/components/schemas/SearchInputsUsed' is_resolving_match: type: boolean matched_group_id: nullable: true type: string outcome: enum: - matched - no_match - multiple_candidates - verification_failed - error type: string outcome_reason: allOf: - $ref: '#/components/schemas/SearchAttemptOutcomeReason' nullable: true search_method: type: string top_relevance: nullable: true type: integer required: - candidate_count - candidates - inputs - is_resolving_match - outcome - search_method type: object BackgroundCheckSection: properties: addresses: items: $ref: '#/components/schemas/ProfileAddress' type: array akas: items: type: string type: array count: type: integer emails: items: $ref: '#/components/schemas/ProfileEmail' type: array entry_count: nullable: true type: integer flag: enum: - ok - fail - null nullable: true type: string key: enum: - profile - criminal - bankruptcy - liens - ucc - lawsuits - marriage - affiliations - ofac - corporate - industry type: string label: type: string phones: items: $ref: '#/components/schemas/ProfilePhone' type: array records: items: oneOf: - $ref: '#/components/schemas/CriminalRecordSchema' - $ref: '#/components/schemas/BankruptcyRecordSchema' - $ref: '#/components/schemas/LienJudgmentRecordSchema' - $ref: '#/components/schemas/LawsuitRecordSchema' - $ref: '#/components/schemas/MarriageRecordSchema' - $ref: '#/components/schemas/AssociateRecordSchema' - $ref: '#/components/schemas/OfacRecordSchema' - $ref: '#/components/schemas/CorporateRecordSchema' - $ref: '#/components/schemas/UCCRecordSchema' - $ref: '#/components/schemas/BusinessProfileRecordSchema' type: array severity: enum: - none - low - medium - high type: string ssn_issuance: allOf: - $ref: '#/components/schemas/ProfileSsnIssuance' nullable: true work_affiliations: items: $ref: '#/components/schemas/WorkAffiliation' type: array required: - count - key - label - records - severity type: object BackgroundCheckEvidence: properties: filtered: type: boolean record_indices: items: type: integer type: array section: nullable: true type: string subject_key: enum: - owner_1 - owner_2 - business - any_owner - submission - null nullable: true type: string required: - filtered - record_indices type: object BackgroundCheckOverride: properties: at: format: date-time type: string by: type: string status: enum: - pass - failed - review_required - missing_data required: - at - by - status type: object CandidateMatchScore: properties: cap_reason: nullable: true type: string fields: items: $ref: '#/components/schemas/CandidateMatchScoreField' type: array score: type: integer score_version: type: string tier: enum: - high - medium - low type: string required: - fields - score - score_version - tier type: object CandidateSummary: properties: address: nullable: true type: string aka_names: items: type: string type: array duns_numbers: items: type: string type: array entity_id: nullable: true type: string group_id: nullable: true type: string is_best_candidate: type: boolean is_limited: type: boolean is_match: type: boolean match_score: allOf: - $ref: '#/components/schemas/CandidateMatchScore' nullable: true matched_address: nullable: true type: string matched_aka_name: nullable: true type: string name: nullable: true type: string rank: nullable: true type: integer reason: nullable: true type: string relevance: nullable: true type: integer selection_basis: nullable: true type: string selection_rank_reason: nullable: true type: string required: - is_best_candidate - is_limited - is_match type: object SearchInputsUsed: properties: address: nullable: true type: string address_source: enum: - company_physical_address - company_billing_address - null nullable: true type: string business_name: nullable: true type: string business_name_source: enum: - legal - dba - candidate_fallback - null nullable: true type: string corporation_id: nullable: true type: string date_of_birth: format: date nullable: true type: string email: nullable: true type: string filing_state: nullable: true type: string fuzzy: type: boolean name: nullable: true type: string phone: nullable: true type: string ssn: nullable: true type: string state: nullable: true type: string required: - fuzzy type: object SearchAttemptOutcomeReason: properties: details: items: $ref: '#/components/schemas/SearchAttemptOutcomeReasonDetail' type: array label: type: string required: - details - label type: object ProfileAddress: properties: address: nullable: true type: string city_state: nullable: true type: string first_reported_date: format: date nullable: true type: string last_reported_date: format: date nullable: true type: string source: nullable: true type: string type: object ProfileEmail: properties: email: nullable: true type: string source: nullable: true type: string type: object ProfilePhone: properties: carrier: nullable: true type: string number: nullable: true type: string source: nullable: true type: string type: nullable: true type: string type: object CriminalRecordSchema: properties: arresting_agency: nullable: true type: string case_number: nullable: true type: string categories: items: enum: - violent - murder_homicide - domestic_violence - burglary - fraud - sex_offense - child_related - fiduciary - animal_cruelty - drug - dui - other type: array category: nullable: true type: string court_name: nullable: true type: string disposition: nullable: true type: string disposition_date: format: date nullable: true type: string entry_count: type: integer filed_date: format: date nullable: true type: string grade: enum: - felony - misdemeanor - petty_misdemeanor - infraction - unknown is_dismissed: type: boolean is_felony: type: boolean is_unclassified: type: boolean offense: nullable: true type: string risk: enum: - none - low - medium - high sentence: nullable: true type: string severity: readOnly: true severity_text: nullable: true type: string shared_case_key: nullable: true type: string shared_relationship: enum: - also_on_owner - also_on_business - null nullable: true type: string source_entries: items: $ref: '#/components/schemas/CriminalChargeEntrySchema' type: array source_entry_id: nullable: true type: string source_entry_ids: items: type: string type: array statute_code: nullable: true type: string type: object BankruptcyRecordSchema: properties: chapter: nullable: true type: integer chapter_kind: enum: - chapter_7 - chapter_11 - chapter_12 - chapter_13 - other - unknown debtor_name: nullable: true type: string document_id: nullable: true type: string filed_date: format: date nullable: true type: string is_open: type: boolean risk: enum: - none - low - medium - high severity: readOnly: true status: nullable: true type: string status_kind: enum: - filed - discharged - dismissed - unknown type: object LienJudgmentRecordSchema: properties: amount: nullable: true type: number amount_band: enum: - none - small - medium - large case_number: nullable: true type: string court_county: nullable: true type: string court_location: nullable: true type: string court_name: nullable: true type: string creditor_name: nullable: true type: string debtor_name: nullable: true type: string entry_count: type: integer file_date: format: date nullable: true type: string filing_relationship: nullable: true type: string is_federal_tax_lien: type: boolean is_mca_creditor: type: boolean is_released: type: boolean record_type: nullable: true type: string related_filing_number: nullable: true type: string release_date: format: date nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true shared_case_key: nullable: true type: string shared_relationship: enum: - also_on_owner - also_on_business - null nullable: true type: string source_entries: items: $ref: '#/components/schemas/LienJudgmentEntrySchema' type: array source_entry_ids: items: type: string type: array status: enum: - open - released - vacated - closed type_of_filing: nullable: true type: string vacate_date: format: date nullable: true type: string type: object LawsuitRecordSchema: properties: amount: nullable: true type: number amount_type: enum: - judgment - award - demand - null nullable: true type: string case_number: nullable: true type: string case_type: nullable: true type: string court_name: nullable: true type: string defendant_name: nullable: true type: string file_date: format: date nullable: true type: string is_active: type: boolean is_mca: type: boolean plaintiff_name: nullable: true type: string record_type: nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true type: object MarriageRecordSchema: properties: ceremony_type: nullable: true type: string county: nullable: true type: string decree_date: format: date nullable: true type: string filing_date: format: date nullable: true type: string is_active: type: boolean is_divorced: type: boolean location: nullable: true type: string marriage_date: format: date nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true spouse_name: nullable: true type: string type: object AssociateRecordSchema: properties: age: nullable: true type: integer association_description: nullable: true type: string city_state: nullable: true type: string date_of_birth: format: date nullable: true type: string death_date: format: date nullable: true type: string entity_id: nullable: true type: string first_reported_date: format: date nullable: true type: string is_deceased: type: boolean is_high_risk: type: boolean last_reported_date: format: date nullable: true type: string name: nullable: true type: string relationship: nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true shares_address: type: boolean shares_phone: type: boolean strength_of_association: nullable: true type: integer type: object OfacRecordSchema: properties: action_end_date: format: date nullable: true type: string action_start_date: format: date nullable: true type: string action_term: nullable: true type: string aliases: items: type: string type: array authority: nullable: true type: string charge: nullable: true type: string city: nullable: true type: string country: nullable: true type: string document_title: nullable: true type: string entity_type: nullable: true type: string finding: nullable: true type: string issuer: nullable: true type: string issuer_category: nullable: true type: string name: nullable: true type: string position_role: nullable: true type: string publication_date: format: date nullable: true type: string publication_name: nullable: true type: string region: nullable: true type: string risk: enum: - none - low - medium - high sanction_full_text: nullable: true type: string sanction_type: nullable: true type: string severity: readOnly: true source: nullable: true type: string type: object CorporateRecordSchema: properties: associated_business_count: type: integer business_group: nullable: true type: string business_name: nullable: true type: string corp_status: enum: - active - dissolved - inactive - failed - unknown corporation_type: nullable: true type: string filing_date: format: date nullable: true type: string filing_office_name: nullable: true type: string filing_state: nullable: true type: string filing_state_name: nullable: true type: string has_officers: type: boolean incorporation_date: format: date nullable: true type: string is_failed: type: boolean officer_count: type: integer officer_names: items: type: string type: array owner_is_officer: type: boolean ownership_changed: type: boolean registered_agent: nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true source: nullable: true type: string state_of_incorporation: nullable: true type: string status: nullable: true type: string status_date: format: date nullable: true type: string type: object UCCRecordSchema: properties: collateral_description: nullable: true type: string collateral_descriptions: items: type: string type: array debtor_address: nullable: true type: string debtor_name: nullable: true type: string entry_count: type: integer expire_date: format: date nullable: true type: string file_date: format: date nullable: true type: string filing_number: nullable: true type: string filing_office_name: nullable: true type: string filing_state: nullable: true type: string filing_type: nullable: true type: string in_recent_cluster: type: boolean is_active: type: boolean is_recent: type: boolean is_terminated: type: boolean original_file_number_full: nullable: true type: string record_type: nullable: true type: string reference_file_number: nullable: true type: string risk: enum: - none - low - medium - high secured_party_address: nullable: true type: string secured_party_name: nullable: true type: string severity: readOnly: true source_entries: items: $ref: '#/components/schemas/UCCFilingEntrySchema' type: array source_entry_ids: items: type: string type: array status: enum: - active - terminated - expired - unknown type: object BusinessProfileRecordSchema: properties: business_description: nullable: true type: string business_name: nullable: true type: string primary_naics_code: nullable: true type: string primary_naics_desc: nullable: true type: string primary_sic_code: nullable: true type: string primary_sic_desc: nullable: true type: string risk: enum: - none - low - medium - high secondary_naics_codes: items: type: string type: array secondary_sic_codes: items: type: string type: array severity: readOnly: true source: nullable: true type: string type: object ProfileSsnIssuance: properties: expiration_date: nullable: true type: string issuance_text: nullable: true type: string issue_date: nullable: true type: string issue_state: nullable: true type: string type: object WorkAffiliation: properties: address: nullable: true type: string business_name: nullable: true type: string role: nullable: true type: string since_date: format: date nullable: true type: string status: nullable: true type: string type: object CandidateMatchScoreField: properties: application_value: nullable: true type: string candidate_value: nullable: true type: string field: type: string max_points: type: integer points: type: integer reason: nullable: true type: string verdict: enum: - agree - fuzzy - diverge - absent type: string required: - field - max_points - points - verdict type: object SearchAttemptOutcomeReasonDetail: properties: label: type: string value: nullable: true required: - label type: object CriminalChargeEntrySchema: properties: arresting_agency: nullable: true type: string case_number: nullable: true type: string categories: items: enum: - violent - murder_homicide - domestic_violence - burglary - fraud - sex_offense - child_related - fiduciary - animal_cruelty - drug - dui - other type: array category: nullable: true type: string court_name: nullable: true type: string disposition: nullable: true type: string disposition_date: format: date nullable: true type: string filed_date: format: date nullable: true type: string grade: enum: - felony - misdemeanor - petty_misdemeanor - infraction - unknown is_dismissed: type: boolean is_felony: type: boolean offense: nullable: true type: string risk: enum: - none - low - medium - high sentence: nullable: true type: string severity: readOnly: true severity_text: nullable: true type: string source_entry_id: nullable: true type: string statute_code: nullable: true type: string type: object LienJudgmentEntrySchema: properties: amount: nullable: true type: number amount_band: enum: - none - small - medium - large case_number: nullable: true type: string court_county: nullable: true type: string court_location: nullable: true type: string court_name: nullable: true type: string creditor_name: nullable: true type: string debtor_name: nullable: true type: string file_date: format: date nullable: true type: string filing_relationship: nullable: true type: string is_federal_tax_lien: type: boolean is_mca_creditor: type: boolean is_released: type: boolean original_filing_number: nullable: true type: string record_type: nullable: true type: string related_filing_number: nullable: true type: string release_date: format: date nullable: true type: string risk: enum: - none - low - medium - high severity: readOnly: true source_entry_id: nullable: true type: string type_of_filing: nullable: true type: string vacate_date: format: date nullable: true type: string type: object UCCFilingEntrySchema: properties: collateral_description: nullable: true type: string collateral_descriptions: items: type: string type: array debtor_address: nullable: true type: string debtor_name: nullable: true type: string expire_date: format: date nullable: true type: string file_date: format: date nullable: true type: string filing_number: nullable: true type: string filing_office_name: nullable: true type: string filing_state: nullable: true type: string filing_type: nullable: true type: string in_recent_cluster: type: boolean is_recent: type: boolean original_file_number_full: nullable: true type: string record_type: nullable: true type: string reference_file_number: nullable: true type: string risk: enum: - none - low - medium - high secured_party_address: nullable: true type: string secured_party_name: nullable: true type: string severity: readOnly: true source_entry_id: nullable: true type: string type: object securitySchemes: ApiKeyAuth: in: header name: x-api-key type: apiKey ````