API Data Dictionary

Every request/response field in the RFR Partner API, generated at build time from the served OpenAPI spec.

Webhook Events

Event	Meaning
`case.received`	Case queued for processing
`case.files_updated`	A file was added to the case after submission
`case.in_progress`	Research has begun
`case.action_required`	Additional information or documents needed
`case.additional_policies_found`	Additional policies located and offered for purchase
`case.results_ready`	Results available for download
`case.closed`	Case has been closed

Full payload documentation lives in the API reference (Webhooks section).

Results JSON (results_data)

The results payload returned by GET /api/v1/partner/cases/{case_ref}/results/?result_format=json is delivered as an opaque results_data object — its field-level dictionary (shared fields, Policy Limit fields, Policy Existence fields, additional policies) is documented in the API reference under "Results JSON Schema".

PartnerCasePolicyLimit

Field	Type	Required	Description
`cc_emails`	string	required	Whitespace-delimited list of additional email addresses to CC on case correspondence. If the first entry is a valid email address, it is used as the reporting requester's email; otherwise the requester falls back to the API token/account name.
`summary`	string		Plaintiff and Case Number
`plaintiff_name`	string	required	Who is your client? Who are you representing?
`defendant_business_name`	string		The term 'Defendant' will refer to the person/company whose insurance is being searched for. Conditional: `defendant_business_name` — required when `base_product[0]` starts with `commercial` OR `base_product[0]` starts with `international_commercial`.
`office_case_number`	string		Do you have an internal case/file number? We can include this on your request for your convenience.
`date_of_loss`	string	required	Date the incident occurred (YYYY-MM-DD).
`is_incident_report_provided`	boolean	required	Is a police report, crash report, or exchange of information card provided? These documents are critical for liability limit research. Secondary options are 911 transcripts, police radio transcripts, or witness statements.
`is_user_agreeing_to_all_terms_and_conditions`	boolean		Is the user agreeing to all terms and conditions?
`is_black_card`	boolean		DEPRECATED: This field is now automatically determined based on your organization's Black Card status. You can still send this field for backward compatibility, but the value will be ignored. The system will automatically set the correct value based on your organization. This field will be removed in version 2.0.0.
`is_payment_via_lumen`	boolean		Are you submitting this request to be paid through Lumen Financial? (Note: Only available if your account is enrolled)
`is_test`	boolean		Is this a test submission? Test cases are automatically labeled TEST in Jira.
`base_product`	array<string> enum: commercial_auto_policy_limits, commercial_general_liability_policy_limits, international_commercial_policy_limits, commercial_other_policy_limits, personal_auto_policy_limits, personal_homeowner_or_renters_policy_limits, …	required	Products you want to use with the request (you cannot select both commercial and personal choices).
`expedited_request`	string enum: three_hour_rush_request, one_day_rush_request, three_day_rush_request, five_day_rush_request		Add an expedition to your request.
`add_on_services`	array<string> enum: policy_number, policy_period, property_damage_limits, skip_trace, um_uim_limits, umbrella_policy_limits		Add on services to bundle with the request
`insurance_company`	string	required	Insurance company to search for. You can provide either: - A known company name (e.g., 'Farmers', 'Mercury', 'AAA') - A custom company name (e.g., 'HNS IV: Third Party Recovery') Known companies: 21st Century, AAA (Except Southern California), AAA Southern California, Bristol West, Coast National, Farmers, Foremost, Mercury, Orion, Toggle, Worksmens. Disclaimer: We do not accept requests for USAA, American National, Go Insurance, Federated Insurance, Security National Insurance, or Wawanesa. Note: A $75 addon fee will be charged for specialty companies (AAA Except Southern California, Bristol West, Coast National, Farmers, Foremost, Mercury, 21st Century, Orion, Worksmens, Toggle). Conditional: `insurance_company` — must not name `American National` (variant spellings are matched). Conditional: `insurance_company` — must not name `Federated Insurance` (variant spellings are matched). Conditional: `insurance_company` — must not name `Go Insurance` (variant spellings are matched). Conditional: `insurance_company` — must not name `Security National Insurance` (variant spellings are matched). Conditional: `insurance_company` — must not name `USAA` (variant spellings are matched). Conditional: `insurance_company` — must not name `Wawanesa` (variant spellings are matched).
`insurance_company_name`	string		DEPRECATED: Use 'insurance_company' field instead. This field is maintained for backward compatibility only and will be removed in a future version.
`policy_number`	string		The policy number you provide on your request form will serve as the basis for the Policy Limit search. Red Folder will verify the policy status and liability coverage on the Date of Loss, ensuring it matches the claim number provided. If there is a discrepancy between the policy number and the claim number, we will use our best judgment to provide the most accurate and relevant information available.
`claim_number`	string		The claim number you provide on your request form will be used as a secondary verification for the policy number listed on the order form. If there is a discrepancy between the policy number and the claim number, we will use our best judgment to provide the most accurate and relevant information available.
`adjuster_name`	string		Please provide the name of the Adjuster assigned to the claim by the Defendant’s Insurance Company.
`adjuster_phone_number`	string		Adjuster’s phone number.
`adjuster_phone_extension`	string		Adjuster’s phone extension.
`are_policyholder_and_defendant_the_same`	boolean		If the Defendant is not the policyholder, it is crucial to know the name of the policyholder. Providing the policyholder's name improves the accuracy of the liability limit information.
`policyholder_name`	string		Positive identification of the policyholder improves the accuracy of the liability limit information. Conditional: `policyholder_name` — must be present in the payload when `are_policyholder_and_defendant_the_same` is explicitly `false`.
`policyholder_relationship`	string		What is the relationship between the Defendant and the Policyholder? Conditional: `policyholder_relationship` — must be present in the payload when `are_policyholder_and_defendant_the_same` is explicitly `false`.
`defendant_information`	object		Identifying details for the defendant (see PersonalInformation). The more identifiers provided, the higher the match accuracy.
`vehicle_information`	object		The defendant's vehicle at the time of loss (see VehicleInformation) — used to locate auto coverage.
`nature_of_the_injury`	string		Specifying the type of incident whether it's a multi-vehicle accident, single-car accident, pedestrian vs. vehicle, dog bite, assault, trip, slip, or fall will help improve the accuracy and success of the search.
`crash_report_additional_info`	string		Additional information or notes about the crash report
`requester_name`	string		Name of the person requesting this case (required when using master tokens)
`requester_phone`	string		Phone number of the person requesting this case (optional)
`files_to_upload`	array<string> enum: incident_report, insurance_letter, driver_license_or_other_id, other1, other2, other3, …		Which files do you intend to upload with this request? (note that the request is not submittable without the declared files actually being uploaded) LEGACY: only used by the deprecated 3-step flow — POST /api/v1/partner/cases/create/ ignores this field (attach files directly as files parts).
`commercial_driver_information`	object		Driver information for commercial policy limit requests (when driver differs from defendant) Conditional: `commercial_driver_information` — must not be set when NOT (`base_product[0]` starts with `commercial` OR `base_product[0]` starts with `international_commercial`).
`crash_address`	string		Street address where the crash/incident occurred.
`crash_city`	string		City where the crash/incident occurred.
`crash_state`	string		Two-letter uppercase US state code where the crash/incident occurred (e.g., 'CA', 'TX').
`crash_zip`	string		ZIP code where the crash/incident occurred.
`ml_prediction_ids`	object		Prediction IDs from ML predictor service.

