report field mappings.md

Report field mappings

Use this guide to help build customized reports quickly.

Report fields

Applicant information

Report JSON Field
First Name information.first_name
Alias/Nickname information.alias
Middle Name information.middle_name
Last Name information.last_name
Email Address application.applicant.email
Phone Number information.phone_number
Date of Birth information.date_of_birth
SIN/SSN information.sin_ssn
License information.licence_number

Softcheck

Risk result

Report JSON Field
Public Court Records risk_result.scan_status.public_court_records
Public Criminal History risk_result.scan_status.criminal_scan
Fraud Watchlists risk_result.scan_status.fraud_scan
Known Affiliations risk_result.scan_status.known_affiliation_scan
Global Sanctions & Enforcement Check risk_result.scan_status.ofac_global_terrorist_scan
Public Safety Check risk_result.scan_status.public_safety_scan
Sex Offender Check risk_result.scan_status.sex_offender_scan
Global Clearance Check risk_result.scan_status.global_clearance_scan
Other Searches risk_result.scan_status.other_scan
Public Profile Scan risk_result.scan_status.public_profile_scan

Risk factors

Report JSON Field
Early Termination early_termination_label
Reliability reliability_risk_label
Workplace Misconduct workplace_misconduct_level

Public profile

Report JSON Field
Network risk_result.risk_evaluations.risk_information_result.urls.site_name
Status risk_result.risk_evaluations.risk_information_result.urls.site_category
URL risk_result.risk_evaluations.risk_information_result.urls.site_url

Employment history

Report JSON Field
Employer risk_result.risk_evaluations.risk_information_result.employers.company_name
Details risk_result.risk_evaluations.risk_information_result.employers.postition
Dates

risk_result.risk_evaluations.risk_information_result.employers.start_date

--

risk_result.risk_evaluations.risk_information_result.employers.end_date

Residential history

Report JSON Field
Address risk_result.risk_evaluations.risk_information_result.adresses.adress
City risk_result.risk_evaluations.risk_information_result.adresses.city
Province/State risk_result.risk_evaluations.risk_information_result.adresses.province_state
Country risk_result.risk_evaluations.risk_information_result.adresses.country
Postal Code risk_result.risk_evaluations.risk_information_result.adresses.postal_code

Education history

Report JSON Field
Institution risk_result.risk_evaluations.risk_information_result.educations.institution
Details risk_result.risk_evaluations.risk_information_result.educations.degree
Dates

risk_result.risk_evaluations.risk_information_result.educations.start_date

--

risk_result.risk_evaluations.risk_information_result.educations.end_date

Criminal scan

Parent category: CRIMINAL

Report JSON Field
Category risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_alerts.[index].category
Stage risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_alerts.[index].stage
Type risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_alerts.[index].type
Description risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_alerts.[index].description
Date risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_alerts.[index].date

Fraud scan

Parent category: FRAUD

Sex offender scan

Parent category: SEX_OFFENDER

Known affiliations

Parent category: AFFILIATIONS

Global sanctions & enforcement scan (OFAC)

Parent category: OFAC

Global clearance scan

Parent category: GLOBAL_CLEARANCE

Public safety scan

Parent category: PUBLIC SAFETY

Other scan

Parent category: OTHER

Sources

Report JSON Field
Publication Source risk_result.risk_evaluations.criminal_results.criminal_sources[index].publication_source
Name risk_result.risk_evaluations.criminal_results.criminal_sources[index].name
URL risk_result.risk_evaluations.criminal_results.criminal_sources[index].url
Date risk_result.risk_evaluations.criminal_results.criminal_sources[index].date

Addresses

Report JSON Field
Address risk_result.risk_evaluations.criminal_results.[index].criminal_identity.criminal_adresses[index].full_adress
Dates

risk_result.risk_evaluations.criminal_results.[index].criminal_identity.criminal_adresses[index].start_date

--risk_result.risk_evaluations.criminal_results.[index].criminal_identity.criminal_adresses[index].end_date

Additional information

Report JSON Field
Aliases risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_additional_informations[index].aliases
Date of birth risk_result.risk_evaluations.criminal_results[index].criminal_identity.criminal_additional_informations[index].dates_of_birth

Social Media Check

Social Media Check result

Report JSON Field
Social Media Report Document social_media_check_result.social_media_report_document
Is Region Supported social_media_check_result.is_region_supported

Credit Check

Financial details

Report JSON Field
Potential Positives equifax_result.green_flags[index]
Potential Negatives equifax_result.red_flags[index]
Credit Score equifax_result.credit_score
Credit Check Errors equifax_result.credit_check_errors[index]
Credit Check Warnings equifax_result.credit_check_warnings[index]

