Skip to main content

Bulk Upload Template and Overview of Required Fields

Download the official Bulk Upload template and learn which fields are required, their expected formats, and best practices.

D
Written by Dima Kovalev

Bulk Upload Template

Scroll to the bottom of this article and click on the file to download.

Fields names are not case sensitive.

Overview of Accepted Fields

Required Fields

System Field Name

Expected Format

Definition

Additional Information

firm_billing_number

Text

Internal billing reference (Matter Number)

Billing number must match the PDF file name

servee_name

Text

Full name of the individual, registered agent, or business being served

Required for job submission

documents_name

Text

Name your PDF document

Please name your documents exactly as you want them to appear on the affidavit

job_type

Text

Type of job being uploaded

Must be an allowed value. See list at bottom of this table*

court_state

State abbreviation

State where the documents originated (where the case was filed)

Please use a state abbreviation only (e.g., TX or CA)

plaintiffs

Text

Plaintiffs as listed on your documents

For property management, list the HOA or management company

defendants

Text

Full name, business name, or list of defendants

For property management, list the occupant(s)

address_1_type

Text

Allowed values: HOME, BUSINESS, REGISTERED_AGENT, ENTITY, OTHER

Select one. Required for job submission

address_1_street

Text

Street address for primary job address

Important: Exclude apartment, unit, etc.

address_1_city

Text

City name for primary job address

address_1_state

Text

State name or abbreviation for primary job address

address_1_zip

Text

Zip code for primary job address

serve_speed

Text

Allowed values: STANDARD, EXPEDITED, SAME_DAY, GARNISHMENT, 2 DAY POST, HYBRID

Required for job submission. See Pricing or contact Customer Experience at support@proofserve.com for questions.

* Allowed job types: Civil, Evictions, Pre-Evictions, Garnishment (Bank), Garnishment (Employer), Garnishment (Consumer), Testimony Subpoena, Document Subpoena, Commercial Debt Collection, Consumer Debt Collection, Divorce, Foreclosure, Protective Orders, Mechanics Lien, Asset Seizure, Criminal, Other, Bankruptcy, Probate, Administrative, Family.

Optional Fields — Servee Info

System Field Name

Expected Format

Definition

Additional Information

SERVEE_IS_ENTITY

Numeric (0, 1)

Indicate if servee is an entity

1 for YES, 0 for NO

SERVEE_DOB

date

Servee's DOB

Must be MM/DD/YYYY, cannot be a future date

SERVEE_REGISTERED_AGENT_NAME

Text

Name of registered agent

Required for entity serves

Optional Fields — Addresses

Address 1

System Field Name

Expected Format

Definition

Additional Information

address_1_business_name

Text

Business name if address is a business

Recommended to encourage service attempts during business hours

address_1_suite

Text

Apartment, Unit, etc., for primary serve address

Important: Add unit details here for proper address verification

Address 2 (backup address)

System Field Name

Expected Format

Definition

Additional Information

address_2_type

Text

Allowed values: HOME, BUSINESS, REGISTERED_AGENT, ENTITY, OTHER

Select one. Required for job submission if including a backup address

address_2_business_name

Text

Business name if address is a business

Recommended to encourage service attempts during business hours

address_2_street

Text

Street address for backup serve address

Important: Exclude apartment, unit, etc.

address_2_suite

Text

Apartment, Unit, etc., for backup serve address

Important: Add unit details here for proper address verification

address_2_city

Text

City name for backup serve address

address_2_state

Text

State name or abbreviation for backup serve address

address_2_zip

Text

Zip code for backup serve address

Optional Fields — Court Info

System Field Name

Expected Format

Definition

Additional Information

court_token

Text

Proof court reference id

e.g. CRT-ZPNVTD7
If provided, court_name, court_type, court_county and court_address fields are ignored/not required.

court_name

Text

Full name of the court where documents originated or must be filed

If applicable

court_type

Text

Type of court where documents originated or must be filed

e.g., Judicial, County, District

court_county

Text

County where the documents originated or must be filed

e.g. El Paso County, Miami-Dade County

court_address

Text

Full address of the court (street address, city, state, zip)

If applicable.

court_address_street

Text

Street address of the court

Not required, but if used, this will concatenate into the court_address.

court_address_city

Text

City of the court

Not required, but if used, this will concatenate into the court_address.

court_address_zip

Text

Zip code of the court

Not required, but if used, this will concatenate into the court_address.

case_number

Text

Case number assigned by the court

Required if requesting affidavit or motion filing and Proof is not filing the suit

court_date

Text

Court date assigned by the court

If applicable

Optional Fields — Filing