PartnerCasePolicyExistence

Field	Type	Required	Description
`cc_emails`	string	required	Whitespace-delimited list of additional email addresses to CC on case correspondence. If the first entry is a valid email address, it is used as the reporting requester's email; otherwise the requester falls back to the API token/account name.
`summary`	string		Plaintiff and Case Number
`plaintiff_name`	string	required	Who is your client? Who are you representing?
`office_case_number`	string		Do you have an internal case/file number? We can include this on your request for your convenience.
`date_of_loss`	string	required	Date the incident occurred (YYYY-MM-DD). For Policy Existence cases this must be within the last 365 days — older dates are rejected with a 400. (Policy Limit cases have no such limit.)
`nature_of_the_injury`	string		Specifying the type of incident whether it's a multi-vehicle accident, single-car accident, pedestrian vs. vehicle, dog bite, assault, trip, slip, or fall will help improve the accuracy and success of the search.
`crash_report_additional_info`	string		Additional information or notes about the crash report
`is_incident_report_provided`	boolean	required	Is a police report, crash report, or exchange of information card provided? These documents are critical for liability limit research. Secondary options are 911 transcripts, police radio transcripts, or witness statements.
`is_user_agreeing_to_all_terms_and_conditions`	boolean		Is the user agreeing to all terms and conditions?
`is_black_card`	boolean		DEPRECATED: This field is now automatically determined based on your organization's Black Card status. You can still send this field for backward compatibility, but the value will be ignored. The system will automatically set the correct value based on your organization. This field will be removed in version 2.0.0.
`is_payment_via_lumen`	boolean		Are you submitting this request to be paid through Lumen Financial? (Note: Only available if your account is enrolled)
`is_test`	boolean		Is this a test submission? Test cases are automatically labeled TEST in Jira.
`base_product`	string	required	Product type for the policy existence search. Accepts either a string (deprecated) or single-element array (recommended). Example: ['commercial_auto_policy_existence']. For consistency with Policy Limit searches, array format is recommended.
`expedited_request`	string enum: one_day_rush_request, three_day_rush_request, five_day_rush_request		Add an expedition to your request.
`add_on_services`	array<string> enum: policy_number, policy_period, property_damage_limits, skip_trace, um_uim_limits, umbrella_policy_limits		Add on services to bundle with the request
`defendant_name`	string		DEPRECATED: Use defendant_information.first_name and defendant_information.last_name instead. This field is accepted for backward compatibility but is no longer used. The canonical source for defendant name data is the defendant_information nested object. This field will be removed in version 2.0.0.
`defendant_business_name`	string		The term 'Defendant' will refer to the person/company whose insurance is being searched for. Conditional: `defendant_business_name` — required when `base_product` starts with `commercial`.
`is_defendant_transportation_company`	boolean		Is the Defendant a trucking or transportation company? The Defendant in the Commercial Auto Policy Existence search must have a current USDOT number. Conditional: `is_defendant_transportation_company` — must equal `true` when `base_product` equals `commercial_auto_policy_existence`. Conditional: `is_defendant_transportation_company` — must not be set when NOT (`base_product` equals `commercial_auto_policy_existence`).
`usdot_number`	string		Defendant Business USDOT Number (fill when the defendant is a transportation company) Conditional: `usdot_number` — required when `base_product` equals `commercial_auto_policy_existence` AND `is_defendant_transportation_company` is truthy. Conditional: `usdot_number` — must match `^0[1-9][0-9]$` when `base_product` equals `commercial_auto_policy_existence`.
`insured_property_information`	object		Address of the insured property (see AddressInformation). Required for homeowners Policy Existence. Conditional: `insured_property_information` — required when `base_product` equals `personal_homeowners_policy_existence`.
`is_defendant_property_owner_and_occupant`	boolean		Does the subject OWN and OCCUPY the property? Red Folder Research is only able to process Policy Existence requests for properties that are OWNED and OCCUPIED by the Defendant. Conditional: `is_defendant_property_owner_and_occupant` — must equal `true` when `base_product` equals `personal_homeowners_policy_existence`.
`defendant_information`	object		Identifying details for the defendant (see PersonalInformation). The more identifiers provided, the higher the match accuracy.
`vehicle_information`	object		The defendant's vehicle at the time of loss (see VehicleInformation) — used to locate auto coverage.
`should_exclude_other_insurance_from_search`	boolean	required	Prior to this Policy Existence request, have you identified any insurance for the Defendant that Red Folder Research should exclude from this search?
`excluded_insurance_policy_information`	string		Insurance Company Name, Policy Number, Etc. (please include an exclusion reason) Conditional: `excluded_insurance_policy_information` — required when `should_exclude_other_insurance_from_search` is truthy.
`other_properties_owned`	string		Other Properties Owned (List each address, city, state and zip)
`vehicles_owned`	string		Vehicles Owned by Defendant (List each Year/Make/Model/VIN/License Plate)
`search_reason`	array<string> enum: no_insurance_on_report, defendant_provided_no_insurance, defendant_insurance_unknown, insurance_cancelled_pre_dol, insurance_denied_coverage, insurance_doesnt_cover_incident, …	required	What are you requesting a Policy Existence Search for? (select all that apply to your case. The following are search reasons guaranteed to be supported, with details on which documents to attach (via the `other` file category): - `no_insurance_on_report` - There is no insurance listed on the Accident/Incident report. (Report attached) - `defendant_provided_no_insurance` - The Defendant did not provide any insurance during the after-accident information exchange. - `defendant_insurance_unknown` - The Defendant’s Insurance is unknown. - `insurance_cancelled_pre_dol` - The Defendant’s insurance cancelled before the date of loss. (Attach any existing insurance letter, documents, claim denials…etc) - `insurance_denied_coverage` - The Defendant’s insurance has denied coverage. (Attach denial letter) - `insurance_doesnt_cover_incident` - The Defendant’s insurance does not provide coverage for this type of accident/incident. (Attach/include known insurance) - `incorrect_insurance_info_on_report` - The Defendant’s insurance policy number or insurance company name were incorrect on the Accident/Incident report or on the after-accident information exchange and we need Red Folder Research to find the correct policy number and/or insurance company name. (Attach report or information exchange) - `additional_at_fault_party` - Another party involved in the accident/incident was also at-fault but they are uninsured or underinsured or we need additional coverage for our client. (Attach any documentation that you may have) - `minor_at_fault` - The defendant is the parent/guardian of a minor child who is at-fault and injured our client. - `other_reason` - Provide a hand-written reason for the search (if selected, submit the `other_search_reason` field)
`other_search_reason`	string		Only submit in case `search_reason` selection was `'other_reason'`.Insert the other `search_reason` you want supplied. Conditional: `other_search_reason` — must not be set when NOT (`search_reason` contains `other_reason`).
`crash_address`	string		Street address where the crash/incident occurred.
`crash_city`	string		City where the crash/incident occurred.
`crash_state`	string		Two-letter uppercase US state code where the crash/incident occurred (e.g., 'CA', 'TX').
`crash_zip`	string		ZIP code where the crash/incident occurred.
`requester_name`	string		Name of the person requesting this case (required when using master tokens)
`requester_phone`	string		Phone number of the person requesting this case (optional)
`files_to_upload`	array<string> enum: incident_report, insurance_letter, driver_license_or_other_id, other1, other2, other3, …		Which files do you intend to upload with this request? (note that the request is not submittable without the declared files actually being uploaded) LEGACY: only used by the deprecated 3-step flow — POST /api/v1/partner/cases/create/ ignores this field (attach files directly as files parts).

AddOnServicesEnum

No properties defined.

AddressInformation

Field	Type	Required	Description
`id`	integer	required
`address`	string	required	Street address of the insured property (line 1).
`apt_or_suite_number`	string		Apartment, suite, or unit number, if applicable.
`city`	string	required	City of residence.
`state_or_province`	string	required	Two-letter US state code.
`postal_or_zip_code`	string	required	ZIP or postal code.

BaseProductEnum

No properties defined.

CaseTypeEnum

No properties defined.

ErrorCodeEnum

No properties defined.

FileUpload

Field	Type	Required	Description
`file`	string	required

FilesToUploadEnum

No properties defined.

KnoxLogin

Field	Type	Required	Description
`token_name`	string	required

LabelEnum

No properties defined.

LabelsEnum

No properties defined.

NullEnum

No properties defined.

PartnerCancelError

Field	Type	Required	Description
`error`	string	required
`detail`	string	required

PartnerCancelRequest

Field	Type	Required	Description
`reason`	string		Optional free-text cancellation reason. Stored verbatim, written to the case record, and delivered in the case.closed webhook's reason field.

PartnerCancellationAccepted

Field	Type	Required	Description
`case_ref`	string	required
`status`	string	required	Always "cancellation_accepted".
`tier`	TierEnum	required
`fee`	PartnerCancellationFee	required

PartnerCancellationBlock

Field	Type	Required	Description
`eligible`	boolean	required
`fee_usd`	string	required	Decimal string. "0.00" when free; the locked fee while a cancellation is pending or after completion; null when ineligible/closed/processing.
`reason`	ReasonEnum	required	Machine token explaining the eligibility state. * `not_yet_dispatched` - not_yet_dispatched * `dispatched_fee_applies` - dispatched_fee_applies * `research_complete` - research_complete * `case_closed` - case_closed * `cancellation_pending` - cancellation_pending * `case_processing` - case_processing

PartnerCancellationFee

Field	Type	Required	Description
`amount_usd`	string	required
`description`	string	required

PartnerCancellationResultsInfo

Field	Type	Required
`cancelled_at`	string	required
`fee_usd`	string	required
`reason`	string	required

PartnerCaseCreateAttachment

Field	Type	Required	Description
`filename`	string	required	Sanitized display filename.
`label`	string	required
`status`	PartnerCaseCreateAttachmentStatusEnum enum: accepted, rejected	required
`file_id`	string		UUID — present when status is accepted.
`error`	string		Reason for rejection — present when status is rejected.
`error_code`	ErrorCodeEnum		Stable enum — present when status is rejected. * `file_too_large` - file_too_large * `extension_not_allowed` - extension_not_allowed * `unknown_label` - unknown_label * `internal_error` - internal_error

PartnerCaseCreateAttachmentStatusEnum

No properties defined.

PartnerCaseCreateRequest

Field	Type	Required	Description
`case`	string	required	JSON-encoded case payload. Must include `case_type` (`pe` or `pl`) plus all required fields for the corresponding serializer. Field-level documentation: see the PartnerCasePolicyLimit / PartnerCasePolicyExistence schemas in the Data Dictionary (https://docs.redfolderresearch.com/data-dictionary.html).
`files`	array<string>		Up to 10 files, 25 MB each, 100 MB aggregate. Accepted file types: PDF, DOC/DOCX, XLS/XLSX, JPG/JPEG, PNG, GIF, TIFF/TIF, TXT, CSV, MSG, EML.
`labels`	array<LabelsEnum> enum: incident_report, insurance_letter, driver_license_or_other_id, other		Optional label per file (same order as `files`). Defaults to `other` when omitted.

PartnerCaseCreateResponse

Field	Type	Required	Description
`case_id`	integer	required	Internal numeric ID, immediately useful.
`case_ref`	string	required	Jira issue key (e.g., `BC-12345`). Null until Jira sync completes (~minutes).
`case_type`	CaseTypeEnum enum: pe, pl	required
`submitted`	boolean	required
`attachments`	array<PartnerCaseCreateAttachment>	required

PartnerCaseDetail

Field	Type	Required
`id`	integer	required
`issue_key`	string	required
`status`	string	required
`case_type`	string	required
`created_at`	string	required
`updated_at`	string	required
`results_ready`	boolean	required
`cancellation`	PartnerCancellationBlock	required

PartnerCaseFilesRequest

Field	Type	Required	Description
`file`	string	required	Single file (≤25 MB, allowed extensions only).
`label`	LabelEnum		Optional category label. Defaults to `other`. * `incident_report` - incident_report * `insurance_letter` - insurance_letter * `driver_license_or_other_id` - driver_license_or_other_id * `other` - other

PartnerCaseFilesResponse

Field	Type	Required	Description
`file_id`	string	required	UUID.
`filename`	string	required	Sanitized display filename.
`label`	string	required
`jira_sync_state`	string	required	Always 'pending' immediately after upload; transitions to 'synced' once the sweep task attaches the file to Jira.

PartnerCaseListItem

Field	Type	Required
`id`	integer	required
`issue_key`	string	required
`created_at`	string	required

PartnerOffer

Field	Type	Required	Description
`offer_id`	string	required
`additional_policies`	array<PartnerOfferedUpgrade>	required

PartnerOfferAcceptRequest

Field	Type	Required	Description
`offer_id`	string	required	The offer_id from the case.additional_policies_found webhook.
`selected_upgrade_ids`	array<integer>	required	The upgrade_ids the firm is accepting.

PartnerOfferedUpgrade

Field	Type	Required	Description
`upgrade_id`	integer	required
`type`	string	required
`researcher_note`	string	required
`price_usd`	string	required
`status`	PartnerOfferedUpgradeStatusEnum	required	"created" = offered, not yet accepted by the firm. "selected" = accepted. * `created` - created * `selected` - selected

PartnerOfferedUpgradeStatusEnum

No properties defined.

PartnerRespondRequest

Field	Type	Required	Description
`interaction_id`	string	required	The interaction_id from the case.action_required webhook payload.
`message`	string		Text response to the action required request. At least one of message or file must be provided.
`file`	string		File to upload in response (multipart). Multiple files can be sent in a single request.

PartnerRespondResponse

Field	Type	Required	Description
`interaction_id`	string	required
`status`	string	required	Will be 'responded' on success.
`message`	string	required	Confirmation message.

PartnerResultsData

Field	Type	Required	Description
`case_type`	string	required
`results`	array<—>	required	Primary result records. Field set follows each record's own type (Policy Limit vs Policy Existence) — see the examples for the exact shapes.
`additional_policies`	array<—>	required	Additional policies found on the case. Offered-but-not-accepted entries expose only the envelope (ids, type, teaser note) — values stay redacted until accepted; accepted entries expose the full field set.
`cancelled`	boolean	required	Present and true only for cancelled cases.
`cancellation`	PartnerCancellationResultsInfo	required

PartnerResultsJson

Field	Type	Required
`id`	integer	required
`issue_key`	string	required
`status`	string	required
`results_data`	PartnerResultsData	required
`completed_at`	string	required

PartnerResultsPdf

Field	Type	Required
`id`	integer	required
`issue_key`	string	required
`status`	string	required
`results_url`	string	required
`file_name`	string	required
`completed_at`	string	required

PartnerResultsResponse

No properties defined.

PersonalInformation

Field	Type	Required	Description
`id`	integer	required
`date_of_birth`	string		Date of birth (YYYY-MM-DD). One of the strongest identifiers for locating coverage.
`first_name`	string	required	Person's legal first name.
`middle_name`	string		Middle name or initial, if known — improves match accuracy.
`last_name`	string	required	Person's legal last name.
`phone_number`	string		Contact phone number, if known.
`phone_extension`	string		Phone extension, if applicable.
`license_number`	string		Driver's license number, if known.
`license_state`	string		Two-letter US state code that issued the license.
`address`	string	required	Street address (line 1).
`apt_or_suite_number`	string		Apartment, suite, or unit number, if applicable.
`city`	string		City of residence.
`state_or_province`	string		Two-letter US state code.
`postal_or_zip_code`	string		ZIP or postal code.

PolicyExistenceSearchTicketExpeditedRequestEnum

No properties defined.

PolicyLimitSearchTicketExpeditedRequestEnum

No properties defined.

ReasonEnum

No properties defined.

SearchReasonEnum

No properties defined.

TierEnum

No properties defined.

VehicleInformation

Field	Type	Required	Description
`id`	integer	required
`description`	string		Vehicle description (e.g., '2019 Honda Accord'). Auto-computed from year/make/model if provided.
`vehicle_year`	integer		Vehicle year (e.g., 2019)
`vehicle_make`	string		Vehicle make (e.g., 'Honda')
`vehicle_model`	string		Vehicle model (e.g., 'Accord')
`vin`	string		Vehicle Identification Number — a strong identifier for locating the policy.
`license_plate`	string		License plate, if the VIN is unknown. Include the issuing state if possible.

Legacy (sunset November 11, 2026)

The deprecated 3-step declare → upload → submit endpoints. New integrations should use the request bodies above instead — see Migrating from the Legacy Endpoints.

PolicyLimitSearchTicket

Field	Type	Required	Description
`id`	integer	required
`cc_emails`	string	required	Whitespace-delimited list of additional email addresses to CC on case correspondence. If the first entry is a valid email address, it is used as the reporting requester's email; otherwise the requester falls back to the API token/account name.
`summary`	string		Plaintiff and Case Number
`plaintiff_name`	string	required	Who is your client? Who are you representing?
`defendant_business_name`	string		The term 'Defendant' will refer to the person/company whose insurance is being searched for.
`office_case_number`	string		Do you have an internal case/file number? We can include this on your request for your convenience.
`date_of_loss`	string	required	Date the incident occurred (YYYY-MM-DD).
`is_incident_report_provided`	boolean	required	Is a police report, crash report, or exchange of information card provided? These documents are critical for liability limit research. Secondary options are 911 transcripts, police radio transcripts, or witness statements.
`is_user_agreeing_to_all_terms_and_conditions`	boolean		Is the user agreeing to all terms and conditions?
`is_black_card`	boolean		DEPRECATED: This field is now automatically determined based on your organization's Black Card status. You can still send this field for backward compatibility, but the value will be ignored. The system will automatically set the correct value based on your organization. This field will be removed in version 2.0.0.
`is_payment_via_lumen`	boolean		Are you submitting this request to be paid through Lumen Financial? (Note: Only available if your account is enrolled)
`is_test`	boolean		Is this a test submission? Test cases are automatically labeled TEST in Jira.
`base_product`	array<BaseProductEnum>	required	Products you want to use with the request (you cannot select both commercial and personal choices).
`expedited_request`	PolicyLimitSearchTicketExpeditedRequestEnum \| NullEnum		Add an expedition to your request. * `three_hour_rush_request` - three_hour_rush_request * `one_day_rush_request` - one_day_rush_request * `three_day_rush_request` - three_day_rush_request * `five_day_rush_request` - five_day_rush_request
`add_on_services`	array<AddOnServicesEnum> enum: policy_number, policy_period, property_damage_limits, skip_trace, um_uim_limits, umbrella_policy_limits		Add on services to bundle with the request
`insurance_company`	string	required	Insurance company to search for. You can provide either: - A known company name (e.g., 'Farmers', 'Mercury', 'AAA') - A custom company name (e.g., 'HNS IV: Third Party Recovery') Known companies: 21st Century, AAA (Except Southern California), AAA Southern California, Bristol West, Coast National, Farmers, Foremost, Mercury, Orion, Toggle, Worksmens. Disclaimer: We do not accept requests for USAA, American National, Go Insurance, Federated Insurance, Security National Insurance, or Wawanesa. Note: A $75 addon fee will be charged for specialty companies (AAA Except Southern California, Bristol West, Coast National, Farmers, Foremost, Mercury, 21st Century, Orion, Worksmens, Toggle).
`insurance_company_name`	string		DEPRECATED: Use 'insurance_company' field instead. This field is maintained for backward compatibility only and will be removed in a future version.
`policy_number`	string		The policy number you provide on your request form will serve as the basis for the Policy Limit search. Red Folder will verify the policy status and liability coverage on the Date of Loss, ensuring it matches the claim number provided. If there is a discrepancy between the policy number and the claim number, we will use our best judgment to provide the most accurate and relevant information available.
`claim_number`	string		The claim number you provide on your request form will be used as a secondary verification for the policy number listed on the order form. If there is a discrepancy between the policy number and the claim number, we will use our best judgment to provide the most accurate and relevant information available.
`adjuster_name`	string		Please provide the name of the Adjuster assigned to the claim by the Defendant’s Insurance Company.
`adjuster_phone_number`	string		Adjuster’s phone number.
`adjuster_phone_extension`	string		Adjuster’s phone extension.
`are_policyholder_and_defendant_the_same`	boolean		If the Defendant is not the policyholder, it is crucial to know the name of the policyholder. Providing the policyholder's name improves the accuracy of the liability limit information.
`policyholder_name`	string		Positive identification of the policyholder improves the accuracy of the liability limit information.
`policyholder_relationship`	string		What is the relationship between the Defendant and the Policyholder?
`defendant_information`	PersonalInformation		Identifying details for the defendant (see PersonalInformation). The more identifiers provided, the higher the match accuracy.
`vehicle_information`	VehicleInformation		The defendant's vehicle at the time of loss (see VehicleInformation) — used to locate auto coverage.
`nature_of_the_injury`	string		Specifying the type of incident whether it's a multi-vehicle accident, single-car accident, pedestrian vs. vehicle, dog bite, assault, trip, slip, or fall will help improve the accuracy and success of the search.
`crash_report_additional_info`	string		Additional information or notes about the crash report
`owner`	string	required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`created_at`	string	required
`updated_at`	string	required
`jira_url`	string	required
`creating_token_name`	string	required
`requester_name`	string		Name of the person requesting this case (required when using master tokens)
`requester_phone`	string		Phone number of the person requesting this case (optional)
`files_to_upload`	array<FilesToUploadEnum>		Which files do you intend to upload with this request? (note that the request is not submittable without the declared files actually being uploaded) LEGACY: only used by the deprecated 3-step flow — POST /api/v1/partner/cases/create/ ignores this field (attach files directly as files parts).
`commercial_driver_information`	PersonalInformation		Driver information for commercial policy limit requests (when driver differs from defendant)
`crash_address`	string		Street address where the crash/incident occurred.
`crash_city`	string		City where the crash/incident occurred.
`crash_state`	string \| string		Two-letter uppercase US state code where the crash/incident occurred (e.g., 'CA', 'TX').
`crash_zip`	string		ZIP code where the crash/incident occurred.
`ml_prediction_ids`	object		Prediction IDs from ML predictor service.

PolicyExistenceSearchTicket

Field	Type	Required	Description
`id`	integer	required
`cc_emails`	string	required	Whitespace-delimited list of additional email addresses to CC on case correspondence. If the first entry is a valid email address, it is used as the reporting requester's email; otherwise the requester falls back to the API token/account name.
`summary`	string		Plaintiff and Case Number
`plaintiff_name`	string	required	Who is your client? Who are you representing?
`office_case_number`	string		Do you have an internal case/file number? We can include this on your request for your convenience.
`date_of_loss`	string	required	Date the incident occurred (YYYY-MM-DD). For Policy Existence cases this must be within the last 365 days — older dates are rejected with a 400. (Policy Limit cases have no such limit.)
`nature_of_the_injury`	string		Specifying the type of incident whether it's a multi-vehicle accident, single-car accident, pedestrian vs. vehicle, dog bite, assault, trip, slip, or fall will help improve the accuracy and success of the search.
`crash_report_additional_info`	string		Additional information or notes about the crash report
`is_incident_report_provided`	boolean	required	Is a police report, crash report, or exchange of information card provided? These documents are critical for liability limit research. Secondary options are 911 transcripts, police radio transcripts, or witness statements.
`is_user_agreeing_to_all_terms_and_conditions`	boolean		Is the user agreeing to all terms and conditions?
`is_black_card`	boolean		DEPRECATED: This field is now automatically determined based on your organization's Black Card status. You can still send this field for backward compatibility, but the value will be ignored. The system will automatically set the correct value based on your organization. This field will be removed in version 2.0.0.
`is_payment_via_lumen`	boolean		Are you submitting this request to be paid through Lumen Financial? (Note: Only available if your account is enrolled)
`is_test`	boolean		Is this a test submission? Test cases are automatically labeled TEST in Jira.
`base_product`	string	required	Product type for the policy existence search. Accepts either a string (deprecated) or single-element array (recommended). Example: ['commercial_auto_policy_existence']. For consistency with Policy Limit searches, array format is recommended.
`expedited_request`	PolicyExistenceSearchTicketExpeditedRequestEnum \| NullEnum		Add an expedition to your request. * `one_day_rush_request` - one_day_rush_request * `three_day_rush_request` - three_day_rush_request * `five_day_rush_request` - five_day_rush_request
`add_on_services`	array<AddOnServicesEnum> enum: policy_number, policy_period, property_damage_limits, skip_trace, um_uim_limits, umbrella_policy_limits		Add on services to bundle with the request
`defendant_name`	string		DEPRECATED: Use defendant_information.first_name and defendant_information.last_name instead. This field is accepted for backward compatibility but is no longer used. The canonical source for defendant name data is the defendant_information nested object. This field will be removed in version 2.0.0.
`defendant_business_name`	string		The term 'Defendant' will refer to the person/company whose insurance is being searched for.
`is_defendant_transportation_company`	boolean		Is the Defendant a trucking or transportation company? The Defendant in the Commercial Auto Policy Existence search must have a current USDOT number.
`usdot_number`	string		Defendant Business USDOT Number (fill when the defendant is a transportation company)
`insured_property_information`	AddressInformation		Address of the insured property (see AddressInformation). Required for homeowners Policy Existence.
`is_defendant_property_owner_and_occupant`	boolean		Does the subject OWN and OCCUPY the property? Red Folder Research is only able to process Policy Existence requests for properties that are OWNED and OCCUPIED by the Defendant.
`defendant_information`	PersonalInformation		Identifying details for the defendant (see PersonalInformation). The more identifiers provided, the higher the match accuracy.
`vehicle_information`	VehicleInformation		The defendant's vehicle at the time of loss (see VehicleInformation) — used to locate auto coverage.
`should_exclude_other_insurance_from_search`	boolean	required	Prior to this Policy Existence request, have you identified any insurance for the Defendant that Red Folder Research should exclude from this search?
`excluded_insurance_policy_information`	string		Insurance Company Name, Policy Number, Etc. (please include an exclusion reason)
`other_properties_owned`	string		Other Properties Owned (List each address, city, state and zip)
`vehicles_owned`	string		Vehicles Owned by Defendant (List each Year/Make/Model/VIN/License Plate)
`search_reason`	array<SearchReasonEnum> enum: no_insurance_on_report, defendant_provided_no_insurance, defendant_insurance_unknown, insurance_cancelled_pre_dol, insurance_denied_coverage, insurance_doesnt_cover_incident, …	required	What are you requesting a Policy Existence Search for? (select all that apply to your case. The following are search reasons guaranteed to be supported, with details on which documents to attach (via the `other` file category): - `no_insurance_on_report` - There is no insurance listed on the Accident/Incident report. (Report attached) - `defendant_provided_no_insurance` - The Defendant did not provide any insurance during the after-accident information exchange. - `defendant_insurance_unknown` - The Defendant’s Insurance is unknown. - `insurance_cancelled_pre_dol` - The Defendant’s insurance cancelled before the date of loss. (Attach any existing insurance letter, documents, claim denials…etc) - `insurance_denied_coverage` - The Defendant’s insurance has denied coverage. (Attach denial letter) - `insurance_doesnt_cover_incident` - The Defendant’s insurance does not provide coverage for this type of accident/incident. (Attach/include known insurance) - `incorrect_insurance_info_on_report` - The Defendant’s insurance policy number or insurance company name were incorrect on the Accident/Incident report or on the after-accident information exchange and we need Red Folder Research to find the correct policy number and/or insurance company name. (Attach report or information exchange) - `additional_at_fault_party` - Another party involved in the accident/incident was also at-fault but they are uninsured or underinsured or we need additional coverage for our client. (Attach any documentation that you may have) - `minor_at_fault` - The defendant is the parent/guardian of a minor child who is at-fault and injured our client. - `other_reason` - Provide a hand-written reason for the search (if selected, submit the `other_search_reason` field)
`other_search_reason`	string		Only submit in case `search_reason` selection was `'other_reason'`.Insert the other `search_reason` you want supplied.
`crash_address`	string		Street address where the crash/incident occurred.
`crash_city`	string		City where the crash/incident occurred.
`crash_state`	string \| string		Two-letter uppercase US state code where the crash/incident occurred (e.g., 'CA', 'TX').
`crash_zip`	string		ZIP code where the crash/incident occurred.
`owner`	string	required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`created_at`	string	required
`updated_at`	string	required
`creating_token_name`	string	required
`requester_name`	string		Name of the person requesting this case (required when using master tokens)
`requester_phone`	string		Phone number of the person requesting this case (optional)
`jira_url`	string	required
`files_to_upload`	array<FilesToUploadEnum>		Which files do you intend to upload with this request? (note that the request is not submittable without the declared files actually being uploaded) LEGACY: only used by the deprecated 3-step flow — POST /api/v1/partner/cases/create/ ignores this field (attach files directly as files parts).