Addresses

Report JSON Field
Unit equifax_result.addresses[index].civic_number
Street equifax_result.addresses[index].street_name
City equifax_result.addresses[index].city
Province equifax_result.addresses[index].province

Employment

Report JSON Field
Occupation equifax_result.employers[index].occupation
Employer equifax_result.employers[index].employer

Revolving credit

Report JSON Field
Total Balance equifax_result.revolving_credit_total_balance
Max Limit equifax_result.revolving_credit_max_total_limit
% of Credit Used equifax_result.revolving_credit_percent_credit_used
Number of Cards equifax_result.revolving_credit_number_of_cards
Past Due Amount equifax_result.revolving_credit_past_due_amount
Late Payments 30/60/90

equifax_result.revolving_credit_late_payments_30

--

equifax_result.revolving_credit_late_payments_60

--

equifax_result.revolving_credit_late_payments_90
Monthly Payments equifax_result.revolving_credit_monthly_payments

Other credit

Report JSON Field
Total Balance equifax_result.other_credit_total_balance
Max Limit equifax_result.other_credit_max_total_limit
% of Credit Used equifax_result.other_credit_percent_credit_used
Number of Loans equifax_result.other_credit_number_of_cards
Past Due Payments equifax_result.other_credit_past_due_amount
Late Payments 30/60/90

equifax_result.other_credit_late_payments_30

--

equifax_result.other_credit_late_payments_60

--

equifax_result.other_credit_late_payments_90
Monthly Payments equifax_result.other_credit_monthly_payments

Other debts

Report JSON Field
Total Balance equifax_result.other_debts_total_balance
Max Limit equifax_result.other_debts_max_total_limit
% of Credit Used equifax_result.other_debts_percent_credit_used
Number of Loans equifax_result.other_debts_number_of_cards
Past Due Payments equifax_result.other_debts_past_due_amount
Late Payments 30/60/90

equifax_result.other_debts_late_payments_30

--

equifax_result.other_debts_late_payments_60

--

equifax_result.other_debts_late_payments_90
Monthly Payments equifax_result.other_debts_monthly_payments

Automobile loans

Report JSON Field
Total Balance equifax_result.auto_loans_total_balance
Max Limit equifax_result.auto_loans_max_total_limit
% of Credit Used equifax_result.auto_loans_percent_credit_used
Number of Loans equifax_result.auto_loans_number_of_cards
Past Due Payments equifax_result.auto_loans_past_due_amount
Late Payments 30/60/90

equifax_result.auto_loans_late_payments_30

--

equifax_result.auto_loans_late_payments_60

--

equifax_result.auto_loans_late_payments_90
Monthly Payments equifax_result.auto_loans_monthly_payments

Student loans

Report JSON Field
Total Balance equifax_result.student_loans_total_balance
Max Limit equifax_result.student_loans_max_total_limit
% of Credit Used equifax_result.student_loans_percent_credit_used
Number of Loans equifax_result.student_loans_number_of_cards
Past Due Payments equifax_result.student_loans_past_due_amount
Late Payments 30/60/90

equifax_result.student_loans_late_payments_30

--

equifax_result.student_loans_late_payments_60

--

equifax_result.student_loans_late_payments_90
Monthly Payments equifax_result.student_loans_monthly_payments

Mortgage loans

Report JSON Field
Total Balance equifax_result.mortgage_loans_total_balance
Max Limit equifax_result.mortgage_loans_max_total_limit
% of Credit Used equifax_result.mortgage_loans_percent_credit_used
Number of Loans equifax_result.mortgage_loans_number_of_cards
Past Due Payments equifax_result.mortgage_loans_past_due_amount
Late Payments 30/60/90

equifax_result.mortgage_loans_late_payments_30

--

equifax_result.mortgage_loans_late_payments_60

--

equifax_result.mortgage_loans_late_payments_90
Monthly Payments equifax_result.mortgage_loans_monthly_payments

Tradelines

Report JSON Field
Credit Grantor equifax_result.trades[index].credit_grantor
Payment Status equifax_result.trades[index].payment_status
Date Opened equifax_result.trades[index].date_opened
Date Reported equifax_result.trades[index].date_reported
Account Type equifax_result.trades[index].account_type
High Credit equifax_result.trades[index].high_credit
Balance Amount equifax_result.trades[index].balance_amount
Last Activity or Payment equifax_result.trades[index].last_activity_or_payment
R Code equifax_result.trades[index].r_code
Percent Credit Used equifax_result.trades[index].percent_credit_used
Months Reviewed equifax_result.trades[index].months_reviewed
Account Number equifax_result.trades[index].account_number
Past Due Amount equifax_result.trades[index].past_due_amount
Payment Term Amount equifax_result.trades[index].payment_term_amount
Narratives equifax_result.trades[index].narratives[index]