System Field Name

Expected Format

Definition

Additional Information

file_case

Numeric (0, 1)

Indicate if the case should be filed. *

0 = No, 1 = Yes (defaults to 0)

file_affidavit

Numeric (0, 1)

Indicate if the affidavit should be filed. *

0 = No, 1 = Yes (defaults to 0)

file_motion_alt_service

Numeric (0, 1)

Indicate if a motion for alternate service must be filed. *

0 = No, 1 = Yes (defaults to 0)

file_motion_alt_service_document

Text

Exact name of the file that will be uploaded to file as a request for alternative service.

Must be different from billing number.

ATTORNEY_NAME

Text

Name of the attorney on the case

ATTORNEY_BAR_NUMBER

Text

Bar number of the attorney on the case

*Filing is only available in select jurisdictions, and requires prior setup. Please contact Proof Customer Experience or your Account Manager for setup if you have not filed with us before.

Optional Fields — Serve options

System Field Name

Expected Format

Definition

Additional Information

same_address_index

Text

Include the billing number of the same-address job to link to

The primary address must match exactly for same-address jobs

authorize_skiptrace

Numeric (0, 1)

Enable skip trace for address verification

subpoena

Numeric (0, 1)

Indicate if the serve includes a subpoena

1 for YES, 0 for NO

protective_order

Numeric (0, 1)

Indicate if the serve includes a protective order or temporary restraining order

1 for YES, 0 for NO

witness_fee

Numeric

Dollar amount for the witness fee check

Enter amount over 1 or enter "Calculate it for me"

disclosure_fee

Numeric

Dollar amount for the disclosure fee check

Can only be added to GARNISHMENT job type

force_certify

Numeric (0, 1)

Override state rules to issue a certified affidavit instead of notarized

1 for YES, 0 for NO

notes

Text

Additional serve details for the server (Servee age or best time to find the servee at home)

Do not use this field for serve or affidavit requirements

special_req

Numeric (0, 1, 2)

This field allows you to override or manually set your special requirements. Enter the ID of each special requirement separated by a comma to set specific non-default requirements in this field.

56, 246, 32 (defaults to 0)

Optional Fields — Mailing

Mailing is typically added to a serve automatically by the Proof system when it is required by the serve's jurisdiction or if you have a pre-configured mailing rule set up with us (contact your Account Manager to set this up). Mailing can also be added on a serve ad-hoc using the following fields.

System Field Name

Expected Format

Definition

Additional Information

mailing_1_trigger*

Text

Allowed values: CLOSEOUT_ANY, CLOSEOUT_SUCCESS, CLOSEOUT_FAILURE, SERVICE_OUTCOME

Defines what should trigger the mailing. If based on service outcome, mailing_1_so_trigger_1_is_successful or mailing_1_so_trigger_1_service_type must also be populated

mailing_1_so_trigger_1_is_successful **

numeric (0 or 1)

0 for no

1 for yes

Defines whether to mail if service is successful

mailing_1_so_trigger_1_service_type **

Text

Allowed values: REGISTERED_AGENT, PERSONAL, RESIDENTIAL_SUB, WORK_SUB, REFUSAL, POSTING, OTHER, UNSUCCESSFUL, JAIL

service outcome that should trigger mailing. Optional, only used if mailing trigger is "SERVICE_OUTCOME"

mailing_1_tier*

Text

Allowed values: FIRST_CLASS, CERTIFIED

Enter “FIRST_CLASS” for first class mail and “CERTIFIED” for certified mail.

mailing_1_type*

Text

Allowed values: SERVER, AUTOMATED

Enter who should handle the mailing.

mailing_1_recipient_name*

Text

name of mailing recipient (only populate if mailing to a custom address, otherwise, mailing address will default to the active address on the serve)

mailing_1_address_1*

Text

Only populate if mailing to a custom address, otherwise, mailing address will default to the active address on the serve

mailing_1_address_2*

Text

Only populate if mailing to a custom address, otherwise, mailing address will default to the active address on the serve

mailing_1_city*

Text

Only populate if mailing to a custom address, otherwise, mailing address will default to the active address on the serve

mailing_1_state_id*

numeric

Reach out to support for state id mappings.

mailing_1_zip*

numeric

Only populate if mailing to a custom address, otherwise, mailing address will default to the active address on the serve

*Multiple mailings can be added on a serve at creation, use mailing fields and increment the number for each mailing field to enter the details of subsequent mailings.

**Multiple triggers can be added on a mailing, increment the number on the "mailing_1_so_trigger_1_service_type" field to enter the additional triggers.

Download the Bulk Upload template here 👇

Did this answer your question?