Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Update an E-Verify Record

Updates information about the E-Verify record of the specified talent.

put/v1/talent/{talentId}/everify/{caseNumber}

Path parameters

talentIdstring required

The identifier for the talent whose E-Verify case is being retrieved.

caseNumberstring required

The case number of the E-Verify record to update.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

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.

caseStatus'Draft' | 'UnconfirmedData' | 'Photo' | 'ScanAndUpload' | 'ManualReview' | 'PendingReferral' | 'Referred' | 'Queued' | 'EmploymentAuthorized' | 'FinalNonConfirmation' | 'CloseCaseAndResubmit' | 'Closed' | 'UnableToProcess'

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 updated E-Verify record.

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.

caseStatus'Draft' | 'UnconfirmedData' | 'Photo' | 'ScanAndUpload' | 'ManualReview' | 'PendingReferral' | 'Referred' | 'Queued' | 'EmploymentAuthorized' | 'FinalNonConfirmation' | 'CloseCaseAndResubmit' | 'Closed' | 'UnableToProcess'

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 response

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