Other

Report JSON Field
Other Incomes equifax_result.other_incomes[index]
Non Sufficient Funds equifax_result.non_sufficient_funds[index]
Fraud Warnings equifax_result.fraud_warnings[index]
Secured Loans equifax_result.secured_loans[index]
Liens equifax_result.liens[index]
Legal Items equifax_result.legal_items[index]

Credit file metadatas

Report JSON Field
File Since Date equifax_result.credit_file_metadatas[index].file_since_date
Date of Last Activity equifax_result.credit_file_metadatas[index].date_of_last_activity
Date of Request equifax_result.credit_file_metadatas[index].date_of_request
Hit equifax_result.credit_file_metadatas[index].hit
Data Warning Messages equifax_result.credit_file_metadatas[index].data_warning_messages[index]
Card Alert Messages equifax_result.credit_file_metadatas[index].card_alert_warning_messages[index]
Alert Indicators equifax_result.credit_file_metadatas[index].alert_indicators[index]

Local inquiries

Report JSON Field
Inquiry Date equifax_result.local_inquiries[index].inquiry_date
Customer Name equifax_result.local_inquiries[index].customer_name
Foreign Inquiries equifax_result.foreign_inquiries[index]
Bankrupcies equifax_result.bankruptcies[index]

Collections

Last Payment JSON Field
Last Payment equifax_result.collections[index].date_of_last_payment
Creditor equifax_result.collections[index].creditor
Amount Owed equifax_result.collections[index].amount_owed
Amount Paid equifax_result.collections[index].amount_paid
Date Paid equifax_result.collections[index].date_paid
Date Reported equifax_result.collections[index].date_reported
Date Assigned equifax_result.collections[index].assigned_date
Account Designation equifax_result.collections[index].account_designation
First Delinquency equifax_result.collections[index].first_delinquency
Judgements equifax_result.judgements[index]
Bank Accounts equifax_result.bank_accounts[index]
Deposit Alert equifax_result.deposit_alerts[index]
Consumer Statements equifax_result.consumer_statements[index]

Financial summary

Report JSON Field
Credit Check equifax_result.credit_score
Legal Items equifax_result.legal_items[index]
Notable Risks equifax_result.red_flags[index]

Identity Verification

Identities

Report JSON Field
Name identity_verification.identity.name
Date of Birth identity_verification.identity.date_of_birth
Current Address identity_verification.identity.current_address
Former Address identity_verification.identity.former_address
Phone Number identity_verification.identity.phone_number.raw_phone_number
SSN/SIN identity_verification.identity.sin_ssn
Driver's License identity_verification.identity.drivers_licence

Manual identity verification

Report JSON Field
Name

manual_id_verification.identity.name.first_name

--

manual_id_verification.identity.name.middle_name

--

manual_id_verification.identity.name.last_name
Date of Birth manual_id_verification.identity.date_of_birth
Address manual_id_verification.identity.current_address.full_address
Address Doc Type manual_id_verification.identity.current_address.supplemental_document_description
Document Type manual_id_verification.document_type
Document Number manual_id_verification.document_number
Issuing Country manual_id_verification.issuing_country
Issuing Jurisdiction manual_id_verification.issuing_jurisdiction
Expiry Date manual_id_verification.expiry_date

Enhanced Identity Verification

Report JSON Field
Name enhanced_identity_verification.identity.name
Date of Birth enhanced_identity_verification.identity.date_of_birth
Address enhanced_identity_verification.identity.current_address.full_address
Document Type enhanced_identity_verification.document_type
Document Number enhanced_identity_verification.document_number
Issuing Country enhanced_identity_verification.issuing_country
Issuing Jurisdiction enhanced_identity_verification.issuing_jurisdiction
Expiry Date enhanced_identity_verification.expiry_date

Canadian Criminal Record Check

Report JSON Field
Name

information.last_name

--

information.first_name
Date of Birth information.date_of_birth
Gender information.gender
Other Names/Aliases information.alias
Issued Date rcmp_result.issued_date
Additional Documents rcmp_result.rcmp_result_document

Base

Report JSON Field
Result rcmp_result.response_label
Comments rcmp_result.comments

Enhanced

Report JSON Field
Result rcmp_result.enhanced
Comments rcmp_result.enhanced_comments

Disclosed convictions

Report JSON Field
Offense information.convictions[index].offense
Court Location information.convictions[index].court_location
Date of Sentence information.convictions[index].date_of_sentence
Description information.convictions[index].description

US Criminal Record Check

Source list

