HireRight Rest Connect API

https://stage-developer.hireright.com/api-details
Admin
HireRight Rest Connect API is a RESTful API for initiating and managing background checks and I-9...
Tokens:8,277
Snippets:32
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Create I-9 Request Structure Example (JSON)

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

This JSON structure outlines the required fields for creating an I-9 request. It includes top-level fields like 'fallbackModel', 'remoteOrder', 'flexFields', 'candidate', 'legalRequirements', and 'statusUpdateUrls'. Nested objects provide detailed information for each section.

```json
{
    "fallbackModel": "string",
    "remoteOrder": false,
    "flexFields": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "candidate": {
        "candidateProfile": {
            "personalData": {
                "biologicalDescriptors": {
                    "dateOfBirth": "string"
                }
            },
            "i9Details": {
                "citizenship": {
                    "status": "string",
                    "number": "string"
                },
                "contactMethod": {
                    "email": "test@hireright.com"
                },
                "legalRequirements": {
                    "i9OrderCertification": "We certify that the named individual has been made and accepted a job offer."
                }
            }
        }
    }
}
```

--------------------------------

### Create I-9 Response Example (JSON)

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

This JSON object represents a successful response when creating an I-9 form. It includes the unique ID, current status, and a direct link (href) to the I-9 form, along with a boolean indicating if it's a duplicate and a list of related links for further actions.

```json
{
    "id": "FRM-123456-ABCDEF",
    "status": "Sent to Employee",
    "href": "https://test-ows01.hireright.com/ofin.html?key=9AE7B20790A937194E8D7283FE19B664",
    "isDuplicate": false,
    "links": [{
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K",
        "rel": "I-9 form",
        "type": "GET"
    }, {
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/employee",
        "rel": "I-9 form link for employee",
        "type": "GET"
    }, {
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/employer",
        "rel": "I-9 form link for employer",
        "type": "GET"
    }, {
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/weblink",
        "rel": "I-9 form link",
        "type": "GET"
    }, {
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/status",
        "rel": "I-9 form status",
        "type": "GET"
    }, {
        "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/documents",
        "rel": "I-9 form supporting documentation",
        "type": "GET"
    }]
}
```

--------------------------------

### CreateI9Request_Resume

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents resume information, including hiring manager details.

```APIDOC
## CreateI9Request_Resume

### Description
This object contains information related to a resume, including details about the hiring manager.

### Parameters
#### Request Body
- **hiringManager** (CreateI9Request_HiringManager) - Optional - Information about the hiring manager.
```

--------------------------------

### CreateI9Request_SupportingDocumentation

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Details supporting documentation for the I-9 form, including foreign passports, visas, and other documents.

```APIDOC
## CreateI9Request_SupportingDocumentation

### Description
This object specifies the supporting documentation provided for the I-9 form.

### Parameters
#### Request Body
- **foreignPassport** (CreateI9Request_ForeignPassport) - Optional - Details of a foreign passport.
- **visa** (CreateI9Request_Visa) - Optional - Details of a visa.
- **document** (CreateI9Request_Document[]) - Optional - An array of other supporting documents.
- **studentVisa** (CreateI9Request_StudentVisa) - Optional - Details of a student visa.
```

--------------------------------

### Default HireRight API JSON Configuration

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

This JSON object represents the default configuration for a HireRight API request. It includes settings for employee invitations, remote order status, flexible fields, and detailed candidate information such as personal data, contact methods, legal identifiers, and I-9 documentation.

