Talent

Add an E-Verify Record

Adds information about the talent’s E-Verify record. The information about the record is displayed in the Personal Information section of the Tax tab of the talent’s profile page.

post/v1/talent/{talentId}/everify

Request

Base URL
https://api.avionte.com/front-office
URL
https://api.avionte.com/front-office/v1/talent/{talentId}/everify
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

talentIdstring required

The identifier for the talent whose E-Verify case should be added.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

applicantIdinteger

The identifier for the talent.

caseNumberstring

The number of the E-Verify case.

submittedDatestring date-time

The date the case was submitted. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

The everify statuses available for selection.

isClosedboolean

An indication of whether the case is closed or not.

isAuthorizedboolean

An indication of whether the case is authorized or not.

everifyURLstring

The URL to the E-Verify case.

sourcestring

The company or service that is handling the E-Verify case.

caseSubmittedByUserinteger

The identifier for the user who submitted the case.

applicantTaskIdinteger

The identifier for the talent onboarding task related to the E-Verify case.

lastEventDateTimeUtcstring date-time

The event UTC timestamp passed in by the partner, in the format "yyyy-MM-ddTHH:mm:ssZ". For example, 2024-12-01T14:30:00Z.

Example request

{
  "applicantId": 19485,
  "caseNumber": "2024179171735HB",
  "isClosed": true,
  "isAuthorized": true,
  "source": "Equifax",
  "caseSubmittedByUser": 13899,
  "applicantTaskId": 27852,
  "lastEventDateTimeUtc": "2024-12-01T14:30:00Z"
}

Response

The created E-Verify record.