An object that represents an Employee's form submission.
The following attributes are present for all form submissions:
Attributes | Type | Description |
---|---|---|
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. |
files | Array of Fields OR Object | Form-I9: Object with attributes, see below. Everything else: Array of field objects (custom and/or standard). |
The following attributes are only present for Form-I9 submissions (in addition to those listed above):
Attributes | Type | Description |
---|---|---|
fields | Object | Fields object below. |
documentation_set | Object | Documentation Set object below. |
is_expired | Boolean | Is this Form-I9 expired? |
missing_start_date | Boolean | Is this employee missing their start date? |
is_reverified | Boolean | Is this submission remote verified? |
reverify_exists | Boolean | Has this employee ever been reverified? |
reverify_in_progress | Boolean | Has a remote verification for this submission been started? |
documentation_expiration_date | String (format: YYYY-MM-DD ) | Expiration date for the next expiring eligible document that will need to be updated. |
preparer_translator | Object | Preparer translator object below, if applicable. |
reverification_rehire | Object | Reverification object below, if applicable. |
Fields of the Form-I9
Attributes | Type | Description |
---|---|---|
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.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 object. Details the documentation provided by an employee in an I-9.
Attributes | Type | Description |
---|---|---|
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: MM/DD/YYYY ) | 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 object: Information about an employee's reverification.
Attributes | Type | Description |
---|---|---|
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) | 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. |
Preparer translator object. Information about the given preparer or translator for an employees I-9.
Attributes | Type | Description |
---|---|---|
preparer_translator.submitted_at | String (format: ISO 8601 ) | Timestamp of when the preparer/translator signed the I-9. |
preparer_translator.date | String (format: YYYY-MM-DD ) | Date the preparer/translator signed the I-9. |
preparer_translator.last_name | String | Preparer/translator's last name. |
preparer_translator.first_name | String | Preparer/translator's first name. |
preparer_translator.middle_initial | String | Preparer/translator's middle initial. |
preparer_translator.address | String | Preparer/translator's street address. |
preparer_translator.city | String | Preparer/translator's city. |
preparer_translator.state | String | Preparer/translator's state abbreviation (e.g. CO). |
preparer_translator.zip | String | Preparer/translator's zip code. |