```json
{
    "fallbackModel": "InviteEmployee",
    "remoteOrder": false,
    "flexFields": [{
        "name": "Department",
        "value": "Department1"
    }, {
        "name": "CostCenter",
        "value": "CostCenter1"
    }, {
        "name": "RequisitionNumber",
        "value": "RequisitionNumber1"
    }],
    "candidate": {
        "candidateProfile": {
            "personalData": {
                "personName": {
                    "givenName": "fname",
                    "middleName": "m",
                    "familyName": [{
                        "value": "lname"
                    }, {
                        "primary": false,
                        "value": "maiden"
                    }]
                },
                "contactMethod": {
                    "email": "test@hireright.ee",
                    "phone": "5555555555",
                    "mobile": "4152221789",
                    "postalAddress": {
                        "countryCode": "US",
                        "postalCode": "123456",
                        "region": "CA",
                        "municipality": "Los Angeles",
                        "unit": "123",
                        "deliveryAddresses": [{
                            "addressLine": "Street Address"
                        }]
                    }
                },
                "personDescriptors": {
                    "legalIdentifiers": {
                        "personLegalId": {
                            "countryCode": "US",
                            "documentType": "SSN",
                            "value": "111-11-1111"
                        }
                    },
                    "biologicalDescriptors": {
                        "dateOfBirth": "1980-10-20"
                    }
                }
            },
            "i9Details": {
                "citizenship": {
                    "status": "AUTHORIZED_ALIEN",
                    "number": {
                        "type": "alien",
                        "value": "123456"
                    }
                },
                "supportingDocumentation": {
                    "foreignPassport": {
                        "number": "123456789",
                        "issuingAuthority": {
                            "countryCode": "BR"
                        }
                    },
                    "visa": {
                        "number": "321"
                    },
                    "document": [{
                        "title": "FSM or RMI Passport with I-94 Stamp",
                        "number": "C123123",
                        "issuingAuthority": {
                            "countryCode": "AR",
                            "name": "Mr X"
                        },
                        "dateExpired": "2099-02-22",
                        "stamp": {
                            "number": "123",
                            "dateExpired": "2099-02-22"
                        }
                    }, {
                        "title": "Native American tribal document",
                        "number": "B123123",
                        "issuingAuthority": {
                            "name": "Alabama Department of Motor Vehicles"
                        },
                        "dateExpired": "2099-02-22"
                    }, {
                        "title": "U.S. social security card issued by the SSA",
                        "number": "C123123",
                        "issuingAuthority": {
                            "name": "Alabama Department of Motor Vehicles"
                        },
                        "dateExpired": "2099-02-22"
                    }],
                    "studentVisa": {
                        "formType": "I-20",
                        "type": "J-1",
                        "number": "123",
                        "dateExpired": "2099-01-30"
                    }
                },
                "dateHired": "2010-01-30",
                "lateReason": {
                    "code": "LATE_HIRE_DT_RSN_OTHER",
                    "description": "Some text, applicable for LATE_HIRE_DT_RSN_OTHER only"
                },
                "preparer": {
                    "personName": {
                        "givenName": "John",
                        "familyName": "Preparer"
                    },
                    "postalAddress": {
                        "countryCode": "US",
                        "postalCode": "12345",
                        "region": "CA",
                        "municipality": "San Diego",
                        "deliveryAddresses": [{
                            "addressLine": "Street Address"
                        }]
                    }
                }
            }
        },
        "resume": {
            "hiringManager": {
                "givenName": "Hiring",
                "familyName": "Manager"
            }
        }
    }
}
```

--------------------------------

### POST /connect/I-9

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Creates a new I-9 form for a candidate. It accepts detailed information about the candidate, their documentation, and legal requirements.

