Add an E-Verify Record

post

https://api.avionte.com/front-office/v1/talent/{talentId}/everify

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.

Path Params

talentId

string

required

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

Body Params

applicantId

int32

The identifier for the talent.

caseNumber

string

length ≤ 20

The number of the E-Verify case.

submittedDate

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.

caseStatus

enum

Information about the case status.

isClosed

boolean

An indication of whether the case is closed or not.

isAuthorized

boolean

An indication of whether the case is authorized or not.

everifyURL

string

length ≤ 250

The URL to the E-Verify case.

source

string

length ≤ 250

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

caseSubmittedByUser

int32

The identifier for the user who submitted the case.

applicantTaskId

int32

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

lastEventDateTimeUtc

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.

Headers

RequestId

uuid

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

FrontOfficeTenantId

integer

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

Tenant

string

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

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

201The created E-Verify record.

400Bad Request

404Not found