Report JSON Field
Type us_criminal_record_check_result.record_check_requests[index].search_type
County us_criminal_record_check_result.record_check_requests[index].county
State us_criminal_record_check_result.record_check_requests[index].state
District us_criminal_record_check_result.record_check_requests[index].district
Fips Code us_criminal_record_check_result.record_check_requests[index].fips_code
Result us_criminal_record_check_result.record_check_requests[index].status

SSN

Report JSON Field
SSN Result us_criminal_record_check_result.ssn_id_document_reports[index].ssn_result
SSN Status us_criminal_record_check_result.ssn_id_document_reports[index].ssn_status

Names and aliases

Report JSON Field
First Name us_criminal_record_check_result.ssn_id_document_reports[index].names[index].first_name
Middle Name us_criminal_record_check_result.ssn_id_document_reports[index].names[index].middle_name
Last Name us_criminal_record_check_result.ssn_id_document_reports[index].names[index].last_name

Addresses

Report JSON Field
Address us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].address
City us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].city
County us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].county
Province/State us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].province_state
Country us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].country
Postal Code us_criminal_record_check_result.ssn_id_document_reports[index].addresses[index].postal_code

Criminal cases

Report JSON Field
Offense Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].offense_description
Offense Type us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].offense_type

Dispositions

Report JSON Field
Offense Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].offense_description
Offense Type us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].offense_type
Offense Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].offense_date
Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].description
Disposition Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].disposition_date
Statute us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].statute
Offense Class us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].offense_class
Final Plea us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].dispositions[index].final_plea

Arrests

Report JSON Field
Arrest Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].arrest_date
Booking Number us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].booking_number
Citation Number us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].citation_number
Booking Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].booking_date
Arresting Agency us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].arresting_agency
Offense Type us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].offense_type
Offense Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].offense_description
Counts us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].arrests[index].counts

Sentences

Report JSON Field
Sentence Type us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].sentence_type
Duration us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].duration
Amount us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].amount
Amount Paid us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].amount_paid
Paid us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].paid
Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].description
Effective Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].effective_date
Appearance Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].appearance_date
Appearance Finding us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].sentences[index].appearance_date

Additional information

Report JSON Field
Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].additional_informations[index].description
Additional Description us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].additional_informations[index].additional_description
Event Date us_criminal_record_check_result.criminal_cases[index].criminal_charges[index].additional_informations[index].event_date

Australia Right to Work Check

Report JSON Field
Inquiry Result right_to_work_result

UK Right To Work Check

Report JSON Field
Inquiry Result uk_right_to_work_result

Basic Disclosure Scotland (DS) Check

Report JSON Field
Inquiry Result uk_basic_ds_check_result

Basic Disclosure And Barring Service (DBS) Check

Report JSON Field
Inquiry Result uk_basic_dbs_check_result

International Criminal Record Check

Report JSON Field
Requested Country international_criminal_record_check_result.international_criminal_record_checks[index].record_check_request.country
Requested Status international_criminal_record_check_result.international_criminal_record_checks[index].record_check_request.status
First Name international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.name.first_name
Middle Name international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.name.middle_name
Last Name international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.name.last_name
Date of Birth international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.date_of_birth
Country Name international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.country_name
Report Clearance international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_clearance
Date Updated international_criminal_record_check_result.international_criminal_record_checks[index].record_check.date_updated
Report Attributes international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index]
Report Attribute Name international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index].name
Report Attribute Sources international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index].sources[index]
Inquiry Details international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index].fields[index].inquiry_details
Inquiry Resuts international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index].fields[index].inquiry_results
Inquiry Label international_criminal_record_check_result.international_criminal_record_checks[index].record_check.report.report_attributes[index].fields[index].label

Certn Verifications

Education Verification

Report JSON Field
Institution information.educations[index].institution
Location information.educations[index].address.full_address
Details

information.educations[index].degree.degree
---
information.educations[index].specializations.specialization
Dates

information.educations[index].start_date

--

information.educations[index].end_date
Results information.educations[index].verification_results
Status information.educations[index].certn_verification

Education Verification notes

Report JSON Field
Institution information.educations[index].institution
Dates

information.educations[index].start_date

--

information.educations[index].end_date
Notes information.educations[index].verification_notes

Employment Verification

Report JSON Field
Company information.employers[index].company_name
Title information.employers[index].position
Dates

information.employers[index].start_date

--

information.employers[index].end_date
Results information.employers[index].verification_results
Status information.employers[index].certn_verification
Contact information.employers[index].can_contact

Employment Verification notes

Report JSON Field
Company information.employers[index].company_name
Dates

information.employers[index].start_date

--

information.employers[index].end_date
Notes information.employers[index].verification_notes