```APIDOC
## POST /connect/I-9

### Description
Creates a new I-9 form for a candidate. It accepts detailed information about the candidate, their documentation, and legal requirements.

### Method
POST

### Endpoint
/connect/I-9

### Parameters
#### Request Body
- **fallbackModel** (string) - Optional - Description
- **remoteOrder** (boolean) - Optional - Description
- **flexFields** (CreateI9Request_FlexFields[]) - Optional - Description
- **candidate** (CreateI9Request_Candidate) - Optional - Description
- **legalRequirements** (CreateI9Request_LegalRequirements) - Optional - Description
- **statusUpdateUrls** (string[]) - Optional - Description

### Request Example
```json
{
    "candidate": {
        "candidateProfile": {
            "personalData": {
                "givenName": "John",
                "familyName": {
                    "value": "Doe",
                    "primary": true
                },
                "contactMethod": {
                    "email": "test@hireright.com"
                }
            },
            "i9Details": {
                "citizenship": {
                    "status": "US Citizen"
                }
            }
        }
    },
    "legalRequirements": {
        "i9OrderCertification": "We certify that the named individual has been made and accepted a job offer."
    }
}
```

### Response
#### Success Response (201 Created)
Created - The created I-9's ID, status and href.
- **id** (string) - Description
- **status** (string) - Description
- **href** (string) - Description
- **isDuplicate** (boolean) - Description
- **links** (Link[]) - Description

#### Response Example
```json
{
    "id": "FRM-123456-ABCDEF",
    "status": "Sent to Employee",
    "href": "https://test-ows01.hireright.com/ofin.html?key=9AE7B20790A937194E8D7283FE19B664",
    "isDuplicate": false,
    "links": [
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K",
            "rel": "I-9 form",
            "type": "GET"
        },
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/employee",
            "rel": "I-9 form link for employee",
            "type": "GET"
        },
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/employer",
            "rel": "I-9 form link for employer",
            "type": "GET"
        },
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/weblink",
            "rel": "I-9 form link",
            "type": "GET"
        },
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/status",
            "rel": "I-9 form status",
            "type": "GET"
        },
        {
            "href": "https://stage-apis.hireright.com/connect/I-9/HE-060820-ZG55K/documents",
            "rel": "I-9 form supporting documentation",
            "type": "GET"
        }
    ]
}
```

#### Error Response (401 Unauthorized)
Unauthorized - The client is unauthorized to make this request.

### Definitions
#### CreateI9Request
- **fallbackModel** (string) - Optional - Description
- **remoteOrder** (boolean) - Optional - Description
- **flexFields** (CreateI9Request_FlexFields[]) - Optional - Description
- **candidate** (CreateI9Request_Candidate) - Optional - Description
- **legalRequirements** (CreateI9Request_LegalRequirements) - Optional - Description
- **statusUpdateUrls** (string[]) - Optional - Description

#### CreateI9Request_Candidate
- **candidateProfile** (CreateI9Request_CandidateProfile) - Optional - Description
- **resume** (CreateI9Request_Resume) - Optional - Description

#### CreateI9Request_CandidateProfile
- **personalData** (CreateI9Request_PersonalData) - Optional - Description
- **i9Details** (CreateI9Request_I9Details) - Optional - Description

#### CreateI9Request_Citizenship
- **status** (string) - Optional - Description
- **number** (CreateI9Request_Number) - Optional - Description

#### CreateI9Request_ContactMethod
- **email** (string) - Optional - Description
- **phone** (string) - Optional - Description
- **mobile** (string) - Optional - Description
- **postalAddress** (CreateI9Request_PostalAddress) - Optional - Description

#### CreateI9Request_DeliveryAddresses
- **addressLine** (string) - Optional - Description

#### CreateI9Request_DeliveryAddresses1
- **addressLine** (string) - Optional - Description

#### CreateI9Request_Document
- **title** (string) - Optional - Description
- **number** (string) - Optional - Description
- **issuingAuthority** (CreateI9Request_IssuingAuthority1) - Optional - Description
- **dateExpired** (string) - Optional - Description
- **stamp** (CreateI9Request_Stamp) - Optional - Description

#### CreateI9Request_FamilyName
- **primary** (boolean) - Optional - Description
- **value** (string) - Optional - Description

#### CreateI9Request_FlexFields
- **name** (string) - Optional - Description
- **value** (string) - Optional - Description

#### CreateI9Request_ForeignPassport
- **number** (string) - Optional - Description
- **issuingAuthority** (CreateI9Request_IssuingAuthority) - Optional - Description

#### CreateI9Request_HiringManager
- **givenName** (string) - Optional - Description
- **familyName** (string) - Optional - Description
- **email** (string) - Optional - Description

#### CreateI9Request_I9Details
- **citizenship** (CreateI9Request_Citizenship) - Optional - Description
- **lateReason** (CreateI9Request_LateReason) - Optional - Description
- **biologicalDescriptors** (CreateI9Request_BiologicalDescriptors) - Optional - Description
- **visa** (CreateI9Request_Visa) - Optional - Description
- **studentVisa** (CreateI9Request_StudentVisa) - Optional - Description

#### CreateI9Request_IssuingAuthority
- **name** (string) - Optional - Description
- **country** (string) - Optional - Description

#### CreateI9Request_IssuingAuthority1
- **name** (string) - Optional - Description
- **country** (string) - Optional - Description

#### CreateI9Request_IssuingAuthority2
- **name** (string) - Optional - Description
- **country** (string) - Optional - Description

#### CreateI9Request_IssuingAuthority3
- **name** (string) - Optional - Description
- **country** (string) - Optional - Description

#### CreateI9Request_LateReason
- **reason** (string) - Optional - Description
- **explanation** (string) - Optional - Description

#### CreateI9Request_LegalIdentifiers
- **type** (string) - Optional - Description
- **value** (string) - Optional - Description

#### CreateI9Request_LegalRequirements
- **i9OrderCertification** (string) - Optional - Description

#### CreateI9Request_Number
- **value** (string) - Optional - Description

#### CreateI9Request_PersonDescriptors
- **givenName** (string) - Optional - Description
- **middleName** (string) - Optional - Description
- **familyName** (CreateI9Request_FamilyName) - Optional - Description

#### CreateI9Request_PersonLegalId
- **type** (string) - Optional - Description
- **value** (string) - Optional - Description

#### CreateI9Request_PersonName
- **givenName** (string) - Optional - Description
- **familyName** (string) - Optional - Description

#### CreateI9Request_PersonName1
- **givenName** (string) - Optional - Description
- **familyName** (string) - Optional - Description

#### CreateI9Request_PersonalData
- **givenName** (string) - Optional - Description
- **familyName** (CreateI9Request_FamilyName) - Optional - Description
- **contactMethod** (CreateI9Request_ContactMethod) - Optional - Description
- **deliveryAddresses** (CreateI9Request_DeliveryAddresses) - Optional - Description
- **deliveryAddresses1** (CreateI9Request_DeliveryAddresses1) - Optional - Description

#### CreateI9Request_PostalAddress
- **addressLine1** (string) - Optional - Description
- **addressLine2** (string) - Optional - Description
- **city** (string) - Optional - Description
- **state** (string) - Optional - Description
- **postalCode** (string) - Optional - Description
- **country** (string) - Optional - Description

#### CreateI9Request_Preparer
- **givenName** (string) - Optional - Description
- **familyName** (string) - Optional - Description
- **company** (string) - Optional - Description
- **address** (string) - Optional - Description
- **city** (string) - Optional - Description
- **state** (string) - Optional - Description
- **postalCode** (string) - Optional - Description

#### CreateI9Request_Resume
- **fileName** (string) - Optional - Description
- **fileContent** (string) - Optional - Description

#### CreateI9Request_Stamp
- **date** (string) - Optional - Description

#### CreateI9Request_StudentVisa
- **number** (string) - Optional - Description
- **issuingAuthority** (CreateI9Request_IssuingAuthority2) - Optional - Description
- **dateExpired** (string) - Optional - Description

#### CreateI9Request_SupportingDocumentation
- **document** (CreateI9Request_Document) - Optional - Description

#### CreateI9Request_Visa
- **number** (string) - Optional - Description
- **issuingAuthority** (CreateI9Request_IssuingAuthority3) - Optional - Description
- **dateExpired** (string) - Optional - Description

#### CreateI9Response
- **id** (string) - Description
- **status** (string) - Description
- **href** (string) - Description
- **isDuplicate** (boolean) - Description
- **links** (Link[]) - Description

#### Link
- **href** (string) - Description
- **rel** (string) - Description
- **type** (string) - Description
```

