Submission object

id

Integer

Unique identifier representing the form submission.

employee_id

Integer

The ID of the staff member who completed the submission.

status

String

The status of the form submission (pending, accepted, rejected).

document_name

String

The name of the form this submission corresponds with.

tags

Array of Strings

A set of user-defined tags on this submission, applied by admins.

audit_logs

Array of Audit Logs

A list of countersigning events for I-9 Remote Verification submissions. Note: All forms have this category, only the I-9 uses it. See the

Audit Log object

for more information.

document_id

Integer

The ID of the form this submission corresponds with.

submitted_at

String (format:

ISO 8601

)

Timestamp of when the submission was received.

auth_rep_rejected

Boolean

Did the auth rep reject this submission?

rejection_reason

String

If status is 'rejected', and the reason is given, it is provided here.

status_changed_by

String

Name of individual who accepted or rejected the form.

status_changed_at

String (format:

ISO 8601

)

Timestamp of when submission was accepted or rejected.

is_current_submission_of_assignment

Boolean

Is this the most current submission for the assignment?

uploaded_by_full_name

String

The name of the user who uploaded the submission.

countersignable

Boolean

Is the submission ready to be countersigned?

countersigned

Boolean

Is this submission countersigned? i.e. Section 2 of I-9.

confirmed_at_ok

String

Timestamp of when the staff member reviewed an uploaded submission.

files

Array of Strings

URLs to obtain all PDF and image files associated with this submission.

fields

Array of Fields OR Object

Form-I9: Object with attributes, see below. Everything else: Array of field objects (custom and/or standard).

document_verification_result

String

The status of the document verification (approved, completed, declined, or failed).

document_verification_resolution

Array of Audit Logs

A list of events for I-9 document verification acted upon by the administrator.

ead_country_code

String

2-3 code representing the country associated with an EAD.

ead_category

String

The specific classification or type of Employment Authorization Document (EAD) granted to an individual.

fields.first_name

String

Legal first name.

fields.middle_initial

String

Legal middle initial.

fields.last_name

String

Legal last name.

fields.street

String

Street address.

fields.apt

String

Apartment.

fields.city

String

City.

fields.state

String

State abbreviation (e.g. CO).

fields.zip

String

Zip code.

fields.ssn

String (format: 000-00-0000)

US-based social security number.

fields.email

String

Email address.

fields.phone

String

Free format primary phone number.

fields.birthdate

String (format: YYYY-MM-DD)

Birthdate.

fields.other_names

String

Any other names used. "N/A" if none.

fields.citizenship_designation

String

Citizenship (citizen, noncitizen_national, permanent_resident, alien). Note: Alien corresponds to Noncitizen Authorized to Work

fields.alien_exp_date

String (format: YYYY-MM-DD) OR "N/A"

Expiration date of employment authorization.

fields.employee_sign_date

String (format: YYYY-MM-DD)

Signature date.

fields.employee_start_date

String (format: YYYY-MM-DD)

Employee start date; Present after certification.

fields.employer_certify_date

String (format: YYYY-MM-DD)

Employer certification date; Present after certification.

fields.employer_title

String

Title of countersigning employer; Present after certification.

fields.employer_first_name

String

First name of countersigning employer; Present after certification.

fields.employer_last_name

String

Last name of countersigning employer; Present after certification.

fields.business_name

String

Business name; Present after certification.

fields.business_street

String

Business street address; Present after certification.

fields.business_city

String

Business city; Present after certification.

fields.business_state

String

Business state abbreviation (e.g. CO); Present after certification.

fields.business_zip

String

Business zip code; Present after certification.

fields.late_reason

String

Only exists if the certification took place over three days after the start date; Present after certification if applicable.

fields.late_reason_other

String

Corresponding explanation if user selects "other" from the dropdown menu for late_reason; Present after certification if applicable.

fields.used_alt_procedure

Boolean

Did the employee use a USCIS Alternative Procedure to verify the I-9 documentation? Present after certification.

documentation_set[].list_key

String (A, B, or C)

List the document is included in as part of official "List of Acceptable Documents"

documentation_set[].list_index

String

Index of document in official "List of Acceptable Document"

documentation_set[].documentation_key

String

Unique name of document for verification purposes- not displayed to user.

documentation_set[].document_number

String

Document Number (e.g. Driver's License Number, Passport Number, etc.)

documentation_set[].document_title

String

Document Title (e.g. U.S. Passport).

documentation_set[].issuing_authority

String

Issuing Authority (e.g. U.S. Department of State).

documentation_set[].expiration_date

String (format: YYYY-MM-DD) OR "N/A" OR "D/S"

Expiration Date.

documentation_set[].receipt

Boolean

Is this a receipt of the document instead of the document itself?

documentation_set[].file_front_url

String

Path to document front image file.

documentation_set[].file_front_content_type

String

Content type of document front image file.

documentation_set[].file_front_filename

String

Filename of document front image file.

documentation_set[].file_back_url

String

Path to document back image file.

documentation_set[].file_back_content_type

String

Content type of document back image file.

documentation_set[].file_back_filename

String

Filename of document back image file.

reverification_rehire.submitted_at

String (format:

ISO 8601

)

Timestamp of submission by auth rep or employer.

reverification_rehire.date

• String_ (format: YYYY-MM-DD)

Date of submission by auth rep or employer.

reverification_rehire.rehire_date

String

Date of rehire.

reverification_rehire.new_last_name

String

Employee's updated last name, if applicable.

reverification_rehire.new_first_name

String

Employee's updated first name, if applicable.

reverification_rehire.new_middle_initial

String

Employee's updated middle initial, if applicable.

reverification_rehire.reverify_document_title

String

Title of submitted document.

reverification_rehire.reverify_document_number

String

Number of submitted document.

reverification_rehire.reverify_expiration_date

String (format: YYYY-MM-DD) OR "N/A" OR "D/S"

Expiration date of submitted document.

reverification_rehire.reverify_used_alt_procedure

Boolean

Did the user use an alternative procedure for reverify?

reverification_rehire.employer_or_authrep_name

String

Name of employer or auth rep.

reverification_rehire.additional_info

String

Other information provided upon submission.