--------------------------------

### CreateI9Response

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Response object for creating an I-9 request, including links, ID, status, and duplication information.

```APIDOC
## CreateI9Response

### Description
This object represents the response received after creating an I-9 request.

### Parameters
#### Success Response (200)
- **links** (Link[]) - Optional - An array of links related to the created resource.
- **id** (string) - Optional - The unique identifier for the created I-9 request.
- **status** (string) - Optional - The current status of the I-9 request.
- **href** (string) - Optional - A direct link (URL) to the created I-9 request.
- **isDuplicate** (boolean) - Optional - Indicates if the created request is a duplicate of an existing one.
```

--------------------------------

### CreateI9Request_LegalRequirements

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Specifies legal requirements related to the I-9 process.

```APIDOC
## CreateI9Request_LegalRequirements

### Description
This object outlines specific legal requirements for the I-9 process.

### Parameters
#### Request Body
- **i9OrderCertification** (string) - Optional - Information regarding the I-9 order certification.
```

--------------------------------

### CreateI9Request_PersonalData

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Contains personal data for an individual, including name, contact, and descriptors.

```APIDOC
## CreateI9Request_PersonalData

### Description
This object holds comprehensive personal data for an individual.

### Parameters
#### Request Body
- **personName** (CreateI9Request_PersonName) - Optional - The full name of the person.
- **contactMethod** (CreateI9Request_ContactMethod) - Optional - Preferred method of contact.
- **personDescriptors** (CreateI9Request_PersonDescriptors) - Optional - Various descriptors for the person.
```

--------------------------------

### CreateI9Request_I9Details

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Defines the structure for I-9 details, including citizenship, supporting documentation, dates, late reasons, and preparer information.

```APIDOC
## CreateI9Request_I9Details

### Description
This object represents the details required for an I-9 form submission.

### Parameters
#### Request Body
- **citizenship** (CreateI9Request_Citizenship) - Optional - Details about the applicant's citizenship.
- **supportingDocumentation** (CreateI9Request_SupportingDocumentation) - Optional - Information about supporting documents provided.
- **dateHired** (string) - Optional - The date the applicant was hired.
- **dateTerminated** (string) - Optional - The date the applicant's employment was terminated.
- **lateReason** (CreateI9Request_LateReason) - Optional - Reason for any late submission of the I-9 form.
- **preparer** (CreateI9Request_Preparer) - Optional - Information about the preparer of the I-9 form.
```

--------------------------------

### CreateI9Request_Preparer

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Information about the preparer of the I-9 form, including their name and address.

```APIDOC
## CreateI9Request_Preparer

### Description
This object contains information about the individual who prepared the I-9 form.

### Parameters
#### Request Body
- **personName** (CreateI9Request_PersonName1) - Optional - The name of the preparer.
- **postalAddress** (CreateI9Request_PostalAddress1) - Optional - The postal address of the preparer.
```

--------------------------------

### CreateI9Request_StudentVisa

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Information specific to a student visa, including form type, number, and issuing authority.

```APIDOC
## CreateI9Request_StudentVisa

### Description
This object contains details specific to a student visa.

### Parameters
#### Request Body
- **formType** (string) - Optional - The type of student visa form.
- **type** (string) - Optional - The general type of visa.
- **number** (string) - Optional - The visa number.
- **issuingAuthority** (CreateI9Request_IssuingAuthority3) - Optional - The authority that issued the visa.
- **dateExpired** (string) - Optional - The expiration date of the visa.
```

--------------------------------

### Link

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a link, typically used for related resources or actions.

```APIDOC
## Link

### Description
This object represents a hyperlink, often used to reference related resources or actions.

### Parameters
#### Request Body
- **href** (string) - Optional - The URL of the link.
- **rel** (string) - Optional - The relationship of the link to the current resource (e.g., 'self', 'next').
- **type** (string) - Optional - The media type of the linked resource.
```

--------------------------------

### CreateI9Request_PersonName1

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a person's name, including given and family names.

```APIDOC
## CreateI9Request_PersonName1

### Description
This object captures a person's name, consisting of given and family name components.

### Parameters
#### Request Body
- **givenName** (string) - Optional - The first name of the person.
- **familyName** (string) - Optional - The last name of the person.
```

--------------------------------

### CreateI9Request_PersonName

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a person's full name, including given, middle, and family names.

```APIDOC
## CreateI9Request_PersonName

### Description
This object captures a person's full name, including given, middle, and family name components.

### Parameters
#### Request Body
- **givenName** (string) - Optional - The first name of the person.
- **middleName** (string) - Optional - The middle name(s) of the person.
- **familyName** (CreateI9Request_FamilyName[]) - Optional - An array of family names for the person.
```

--------------------------------

### CreateI9Request_LegalIdentifiers

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Contains legal identifiers for a person.

```APIDOC
## CreateI9Request_LegalIdentifiers

### Description
This object holds various legal identifiers associated with an individual.

### Parameters
#### Request Body
- **personLegalId** (CreateI9Request_PersonLegalId) - Optional - The primary legal identifier for the person.
```

--------------------------------

### CreateI9Request_LateReason

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Details the reason for a late submission of the I-9 form.

```APIDOC
## CreateI9Request_LateReason

### Description
This object provides details about the reason for a late I-9 submission.

### Parameters
#### Request Body
- **code** (string) - Optional - A code representing the reason for lateness.
- **description** (string) - Optional - A description of the reason for lateness.
```

--------------------------------

### CreateI9Request_Visa

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents visa information, primarily the visa number.

```APIDOC
## CreateI9Request_Visa

### Description
This object holds information about a visa, specifically its number.

### Parameters
#### Request Body
- **number** (string) - Optional - The visa number.
```

--------------------------------

### CreateI9Request_PersonDescriptors

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Holds descriptors for a person, including legal and biological information.

```APIDOC
## CreateI9Request_PersonDescriptors

### Description
This object contains various descriptors for a person, encompassing legal and biological attributes.

### Parameters
#### Request Body
- **legalIdentifiers** (CreateI9Request_LegalIdentifiers) - Optional - Legal identification details for the person.
- **biologicalDescriptors** (CreateI9Request_BiologicalDescriptors) - Optional - Biological attributes of the person.
```

--------------------------------

### Create I-9

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Creates a new I-9 request. This endpoint returns an I-9 Form ID required for subsequent API calls related to I-9 forms. It supports different employee and I-9 workflows.

```APIDOC
## POST /connect/I-9

### Description
Creates a new I-9 request and returns the associated I-9 Form ID to be used in subsequent API calls. This ID is crucial for accessing Section 1, Section 2, and the completed I-9 form.

**Rate Limit**: 100 requests per minute.

**Employee Workflows**: 
* **InviteEmployee** (Default): Employee receives an email from HireRight to access Section 1.
* **Employee**: No email sent; a separate API call is needed to get a URL for the employee to access Section 1 from the customer's system.

**I-9 Workflows**: 
* **Traditional I-9** (`remoteOrder: false`): Section 2 completed by the customer's Section 2 signer. Requires Employee First Name, Employee Last Name, Employee Email.
* **Remote I-9** (`remoteOrder: true`): Section 2 completed by a 3rd party vendor. Requires Employee First Name, Employee Last Name, Employee Email, Employee Phone Number, Employee Start Date (at least 5 business days from current date), and Legal Certification Text ("We certify that the named individual has been made and accepted a job offer.").

### Method
POST

### Endpoint
https://stage-apis.hireright.com/connect/I-9

### Parameters
#### Request Headers
- **hr-api-subscription-key** (string) - Required - Unique API subscription key.
- **hr-api-version** (string) - Required - Unique API version identifier.
- **hr-domain-id** (string) - Required - Unique API integration domain identifier.
- **hr-company-login** (string) - Required - Unique identifier for the client's company.
- **hr-user-ref-id** (string) - Required - Unique identifier of the user in the client's system.

#### Request Body
**Content-Type**: application/json

**Schema**: `CreateI9Request`

- **fallbackModel** (string) - Optional - Specifies the employee workflow ('InviteEmployee' or 'Employee').
- **remoteOrder** (boolean) - Optional - Specifies the I-9 workflow ('false' for Traditional, 'true' for Remote).
- **flexFields** (array) - Optional - Array of `CreateI9Request_FlexFields` objects.
- **candidate** (object) - Optional - `CreateI9Request_Candidate` object containing candidate details.
- **legalRequirements** (object) - Optional - `CreateI9Request_LegalRequirements` object.
- **statusUpdateUrls** (array) - Optional - Array of strings representing status update URLs.

### Request Example
```json
{
  "fallbackModel": "InviteEmployee",
  "remoteOrder": false,
  "candidate": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  },
  "legalRequirements": {
    "legalCertificationText": "We certify that the named individual has been made and accepted a job offer."
  }
}
```

### Response
#### Success Response (200)
- **i9FormId** (string) - The unique identifier for the created I-9 form.

#### Response Example
```json
{
  "i9FormId": "123e4567-e89b-12d3-a456-426614174000"
}
```
```

--------------------------------

### CreateI9Request_IssuingAuthority2

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents an issuing authority with just a name.

```APIDOC
## CreateI9Request_IssuingAuthority2

### Description
This object specifies an issuing authority by its name.

### Parameters
#### Request Body
- **name** (string) - Optional - The name of the issuing authority.
```

--------------------------------

### CreateI9Request_IssuingAuthority3

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents an issuing authority with just a name.

```APIDOC
## CreateI9Request_IssuingAuthority3

### Description
This object specifies an issuing authority by its name.

### Parameters
#### Request Body
- **name** (string) - Optional - The name of the issuing authority.
```

--------------------------------

### CreateI9Request_PostalAddress

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a postal address with country, postal code, region, municipality, and delivery addresses.

```APIDOC
## CreateI9Request_PostalAddress

### Description
This object defines a postal address, including location details and delivery information.

### Parameters
#### Request Body
- **countryCode** (string) - Optional - The country code of the address.
- **postalCode** (string) - Optional - The postal code of the address.
- **region** (string) - Optional - The region or state of the address.
- **municipality** (string) - Optional - The municipality or city of the address.
- **unit** (string) - Optional - The unit or apartment number.
- **deliveryAddresses** (CreateI9Request_DeliveryAddresses[]) - Optional - An array of delivery address details.
```

--------------------------------

### CreateI9Request_Number

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a numbered item, such as a document number.

```APIDOC
## CreateI9Request_Number

### Description
This object represents a numerical identifier, like a document or form number.

### Parameters
#### Request Body
- **type** (string) - Optional - The type of number (e.g., 'document_number').
- **value** (string) - Optional - The actual number value.
```

--------------------------------

### CreateI9Request_PostalAddress1

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents a postal address with country, postal code, region, and municipality.

```APIDOC
## CreateI9Request_PostalAddress1

### Description
This object defines a postal address, including location details.

### Parameters
#### Request Body
- **countryCode** (string) - Optional - The country code of the address.
- **postalCode** (string) - Optional - The postal code of the address.
- **region** (string) - Optional - The region or state of the address.
- **municipality** (string) - Optional - The municipality or city of the address.
- **deliveryAddresses** (CreateI9Request_DeliveryAddresses1[]) - Optional - An array of delivery address details.
```

--------------------------------

### CreateI9Request_IssuingAuthority1

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents an issuing authority with country code, region, and name.

```APIDOC
## CreateI9Request_IssuingAuthority1

### Description
This object specifies an issuing authority, including its country, region, and name.

### Parameters
#### Request Body
- **countryCode** (string) - Optional - The country code of the issuing authority.
- **region** (string) - Optional - The region of the issuing authority.
- **name** (string) - Optional - The name of the issuing authority.
```

--------------------------------

### CreateI9Request_PersonLegalId

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Details a person's legal identification document.

```APIDOC
## CreateI9Request_PersonLegalId

### Description
This object represents a specific legal identification document for an individual.

### Parameters
#### Request Body
- **countryCode** (string) - Optional - The country code where the document was issued.
- **documentType** (string) - Optional - The type of legal document (e.g., 'passport', 'driver_license').
- **value** (string) - Optional - The unique identifier value of the document.
```

--------------------------------

### CreateI9Request_IssuingAuthority

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Represents an issuing authority, primarily used for country codes.

```APIDOC
## CreateI9Request_IssuingAuthority

### Description
This object specifies an issuing authority, typically used for identification documents.

### Parameters
#### Request Body
- **countryCode** (string) - Optional - The country code of the issuing authority.
```

--------------------------------

### CreateI9Request_Stamp

Source: https://stage-developer.hireright.com/api-details#api=rest-connect

Details a stamp, including issuing authority, number, and expiration date.

```APIDOC
## CreateI9Request_Stamp

### Description
This object represents a stamp, potentially from an issuing authority, with associated number and expiration date.

### Parameters
#### Request Body
- **issuingAuthority** (CreateI9Request_IssuingAuthority2) - Optional - The authority that issued the stamp.
- **number** (string) - Optional - The number associated with the stamp.
- **dateExpired** (string) - Optional - The expiration date of the stamp.
```
Tokens:
Raw