interface control agreement - e-verifyssareferralrespduedate – this field contains an estimated...

Interface Control Agreement

Between

Customer Processing System (CPS)

E-Verify Web Service Access Method

and

Employers and E-Verify Employer Agents

FINAL

Version 28.2

for

VIS Release 16.0.0.0

Mar 9, 2017

ITDL NUMBER: 180893

Task Number – T0002AJM036

Contract Number – GS00T99ALD0203

A Deliverable to the U.S. Department of Homeland Security (DHS)

Employment Eligibility Verification (E-Verify) Program

ICA for E-Verify Web Service Access Method i ITDL – 180893

Interface Control Agreement (ICA) for

E-Verify Web Service Access Method Version 28

Submitted for: Verification Information System (VIS) Rel. 16.0.0.0 02/22/2015

System/Program or Project and Release No. Date

Submitted by: _______Elaine Anderson______ 02/22/2015

Project Manager Date

Endorsed by: ____________________________________ ______________

Systems Assurance or other USCIS OIT Authority Date

Approved by: ____________________________________ ______________

Head of Component Date

(Headquarters Activity Authority)

(For Level 1 and 2)

Approved by: ____________________________________ ______________

Deputy Secretary DHS Date



ICA for E-Verify Web Service Access Method ii ITDL – 180893

REVISION HISTORY

Version Date Name of

Author

Summary of

Changes Detail of Changes

V15 11/9/2007 Hugh W. New

Methods and

Response

Objects

EmpInitBPVerif – This method replaces the EmpInitAndAdditVerif

method for BP type users.

EmpInitVerifResp – This is the response object for the

EmpInitBPVerif method.

EmpInitDABPVerif – This method replaces the

EmpInitAndAdditVerif method for DABP type users.

EmpInitVerifResp – This is the new response object for the

EmpInitBPVerif and EmpInitDABPVerif methods.

EmpGetNextResolvedCaseNbrs – This method replaces the

EmpGetNextSecUnseenCaseNbr and

EmpGetNextThirdUnseenCaseNbr methods. It is used to retrieve the

case number(s) of SSA Referral, DHS Secondary (2nd

step) and DHS

Referral (3rd

Step) responses. This method can return one or all of the

case numbers and response codes for cases with outstanding responses.

It also allows for the automatic deletion of response queue entries. If

this option is not used EmpAckReceiptOfResolvedCaseNbr must be

called for each case number returned.

EmpGetNextResolvedCaseNbrsResp – This is the new response object

for the EmpGetNextResolvedCaseNbrs method.

EmpAckReceiptOfResolvedCaseNbr – This method replaces the

EmpAckReceiptOfSecResolution and

EmpAckReceiptOfThirdResolution methods. It is used to delete case

response queue entries for all response types (SSA Referral, DHS

Secondary and DHS Referral). This method must be called for each

case number returned from EmpGetNextResolvedCaseNbrs (if delete

option is not used). If the response queue entries are not deleted the

next call to EmpGetNextResolvedCaseNbrs will produce the same

results as the previous call.

EmpAckReceiptOfResolvedCaseNbrResp – This is the new response

object for the EmpAckReceiptOfResolvedCaseNbr method.

EmpGetCaseDetails – This new method is used to retrieve all of the

current data pertaining to a specified case.

EmpGetCaseDetailResp – This is the new response object for the

EmpGetCaseDetails method.

V15 11/9/2007 Hugh W. Methods

Removed

EmpInitAndAdditVerif – This method has been replaced by the

EmpInitBPVerif and EmpInitDABPVerif methods.

EmpGetNextSecUnseenCaseNbr – This method has been replaced by

the EmpGetNextResolvedCaseNbrs method.

EmpGetNextThirdUnseenCaseNbr – This method has been replaced by


EmpAckReceiptOfSecResolution – This method has been replaced by

the EmpAckReceiptOfResolvedCaseNbr method.

EmpAckReceiptOfThirdResolution – This method has been replaced

by the EmpAckReceiptOfResolvedCaseNbr method.

EmpRetrieveDHSAddiiRes – This method has been replaced by the

EmpGetNextResolvedCaseNbrs method.



ICA for E-Verify Web Service Access Method iii ITDL – 180893


Author

Summary of


EmpRetrieveDHSReferralRes – This V15method has been replaced by


V15 11/9/2007 Hugh W. Misc New parameters for the EmpInitBPVerif and EmpInitDABPVerif

methods include: CardNbr (always null for this version),

PassPortNumber, and VisaNumber. The input DocType parameter is

now a DocID parameter (see Appendix D.)

New output fields for the EmpInitVerifResp object include:

PhotoIncluded and Photo (neither field is used in this version).

New “name” business rule: Names are allowed to have spaces and

single quotes in them.

V16 4/10/2008 Hugh W. Business

Value

Changes

This version of the ICA supports new E-Verify SSA Referral business

processes concerning potentially naturalized citizens. The new

business process allows potentially naturalized citizens to follow up

with DHS instead of SSA as detailed in the SSA Referral Letter. As

such, a new SSA Referral letter is included in this ICA that must be

provided to those individuals who the system identifies as potentially

naturalized. The new SSA Referral letters (English and Spanish) for

potentially naturalized employees is included in the appendix. Note the

existing SSA Referral letters still must be used for all other (not

potentially naturalized) referrals.

V16 4/10/2008 Hugh W. New

Methods and

Response

Objects

None

V16 4/10/2008 Hugh W. Update

Methods and

Response

Objects

EmpInitVerfResp – This response object has been updated to return an

additional value (PotentialNaturalizedInd) indicating that the individual

being verified is a potential naturalized citizen.

EmpGtCseDetailsResp – This response object has been updated to

return two additional values:

PotentialNaturalizedInd – This field indicates that the individual being

verified is a potential naturalized citizen.

SsaReferralRespDueDate – This field contains an estimated date for an

SSA referral response.

V16 4/10/2008 Hugh W. Methods

Removed

Methods Removed and Response Objects .

V16 4/10/2008 Hugh W. Other

Changes

SSA Referral Response Codes – Added new response code to indicate

when an SSA Referral has been initially worked by a DHS

Immigration Status Verifier (ISV), but the ISV cannot make a

determination and must refer the employee to the Social Security

Administration (SSA).

Appendix E: SSA Notice To Employee Of Tentative Nonconfirmation

(Spanish) – Content of this notice has changed.

Appendix H: DHS Notice To Employee Of Tentative Nonconfirmation

(Spanish) – Content of this notice has changed.

V17 8/29/2008 Hugh W. New

Methods and

Response

*Note – The Department of Homeland Security has identified

reforming the current law on employment eligibility verification as one

of its top priorities for 2008. As a result, USCIS expects to publish in



ICA for E-Verify Web Service Access Method iv ITDL – 180893


Author

Summary of


Objects late Spring an Interim Final Rule (IFR) that aims to streamline the

employment verification process by eliminating documents (from the

Form I-9) currently in use that lack adequate security features. In order

to support this document reduction, E-Verify will need to be modified

to support a lesser number of evidentiary documents, while also

updating the terminology for some existing documents.

The exact date for implementation of the IFR is still unknown; the

enhancement changes to support this project will be developed as a

‘switch’ in order to turn on these enhancements when the rule goes into

effect.

The following methods have been added to support the above

requirement: EmpGetCitizenshipStatusCodes,

EmpGetAvailableDocumentTypes, and EmpGetAllDataFields. These

methods must be used in your application to retrieve the citizenship

types and document types configured for your user. You must not

“hard-code” citizenship and document types in your application

because they are subject to change.

EmpGetCitizenshipStatusCodes – This new method returns all

citizenship codes and descriptions associated with the user’s Web

service logon account.

EmpGetCitizenshipStatusCodesResp – This is the new response object

for the EmpGetCitizenshipStatusCodes method.

EmpGetAvailableDocumentTypes – This new method returns all

document types for a citizenship code. Also, if the citizenship code is

not specified all document type are returned.

EmpGetAvailableDocumentTypesResp – This is the new response

object for the EmpGetAvailableDocumentTypes method.

EmpGetAllDataFields – This new method returns all the required fields

associated with all citizenship codes and all document Ids.

EmpGetAllDataFieldsResp – This is the new response object for the

EmpGetAllDataFields method.

EmpGtCseDetailsResp7 – This is the new response object for the

EmpGetCaseDetails method. The InsReferoContactDHSByDt date

field has been added to this response object. This date indicates when

an “SSA Referred” employee should contact SSA before the case is

marked as “No Show”.

V17 8/29/2008 Hugh W. Other

Changes

New Password Rules – See SetUserPassword method description for

new password rules.

Future DHS Document Types – Added a new table that identifies the

document code that are valid with the new I9 form. The table also

indicates the required and valid fields for each of the document types.

V18 10/14/2008 Hugh W. Process

Change

The HireDate field in the EmpInitBpVerif and EmpInitDABPVerif

methods currently allow a minimum date of 11/01/1997. Once the

Federal Acquisition Regulation(FAR) update has been activated on the

E-Verify system the minimum HireDate will be 11/07/1986. The FAR

update will require all Federal Contractors to participate in the E-

Verify Program. All Web service users will be sent an Email notice

when FAR is activated for E-Verify.

Changed the HireDate definition in section 3.4.1 EmpInitBPVerif to



ICA for E-Verify Web Service Access Method v ITDL – 180893


Author

Summary of


reflect the FAR process change.

Changed the HireDate definition in section 3.4.2 EmpInitDABPVerif

to reflect the FAR process change.

V18 Hugh W. Added Error

Code

Added a new error code definition (-1124) to the B-1 Return Status

Codes table.

V18 Hugh W. Process

Change

A set of enhancements was added to the system to provide the ablity

for both the SSA and DHS staff to access unreferred E-Verify cases

(cases which the employer failed to refer to SSA or DHS) during the

case resolution process. This means that Web service users may receive

SSA and DHS case responses from the EmpGetNextResolvedCaseNbrs

method that were not previously referred. To avoid this, always refer

your employees before sending them to SSA or DHS.

Added this notice to section 3.4.4 EmpGetNextResolvedCaseNbrs.

V18 Hugh W. ICA Change Removed all SSA and DHS Tentative NonConfirmation and Referral

letters (APPENDIX D,E,F,G,H,I, and J). All of the letters have been

moved to a zip file (WebServiceLetters.zip) and will be sent along with

the ICA word document to new users.

V19 05/04/2009 Hugh W. New

response

object

(EmpInitVer

fResp9)

The EmpInitVerfResp response object for the EmpInitBPVerif and

EmpDABPVerif methods has been replaced with the

EmpInitVerfResp9 response object.

The PotentialnaturalizedInd field has been replaced with the

LetterTypeCode output field.

This field describes the type of SSA letter (if any) that should be

presented to the employee based on the results of the initial

verification.

SSA_TNC - SSA TENTATIVE NONCONFIRMATION LETTER

SSA_REF – SSA REFERRAL LETTER

SSA_NATZ_REF – SSA POTENTIALLY NATURALIZED CITIZEN

REFERRAL LETTER

DHS_JBL_REF – JOBBLOCK DHS REFERRAL LETTER

(Additional letters may be added at a later time)

V19 Hugh W. New

response

object

(EmpGtCse

DetailsResp9

)

The EmpGtCseDetailsResp7 response object for the

EmpGetCaseDetails method has been replaced with the

EmpGtCseDetailsResp9 response object.

The PotentialnaturalizedInd field has been replaced with the

LetterTypeCode output field.

This field describes the type of SSA or DHS letter (if any) that should

be presented to the employee based on the results of the current

operation (initial verification, SSA referral, secondary verification, or

DHS referral).




REFERRAL LETTER

DHS_TNC – DHS TENTATIVE NONCONFIRMATION LETTER

DHS_REF – DHS REFERRAL LETTER



ICA for E-Verify Web Service Access Method vi ITDL – 180893


Author

Summary of




V19 Hugh W. New

response

object

(EmpGetNex

tResolvedCa

seNbrsResp9

)

The EmpGetNextResolvedCaseNbrsResp response object for the

EmpGetNextResolvedCaseNbrs method has been replaced with the

EmpGetNextResolvedCaseNbrsResp9 response object.

A LetterTypeCode output field has been added to the CaseArray object

in the EmpGetNextResolvedCaseNbrsResp9 response.

This field describes the type of DHS letter (if any) that should be

presented to the employee based on the results of the current operation

(secondary verification, or DHS referral).





V19 Hugh W. New

response

object

(EmpSubmit

SSAReferral

Resp9)

The EmpSubmitSSAReferralResp response object for the

EmpSubSSAReferral method has been replaced with the

EmpSubmitSSAReferralResp9 response object.

A LetterTypeCode output field has been added to this object.

This field describes the type of SSA letter (if any) that should be


(initial verification, SSA referral).




REFERRAL LETTER


V19 Hugh W. New

response

object

(EmpSubmit

DHSReferral

Resp9)

The EmpSubmitDHSReferralResp7 response object for the

EmpSubDHSReferral method has been replaced with the

EmpSubmitDHSReferralResp9 response object.

A LetterTypeCode output field has been added to this object.

This field describes the type of DHS letter (if any) that should be


( secondary verification, or DHS referral).





V19 Hugh W. New Web

service test

and

production

URLs

The new URL for the test (stage) system is:

https://stage.e-

verify.uscis.gov/WebService/EmployerWebServiceV19.asmx

V19 Hugh W. New

response

code (38)

* CPS Code 38 (DHS TENTATIVE NONCONFIRMATION) is new

with V19. If you receive this code you will bypass the second-step

process and go to the third-step process.

https://stage.e-verify.uscis.gov/WebService/EmployerWebServiceV19.asmx




ICA for E-Verify Web Service Access Method vii ITDL – 180893


Author

Summary of


being

returned

from the

EmpInitBPV

erif method.

This has

been

documented

in table B-3

Example:

- Issue initial verification

-Receive a Response Code of 38

-Present employee with the DHS TNC letter

-If employee chooses to contest, issue a DHS Referral

-Present employee with appropriate DHS Referral letter (you can

determine the appropriate letter by using the LetterTypeCode field in

the DHS Referral response

V19 Hugh W. Documentati

on – Table

B-7C

LetterTypeC

ode Mapping

table added

This table was added to provide a mapping between

“LetterTypeCodes” – TNC and Referral Letters and the PDF files

containing the letters.

V20 Hugh W. Added new

method –

(EmpConfir

mPhoto)

This method is used to confirm or reject a photo returned from an

initial verification.


method –

(EmpSSARe

Verify)

This method is used to resend SSA required data for reverification.


method –

(EmpDHSRe

Verify)

This method is used to resend DHS required data for reverification.


response

object –

(EmpConfir

mPhotoResp

)

This response object returns the status of a EmpConfirmPhoto method

call plus an eligibility code.

V20 Hugh W. Modified

existing

method –

(EmpSubDH

SReferral)

Added an input parameter for uploading and employee’s document.


existing

response

object –

(EmpSSARe

sumittalResp

20)

A photo field was added to this response object.


existing

response

A photo field was added to this response object.



ICA for E-Verify Web Service Access Method viii ITDL – 180893


Author

Summary of


object –

(EmpGtCse

DetailsResp9

)


existing

response

object –

(EmpInitVer

fResp9)

The existing photo field was activated.

V20 Hugh W. Modified the

LetterTypeC

odes

Some of the LetterTypeCodes have changed.

V21 Hugh W. Converted

this

document to

SELC

template

format

Incorporated VIS 3.0 functionality

V21 Hugh W. New method

added.

EmpGetClosureCodes – This method returns valid closure codes for a

particular case.


added.

EmpGetCaseAlertCounts – This method returns case counts for: cases

needed to be closed, cases that have had status changes, and cases

where authorization documents are about to expire or have expired.


added.

EmpGetAlertCases – This method returns a list of cases matching one

of the alert types described in the EmpGetCaseAlertCounts.


added.

EmpUpdateSSALetterReceived – This method notifies CPS that an

SSA letter (TNC and/or Referral letter) has been given to an employee.


added.

EmpUpdateDHSLetterReceived – This method notifies CPS that a

DHS letter (TNC and/or Referral letter) has been given to an employee.

V21 Hugh W. Method input

parameter

list changed.

EmpCloseCase – The CurrentlyEmployed input parameter has been

added to this method. Valid values for this parameter are “Y” or “N”.


parameter

list changed.

EmpInitBPVerif – The OverDueVerifyReason and

OverDueVerifyReasonOther parameters have been added to this

method’s input parameters. These parameters describe why an

employee was not verified within 3 days of hire date.


parameter

list changed.

EmpInitDABPVerif – The OverDueVerifyReason and

OverDueVerifyReasonOther parameters have been added to this

method’s input parameters. These parameters describe why an

employee was not verified within 3 days of hire date.

V21 Hugh W. New valid

values table

in Appendix

D

Table : “ 86: OverDueVerifyReason Valid Values”

added to Appendix D. This table describes the valid values that can be

used in the OverDueVerifyReason field.

V21 Hugh W. New method EmpInitVerfResp21 – This response object is used by the



ICA for E-Verify Web Service Access Method ix ITDL – 180893


Author

Summary of


response

object.

EmpInitBPVerif , EmpInitDABPVerif, and EmpSSAReVerify

methods. Added NumberOfReferralReasons and

ReferralReasonListArray fields.


response

object.

EmpGtCseDetailsResp21– This response object is used by the

EmpGetCaseDetails method. Added NumberOfReferralReasons and

ReferralReasonListArray fields.

V21 Hugh W. New closure

codes added.

New closure codes added to Appendix D Table .

V21 Hugh W. New closure

codes

decision

tables

Two new closure codes decision tables added to Appendix D. Table

and Table .

V21 Hugh W. Message

descriptions

changed.

The message descriptions (not codes) changed (All upper case changed

to mixed case and a few of the actual descriptions changed) in the

following tables in Appendix D:

Table 78: Initial Verification Response Codes

Table 79: SSA Referral Response Codes

Table 80: DHS Additional Resolution Codes

Table 81: DHS Referral Resolution Codes


return codes

and

messages.

Added new return codes and messages to Appendix D Table Return

Status Codes Table

V21 Hugh W. Document

Types

(names

associated

with

Document

IDs)

changed.

The Document Types (names associated with Document IDs) changed.

No Document IDs were added or deleted, only the names changed. See

Appendix D Table 77:.

V21 Hugh W. Citizenship

Type

description.

Citizenship Type descriptions have changed.

V21 Hugh W. SSA and

DHS letters

have been

updated.

All SSA and DHS TNC and Referral letters have been updated.

V21 4/8/2010 Mike V. Updated to

incorporate

comments

from USCIS

Consolidated

Document

Assessment

review.

V22 09/26/2010 Hugh W. New Web The new URL for the test (stage) system is:



ICA for E-Verify Web Service Access Method x ITDL – 180893


Author

Summary of


service test

and

production

URLs

https://stage.e-


V22 09/26/2010 Hugh W. New U.S

Citizen

passport

photo

processing.

A new process has been incorporated to return passport photos for

employees being verified as U.S citizens and presenting a U.S passport

as their document.

This process is similar to the non U.S. citizen photo process in that the

photo returned has to be confirmed and if the photo is rejected a DHS

TNC is returned and the case can be referred to DHS. The one

difference is that DHS can request the user to retrieve and confirm a

U.S. passport photo after the case was referred to DHS .

V22 09/26/2010 Hugh W. New method

added for

U.S citizen

passport

photo

processing:

EmpCitDHS

ReVerify

This method performs a DHS reverification for U.S citizens providing

a passport as their verification document.

A call to this method is required after receiving an EligStatementCd of

30 and EligStatementTxt of “Case Incomplete” from an initial

verification attempt (EmpInitBPVerif, EmpInitDABPVerif) of an U.S

citizen or Naturalized citizen with a document type of “Unexpired U.S

Passport or U.S Passport Card”.


added for

U.S citizen

passport

photo

processing:

EmpRetrieve

Photo

This method returns an U.S citizen passport photo and its’ supporting

data after a third-step request and response.

A call to this method is required after receiving an EligStatementCd of

“P” and EligStatementTxt of “Photo Matching Required” from SVS as

an answer to a DHS referral (third-step) request. This method will

return a passport photo and corresponding verification data. After

receiving the photo the EmpConfirmPhoto method is called to confirm

or reject the photo.

V22 09/26/2010 Hugh W. New

response

object added

for the new

EmpRetrieve

Photo

method:

EmpRetrieve

PhotoResp

This data type is used to package the output data of an

EmpRetrievePhoto method call. It returns a U.S citizen passport photo

and the data needed to confirm the photo.

V22 09/26/2010 Hugh W. New

response

object for the

EmpGetCase

Details

method

New return object for EmpGetCaseDetails – EmpGtCseDetailsResp22.

The following field were added to the new return object:

InitiReceiptNum

InitiVisaNum

InitiPassportNum

InitiLateHireDateReason

InitiLateHireDateRsnOther

SsaoDispositionDt





ICA for E-Verify Web Service Access Method xi ITDL – 180893


Author

Summary of


SsaoMessageCode

SsaoEligibStmt

SsaoElibibilityStmtDetail

ClientCompanyId

InsAddlReferiDt;

InsAddlReferiBy;

InsAddlReferoEligibStmt;

InsAddlReferoResolutionCode;

InsAddlReferoResolvedDt;

V22 09/26/2010 Hugh W. Two new

response

codes added

to Table D-6:

DHS

Referral

Resolution

Codes.

Response Code “P” –Passport Data verified.

SVS has verified the referred data for a U.S. Citizen with a passport

and is requesting the user to retrieve and confirm the passport photo.

Call EmpRetrievePhoto to retrieve the passport photo and then call

EmpConfirmPhoto to either confirm or reject the photo (Note – If you

reject the photo you will receive another DHS TNC and will be

required to go through the DHS referral process again).

Response Code “X” – Close and Resubmit the case.

SVS could not process the user’s passport data and is requesting that

the current case be closed and another initial verification started for the

user.

V23 10/27/2010 Hugh W. Added new

input

parameters to

the

EmpInitBPV

erif method.

Added the following input parameter:

ListBDocumentId

ListCDocumentId

SupportingDocumentId

StateIssuingAuthority

DMVDocumentNbr

DMVDocNoExpirationDate


input

parameters to

the

EmpInitDAB

PVerif

method.

Added the following input parameter:

ListBDocumentId

ListCDocumentId

SupportingDocumentId

StateIssuingAuthority

DMVDocumentNbr

DMVDocNoExpirationDate

V23 10/27/2010 Hugh W. Created new

response

object for

the

EmpGetCase

Details

method.

(EmpGtCse

DetailsResp2

3)

Method returns a new response object.

EmpGtCseDetailsResp23

New fields in response object:

InitiListBDocType

InitiListCDocType

InitiSupportingDocType

InitiStateIssuingAuthority

InitiDMVDocumentNbr

InitiNoDocExpDate (flag)



ICA for E-Verify Web Service Access Method xii ITDL – 180893


Author

Summary of


V23 10/27/2010 Hugh W. New DHS

ReVerify

method

added:

EmpDMVD

HSReVerify

This method is used to re-verify a “Driver’s License” initial query that

receives a 30 (Case Incomplete) Eligibility Code.

This method should be used when the initial query contains:

Document ID: 28 (List B and C Documents) and a

List B Document Id: 1 (Driver’s license or ID card issued by a U.S.

state or outlying possession)


added:

EmpGetList

BCDocumen

tTypes

This method returns the list b and list c documents that are valid for a

particular citizenship code. The response object name is:

EmpGetListBCDocumentTypesResp

V23 10/27/2010 Hugh W. New

response

object added:

EmpGetList

BCDocumen

tTypesResp

This response object is returned by the EmpGetListBCDocumentTypes

method.

This object contains an array of List B documents and an array of List

C documents.


added:

EmpGetSupp

ortingDocum

entTypes

This method returns a list of supporting documents that can be used

with a particular list B document.

The response object name is:

EmpGetSupportingDocumentTypesResp

V23 10/27/2010 Hugh W. New

response

object added:

EmpGetSupp

ortingDocum

entTypesRes

p

This response object is returned by the

EmpGetSupportingDocumentTypes method.

This object contains an array of supporting document numbers.


added:

EmpGetIssui

ngAuthoritie

s

This method returns a list of Issuing Authorities (usually states) that

can be used with a particular list B document.

The response object name is:

EmpGetIssuingAuthoritiesResp

V23 10/27/2010 Hugh W. New

response

object added:

EmpGetIssui

ngAuthoritie

sResp

This response object is returned by the EmpGetIssuingAuthorities

method.

This object contains an array of Issuing Authorities (states).

V23 10/27/2010 Hugh W. New error

codes added

New error codes added to Appendix D Table

Errors -1140 thru -1157 added.

V23 10/27/2010 Hugh W. New List B

Document

Table 87: List B Documents added to Appendix D



ICA for E-Verify Web Service Access Method xiii ITDL – 180893


Author

Summary of


table added

to ICA

V23 10/27/2010 Hugh W. New List C

Document

table added

to ICA

Table 88: List C Documents added to Appendix D

V23 10/27/2010 Hugh W. New

Supporting

Document

table added

to ICA

Table 89: Supporting Documents added to Appendix D

V23 10/27/2010 Hugh W. New Issuing

Authorities

table added

to ICA

Table 90: Issuing Authorities added to Appendix D

V23 03/22/2011 Hugh W. New Web

service test

and

production

URLs

The new URL for the test (stage) system is:

https://stage.e-


V23 03/31/2011 Mike V. Updated

Appendix B-

Signature

Page

Replaced Karl Brimmer with Laura Moore

V23 07/07/2011 Natasha

F.

Updated

Table D-10:

List B

Documents

Valid Values

and Table

D-11: List C

Documents

Valid Values

Added 2 new List B Document Types.

Updated “Voter registration card” List B Document Type to be valid

for Citizenship Types 6 and 7.

Updated “U.S. military card or draft record” List B Document Type to

be valid for Citizenship Type 7.

Updated “Employment authorization document issued by the U.S.

Department of Homeland Security” List C Document Type to be valid

for Citizenship Types 4, 5, and 6.

V23 02/06/2012 Hugh W. Added

clarification

text to

sections

3.3.1.3 and

3.3.3.1.14

Added the following text to sections 3.3.1.3 and 3.3.3.1.14:

It may be used only when the CPS Web server has returned a response

code of 08 (EMPLOYMENT AUTHORIZED) from a call to

EmpInitBPVerif or EmpInitDABPVerif and the verification citizen

type is 6 (lawful permanent resident) or 7 (alien authorized to work).

U.S citizen and U.S national cases may not be sent to additional

verification.

***Needed to clarify that the user cannot send U.S citizen or U.S

Nationals verification cases to 2nd

step.

V24 06/15/2012 Hugh W. Added two

new input

Added two new input parameters to the EmpInitBPVerif method:

NoForeignPassport





ICA for E-Verify Web Service Access Method xiv ITDL – 180893


Author

Summary of


parameters to

EmpInitBPV

erif method

CountryOfIssuance


new input

parameters to

the

EmpInitDAB

PVerif

method

Added two new input parameters to the EmpInitDABPVerif method:

NoForeignPassport

CountryOfIssuance


response

object for the

EmpGetCase

Details

method:

EmpGtCseD

etailsResp24

The new EmpGtCseDetailsResp24 response object has the following

new fields:

InitiNoForeignPassport

InitiCountryOfIssuance InitiCountryOfIssuanceDesc


new input

parameters to

the

EmpDHSRe

Verify

method

Added two new input parameters to the EmpDHSReVerify method:

NoForeignPassport

CountryOfIssuance

V24 06/15/2012 Hugh W. Added three

new input

parameters to

the

EmpDMVD

HSReVerify

method

Added two new input parameters to the EmpDMVDHSReVerify

method:

PassPortNumber (Foreign)

NoForeignPassport

CountryOfIssuance

V24 06/15/2012 Hugh W. Added a new

method and

method

response

object.

Added a new method that returns a list of valid “country of issuance”

codes.

EmpGetCountryOfIssuanceList – method

CountryOfIssuanceResp – response object

V24 06/15/2012 Hugh W. Added table

to Appendix

D

Added new Country of Issuance (COI) country code reference table in

Appendix D Table

** Data in this table are subject to change.

V24 11/29/2012 Eric G. Added note

to table D-13

Issuing

Authorities

Valid Values

FL (Florida) was enabled as an issuing authority for driver’s license

verifications.

V24 02/25/2013 Hugh W. Updated

description

in Table D-2

Updated description of Document Type 11, 24, 25, and 29 in Table 77:.



ICA for E-Verify Web Service Access Method xv ITDL – 180893


Author

Summary of


V24 02/25/2013 Lara R. L. Updated

field

descriptions

Clarify descriptions of the NoForeignPassport and CountryofIssuance

field in Exhibit 1, 30, 34, and 50.

V24 02/25/2013 Lara R. L. Deleted

Joblock

Letters

reference

Deleted JobLock letters from list of valid letters.

V24 03/08/2013 Lara R. L. Updated

Outage

windows

information

Added outage window for DHS datacenter, and clarification for

external data partners outages.

V25 04/22/2013 Nelson R. Add Email

Address

Add Email Address field to methods EmpGetCaseDetails,

EmpInitBPVerif, and EmpInitDABPVerif

V25.1 8/1/2013 Nelson R. Updated

parameter

and type

names,

cleanup

Updated parameter names in the following objects: Case9,

EmpGetNextResolvedCaseNbrsResp9, EmpAlertCasesResp,

CaseNbrArray, CitizenshipCode, EmpGetCitizenshipCodesResp,

ClosureCode, EmpClosureCodesResp, CountryCode,

CountryOfIssuanceResp, DocType,

EmpGetAvailableDocumentTypesResp, DocumentField,

EmpGetAllDataFieldsResp, IssuingAuthority,

EmpGetIssuingAuthoritiesResp, ListBCDocument,

EmpGetListBCDocumentTypesResp, EmpGtCseDetailsResp25,

EmpInitVerfResp21, ReferralReasonArray,

EmpGetSupportingDocumentTypesResp

V25.1 8/7/2013 Yefim S Updated

parameter

names

Updated parameter names from “MaidenNm” to “OtherNamesUsed” in

the following methods: EmpInitBPVerif, EmpInitDABPVerif,

EmpSSAResubmittal, EmpSSAReVerify

Updated object EmpGtCseDetailsResp25 replace members:

InitiMaidenNm with InitiOtherNamesUsed, SsaResubmiMaidenNm

with SsaResubmiOtherNamesUsed

V25.1 08/12/2013 Hugh W. Added new

response

objects

The following response objects have been updated for this release:

EmpInitVerfResp25

EmpSubmitSSAReferralResp25

EmpInitVerfResp25

EmpConfirmPhotoResp25

EmpSubmitDHSReferralResp25

EmpGetNextResolvedCaseNbrsResp25

Case25

EmpSSAResubmittalResp25

V25.1 08/12/2013 Hugh W. Modified

LetterTypeC

odeList

fields

LetterTypeCodeList field has been changed from a string to an array of

strings in all of the response objects returning this field. This field may

now return multiple letter type codes.



ICA for E-Verify Web Service Access Method xvi ITDL – 180893


Author

Summary of


V25.1 08/12/2013 Hugh W. Added new

method and

response

object

A new method (EmpRetrieveFAN) has been added that will allow the

retrieval of pre-filled SSA/DHS TNC FAN and RDC letters. The

method’s response object is EmpRetrieveFANResp25.

V25.2 10/01/2013 Lara R.L. Updates Added the IA specifications, clarified information on the CaseClose

Method, added a note to identify the EmpUpdateLetterReceived

methods as obsolete. Added return status codes -1316 and -1317.

V26 02/18/2014 Nani C. Added new

method and

response

object

A new method (EmpGetDuplicateCaseList) has been added that will

get a list of associated duplicate cases based on the case number and

SSN passed in. The method’s response object is

EmpGetDuplicateCaseListResp.

V26 03/10/2014 Josh R. Added new

methods and

response

object

Three new methods (EmpDupCaseContinueWithoutChanges,

EmpDupCaseContinueWithChanges,

EmpGetDupCaseContinueReasons) have been added in conjunction

with the process that allows a user to continue a duplicate case.

V26 03/28/2014 Lara R.L. Added urls

for Non-

.NET users

Added the URLs to help those using non.NET as it may not be

compatible with WCF.

V26 05/02/2014 Lara R.L. WCF

clarification Updated the CPS E-Verify Web Service Interface User Accounts and

Authentication and added Appendix H.

V26 05/19/2014 Lara R.L. Added

clarifications All elements must be now present even If there are empty tags.

V26 06/20/2014 Lara R.L. Updates Updated typos on the new method calls labels and made clarifications.

V26 08/18/2014 Lara R.L. Updates Added information on Duplicate Case flow.

Added closure (U- Unknown) code for duplicate cases and information

on how to close duplicate cases.

Updated typos on tables and references.

V27 10/07/2014 Zac D. Added new

methods and

response

object

Added two new methods (EmpSaveSSATNCNotification,

EmpSaveDHSTNCNotification) to allow the user to record if the

employee has been notified of the TNC. Added the method’s response

object EmpSaveTNCNotificationResp.

V28 01/14/2015 Natasha

F.

New error

codes added

New error codes -1327 through -1328 added to Appendix D Table 76:

Return Status Codes Table.

Updated the EmpSaveSSATNCNotification and

EmpSaveDHSTNCNotification Web Service method descriptions.

These methods are required to be invoked first before submitting the

SSA or DHS Referral and invoking EmpSubSSAReferral /

EmpSubDHSReferral Web Service methods.

V28 01/16/2015 Natasha

F.

New error

codes added

based on

Case

Queuing

Added new response codes (42 and 43) returned from the

EmpInitBPVerif, EmpInitDABPVerif, EmpDHSReVerify,

EmpCitDHSReVerify and EmpDMSDhsReVerify methods.

This has been documented in each of the above methods content

description.

Updated Table 78: Initial Verification Response Codes to include the



ICA for E-Verify Web Service Access Method xvii ITDL – 180893


Author

Summary of


new response codes 42 and 43 that are returned.

V28 01/19/2015 Pranita D. New closure

code added

New closure code “TECISS” added to Appendix D Table 82, 83 and

84.

EmpSSAReVerify, EmpSSAResubmittal,

EmpDupCaseContinueWithChanges and

EmpDupCaseContinueWithoutChanges methods content description

changed to add new response codes (42 and 43).

V28 01/20/2015 Priyashre

e S.

Added URL

for password

administratio

n

Added a new URL for SetUserPassword.

V28 1/22/2015 Zac D. Added new

Error Code.

Updated

DHS

Referral

method.

Added new error code.

Updated EmpSubDHSReferral method to accept JPG file for Image

Upload as well as increasing the accepted image size to 5 MB.

V28 1/22/2015 Khadijah

A.

Modified

Country of

Issuance

parameter

size from 1-5

to 3-3

Modified Country of Issuance parameter size from 1-5 to 3-3.

V28 2/4/2015 Lara R.L. Final Edits Added notes to indicate that EmpUpdateSSALetterReceived,

EmpUpdateDHSLetterReceived and EmpLetterReceivedResp have

been removed from WSDL.

Updated SSA/DHS Referral sequence diagram to include the new

methods and response object (EmpSaveSSATNCNotification,

EmpSaveDHSTNCNotification, EmpSaveTNCNotificationResp).

V28.1 2/23/2017 Ziaul

Qasem

Added new

logic under

Table 1.

Added new

error code

under Table

76

Table 1: Added new logic under Alien Number, I94 Number and

Passport Number for CitizenshipStatus = 7 and DocumentId = 28.

Added new logic for NoForeignPassport field

Table 76: Added error code -1001: Must provide Alien Number, I94

Number or Passport Number.

V28.2 3/9/2017 Ziaul

Qasem

Added new

logic under

Table 13, 17,

33.

Added new

closure code

under Table

82

Table 13: Added new logic for NoForeignPassport field

Table 17: Added new logic for NoForeignPassport field

Table 33: Added new logic for InitiNoForeignPassport field

Table 82: Added closure codes EARCLS, EARNEW, EDEXPD,

ENCLNT, ENEMPD



ICA for E-Verify Web Service Access Method xviii ITDL – 180893

Note: Under Version the V number is not associated with the release number; it is a reference

number for the Web service.



ICA for E-Verify Web Service Access Method xix ITDL – 180893

EXECUTIVE SUMMARY

This Interface Control Agreement (ICA) details the service available from:

Customer Processing System (CPS) Employer-oriented Web Service

to the following:

Employers and E-Verify Employer Agents who have the business requirement to perform

employment status verifications using the E-Verify system and have chosen Web Service as their

primary access methodology.



ICA for E-Verify Web Service Access Method xx ITDL – 180893

CONTENTS

1.0 INTRODUCTION.......................................................................................................................... 1 1.1 Web Service Certification Overview .................................................................................. 2 1.2 Training Materials ............................................................................................................... 2 1.3 Obtaining a Test Account for Testing Prior to Certification .............................................. 3 1.4 Certification Process ........................................................................................................... 3 1.5 Outage Notification - Maintaining Points of Contact ......................................................... 4 1.6 Web Services Support ......................................................................................................... 5

1.6.1 Contact Information ............................................................................................... 6 1.6.2 Request Response Time ......................................................................................... 6

1.7 Web Services Management GUI ........................................................................................ 7

2.0 DOCUMENT REFERENCES ...................................................................................................... 8

3.0 CPS E-VERIFY WEB SERVICE INTERFACE ........................................................................ 8 3.1 CPS E-Verify Web Service Interface Description .............................................................. 8 3.2 CPS E-Verify Web Service Interface User Accounts and Authentication ......................... 8 3.3 CPS E-Verify Web Service Functionality .......................................................................... 9

3.3.1 CPS E-Verify Web Service Data Flow Characterization....................................... 9 3.3.1.1 Initial Verification Query Scenario .................................................... 9 3.3.1.2 Initial Verification Query with Potential Duplicate Case Scenario .. 10 3.3.1.3 Employment Eligibility Verification Requests with Automatic

Additional Scenario .......................................................................... 11 3.3.1.4 Sending Case to Additional Verification Scenario ........................... 13 3.3.1.5 SSA Referral .................................................................................... 15

3.3.1.5.1 SSA Referral ....................................................................... 15 3.3.1.6 SSA Resubmittal .............................................................................. 17 3.3.1.7 DHS Referral .................................................................................... 18 3.3.1.8 SSA ReVerify ................................................................................... 20 3.3.1.9 DHS ReVerify .................................................................................. 21 3.3.1.10 Confirm Photo .................................................................................. 22 3.3.1.11 Reject Photo ..................................................................................... 23 3.3.1.12 Combined Flow ................................................................................ 24 3.3.1.13 CPS Employment Eligibility Verification State Machine ................ 25

3.3.2 CPS E-Verify Web Service Protocol and Transfer Method ................................ 28 3.3.3 CPS E-Verify Web Service Data Format and Content ........................................ 28

3.3.3.1 CPS E-Verify Web Service Message Layout ................................... 28 3.3.3.1.1 EmpInitBPVerif Content and Format ................................. 29 3.3.3.1.2 EmpInitDABPVerif Content and Format ............................ 35 3.3.3.1.3 EmpSSAReVerify Content and Format .............................. 38 3.3.3.1.4 EmpUpdateSSALetterReceived Content and Format

(Removed) ........................................................................... 41 3.3.3.1.5 EmpSaveSSATNCNotification Content and Format .......... 41 3.3.3.1.6 EmpSubSSAReferral Content and Format .......................... 42 3.3.3.1.7 EmpSSAResubmittal Content and Format .......................... 43 3.3.3.1.8 EmpDHSReVerify Content and Format ............................. 45 3.3.3.1.9 EmpCitDHSReVerify Content and Format ......................... 48 3.3.3.1.10 EmpDMVDHSReVerify Content and Format .................... 50



ICA for E-Verify Web Service Access Method xxi ITDL – 180893

3.3.3.1.11 EmpRetrievePhoto Content and Format ............................. 54 3.3.3.1.12 EmpConfirmPhoto Content and Format ............................. 55 3.3.3.1.13 EmpUpdateDHSLetterReceived Content and Format

(Removed) ........................................................................... 57 3.3.3.1.14 EmpSaveDHSTNCNotification Content and Format ......... 57 3.3.3.1.15 EmpSubDHSReferral Content and Format ......................... 57 3.3.3.1.16 EmpSubmitAdditVerif Content and Format ....................... 59 3.3.3.1.17 EmpGetNextResolvedCaseNbrs Content and Format ........ 60 3.3.3.1.18 EmpGetCaseDetails Content and Format............................ 63 3.3.3.1.19 EmpAckReceiptOfResolvedCaseNbr Content and Format. 70 3.3.3.1.20 EmpGetClosureCodes Content and Format ........................ 71 3.3.3.1.21 EmpCloseCase Content and Format ................................... 72 3.3.3.1.22 EmpGetCaseAlertCounts Content and Format ................... 73 3.3.3.1.23 EmpGetAlertCases Content and Format ............................. 74 3.3.3.1.24 EmpGetCitizenshipStatusCodes Content and Format ......... 75 3.3.3.1.25 EmpGetAvailableDocumentTypes Content and Format ..... 76 3.3.3.1.26 EmpGetListBCDocumentTypes Content and Format ......... 76 3.3.3.1.27 EmpGetSupportingDocumentTypes Content and Format .. 77 3.3.3.1.28 EmpGetIssuingAuthorities Content and Format ................. 79 3.3.3.1.29 EmpGetAllDataFields Content and Format ........................ 80 3.3.3.1.30 EmpGetCountryOfIssuanceList Content and Format ......... 81 3.3.3.1.31 EmpCpsVerifyConnection Content and Format ................. 82 3.3.3.1.32 EmpRetrieveFAN Content and Format ............................... 82 3.3.3.1.33 EmpGetDuplicateCaseList Content and Format ................. 84 3.3.3.1.34 EmpDupCaseContinueWithChanges Content and Format . 85 3.3.3.1.35 EmpDupCaseContinueWithoutChanges Content and Format86

3.3.4 CPS E-Verify Web Service Interface Technical Design ..................................... 88 3.3.5 CPS E-Verify Web Service Data Exception and Error Handling ........................ 88

3.3.5.1 Security Exception Handling ........................................................... 88 3.3.5.2 Application Method Invocation Error Handling .............................. 88

4.0 CPS E-VERIFY WEB SERVICE ADMINISTRATION INTERFACE ................................. 89 4.1 CPS E-Verify Web Service Administration Functionality ............................................... 89

4.1.1 CPS E-Verify Web Service Administration Data Format and Content ............... 89 4.1.1.1 CPS E-Verify Web Service Administration Message Layout .......... 89

4.1.1.1.1 SetUserPassword Content and Format ................................ 89

APPENDIX A—ACRONYMS AND ABBREVIATIONS .................................................................... 91

APPENDIX B—SIGNATURE PAGE .................................................................................................... 93

APPENDIX C—WSDL FILE .................................................................................................................. 94

APPENDIX D—REFERENCE CODES VALID VALUES .................................................................. 95

APPENDIX E—WEB SERVICES CALL/RESPONSE SUMMARY TABLE ................................. 128

APPENDIX F—E-VERIFY URLS........................................................................................................ 130

APPENDIX G—E-VERIFY WCF BINDINGS INCOMING MESSAGES SAMPLE..................... 131

APPENDIX H—SYSTEM AVAILABILITY TIME ........................................................................... 132

APPENDIX I—DATE/TIME REQUIREMENTS ............................................................................... 133



ICA for E-Verify Web Service Access Method xxii ITDL – 180893

LIST OF EXHIBITS/TABLES

Exhibit 1: Web Service Technical Certification Overview ........................................................................... 2

Exhibit 2: Maintaining Points of Contact in E-Verify .................................................................................. 5

Exhibit 3: E-Verify GUI Showing Manage Web Services Link ................................................................... 7

Exhibit 4: Components Interface Diagram ................................................................................................... 8

Exhibit 5: Call Sequence for Initial Employment Eligibility Verification.................................................. 10

Exhibit 6: Call Sequence for Initial Verification Query with Potential Duplicate Case ............................. 11

Exhibit 7: Call Sequence for Initial Employment Eligibility Verification with Automatic Additional

Verification ................................................................................................................................................. 12

Exhibit 8: Call Sequence to Send Case to Additional Verification ............................................................ 14

Exhibit 9: Call Sequence to Perform an SSA Referral ............................................................................... 16

Exhibit 10: Call Sequence to Perform an SSA Resubmittal ....................................................................... 17

Exhibit 11: Call Sequence to Perform a DHS Referral ............................................................................... 19

Exhibit 12: Call Sequence to Perform a SSA ReVerify .............................................................................. 21

Exhibit 13: Call Sequence to Perform a DHS ReVerify ............................................................................. 22

Exhibit 14: Call Sequence to Perform a Confirm Photo ............................................................................. 23

Exhibit 15: Call Sequence to Perform a Reject Photo ................................................................................ 24

Exhibit 16: Call Sequence to Show a Combined Flow ............................................................................... 25

Exhibit 17: CPS Employment Eligibility Verification State Machine ........................................................ 27

Exhibit 18: SOAP Message Layout ............................................................................................................ 29

Table 1: EmpInitBPVerif Data Elements Table ......................................................................................... 30

Table 2: EmpInitDABPVerif Data Elements Table .................................................................................... 36

Table 3: EmpInitVerfResp25 Data Elements Table .................................................................................... 36

Table 4: EmpSSAReVerify Data Elements Table ...................................................................................... 38

Table 5: EmpInitVerfResp25 Data Elements Table .................................................................................... 39

Table 6: EmpUpdateSSALetterReceived Data Elements Table ................................................................. 41

Table 7: EmpSaveSSATNCNotification Data Elements Table .................................................................. 41

Table 8: EmpSaveTNCNotificationResp Data Elements Table ................................................................. 42

Table 9: EmpSubSSAReferral Data Elements Table .................................................................................. 42

Table 10: EmpSubmitSSAReferralResp25 Data Elements Table .............................................................. 43

Table 11: EmpSSAResubmittal Data Elements Table ................................................................................ 43



ICA for E-Verify Web Service Access Method xxiii ITDL – 180893

Table 12: EmpSSAResubmittalResp25 Data Elements Table .................................................................... 44

Table 13: EmpDHSReVerify Data Elements Table .................................................................................... 46

Table 14: EmpInitVerfResp25 Data Elements Table .................................................................................. 47

Table 15: EmpCitDHSReVerify Data Elements Table ............................................................................... 49


Table 17: EmpDMVDHSReVerify Data Elements Table .......................................................................... 51


Table 19: EmpRetrievePhoto Data Elements Table .................................................................................... 54

Table 20: EmpRetrievePhotoResp Data Elements Table ............................................................................ 55

Table 21: EmpConfirmPhoto Data Elements Table.................................................................................... 56

Table 22: EmpConfirmPhotoResp25 Data Elements Table ........................................................................ 56

Table 23: EmpSaveDHSTNCNotification Data Elements Table ............................................................... 57

Table 24: EmpSaveTNCNotificationResp Data Elements Table ............................................................... 57

Table 25: EmpSubDHSReferral Data Elements Table ............................................................................... 58

Table 26: EmpSubmitDHSReferralResp28 Data Elements Table .............................................................. 58

Table 27: EmpSubmitAdditVerif Data Elements Table ............................................................................. 59

Table 28: EmpSubmitAdditVerifResp Data Elements Table ..................................................................... 59

Table 29: EmpGetNextResolvedCaseNbrs Data Elements Table .............................................................. 61

Table 30: EmpGetNextResolvedCaseNbrsResp25 Data Elements Table ................................................... 61

Table 31: Case25 Data Elements Table ...................................................................................................... 62

Table 32: EmpGetCaseDetails Data Elements Table.................................................................................. 63

Table 33: EmpGetCaseDetails25 Data Elements Table.............................................................................. 63

Table 34: EmpAckReceiptOfResolvedCaseNbr Data Elements Table ...................................................... 70

Table 35: EmpAckReceiptOfResolvedCaseNbrResp Data Elements Table............................................... 70

Table 36: EmpGetClosureCodes Data Elements Table .............................................................................. 71

Table 37: EmpClosureCodesResp Data Elements Table ............................................................................ 71

Table 38: ClosureCode Data Elements Table ............................................................................................. 72

Table 39: EmpCloseCase Data Elements Table ......................................................................................... 72

Table 40: EmpCloseCaseResp Data Elements Table.................................................................................. 72

Table 41: EmpCaseAlertsResp Data Elements Table ................................................................................. 73

Table 42: EmpGetAlertCases Data Elements Table ................................................................................... 74

Table 43: EmpAlertCasesResp Data Elements Table ................................................................................. 74

Table 44: EmpGetCitizenshipCodesResp Data Elements Table................................................................. 75



ICA for E-Verify Web Service Access Method xxiv ITDL – 180893

Table 45: CitizenshipCode Data Elements Table ....................................................................................... 75

Table 46: EmpGetAvailableDocumentTypes Data Elements Table ........................................................... 76

Table 47: EmpGetAvailableDocumentTypesResp Data Elements Table ................................................... 76

Table 48: DocType Data Elements Table ................................................................................................... 76

Table 49: EmpGetListBCDocumentTypes Data Elements Table ............................................................... 77

Table 50: EmpGetListBCDocumentTypesResp Data Elements Table ....................................................... 77

Table 51: ListBCDocument Data Elements Table ...................................................................................... 77

Table 52: EmpGetGetSupportingDocumentTypes Data Elements Table ................................................... 78

Table 53: EmpGetSupportingDocumentTypesResp Data Elements Table................................................. 78

Table 54: SupportingDocument Data Elements Table................................................................................ 78

Table 55: EmpGetIssuingAuthorities Data Elements Table ....................................................................... 79

Table 56: EmpGetIssuingAuthoritiesResp Data Elements Table ............................................................... 79

Table 57: IssuingAuthority Data Elements Table ....................................................................................... 80

Table 58: EmpGetAllDataFields Data Elements Table .............................................................................. 80

Table 59: EmpGetAllDataFieldsResp Data Elements Table ...................................................................... 80

Table 60: DocumentField Data Elements Table ......................................................................................... 81

Table 61: EmpGetCountryOfIssuance Table .............................................................................................. 81

Table 62: CountryOfIssuanceResp Data Elements Table ........................................................................... 81

Table 63: CountryCode Data Elements Table ............................................................................................ 82

Table 64: EmpCpsVerifyConnectionResp Data Elements Table ............................................................... 82

Table 65: EmpRetrieveFAN Data Elements Table ..................................................................................... 83

Table 66: EmpRetrieveFANResp25 Data Elements Table ......................................................................... 83

Table 67: EmpGetDuplicateCaseList Content Data Elements Table ......................................................... 84

Table 68: EmpGetDuplicateCaseListResp Data Elements Table ............................................................... 84

Table 69: DupCaseListItem Data Elements Table ...................................................................................... 84

Table 70: EmpDupCaseContinueWithChanges Data Elements Table ....................................................... 86

Table 71: EmpDupCaseContinueWithoutChanges Data Elements Table .................................................. 87

Table 72: EmpGetDupCaseContinueReasonsResp Data Elements Table .................................................. 87

Table 73: ContinueReason Data Elements Table ....................................................................................... 88

Table 74: SetUserPassword Data Elements Table ...................................................................................... 90

Table 75: SetUserPasswordResp Data Elements Table .............................................................................. 90

Table 76: Return Status Codes Table .......................................................................................................... 95

Table 77: DHS Document Types .............................................................................................................. 102



ICA for E-Verify Web Service Access Method xxv ITDL – 180893

Table 78: Initial Verification Response Codes ......................................................................................... 103

Table 79: SSA Referral Response Codes .................................................................................................. 105

Table 80: DHS Additional Resolution Codes ........................................................................................... 106

Table 81: DHS Referral Resolution Codes ............................................................................................... 106

Table 82: Closure Codes ........................................................................................................................... 106

Table 83: Closure Codes Usage Based on Case “State” ........................................................................... 108

Table 84: Closure Codes Usage Based on Case “State” ........................................................................... 112

Table 85: LetterTypeCodes ....................................................................................................................... 115

Table 86: OverDueVerifyReason Valid Values ........................................................................................ 115

Table 87: List B Documents Valid Values ............................................................................................... 116

Table 88: List C Documents Valid Values ............................................................................................... 117

Table 89: Supporting Documents Valid Values ....................................................................................... 118

Table 90: Issuing Authorities Valid Values .............................................................................................. 118

Table 91: COI Country Codes .................................................................................................................. 120

Table 92: ContinueDupCaseReason Valid Values ................................................................................... 127



ICA for E-Verify Web Service Access Method 1 ITDL – 180893

1.0 INTRODUCTION

E-Verify is an Internet-based system that allows businesses to determine the eligibility of their

employees to work in the United States. Specified data is provided by the employer on behalf of

the employee and E-Verify provides an eligibility response. The majority of queries are resolved

during initial verification. If eligibility cannot be provided during the initial verification,

subsequent manual checks may be required to confirm status. Possible sequences of events are

provided in section 3.3 “CPS E-Verify Web Service Functionality.”

For additional information about the E-Verify Program, please refer to http://www.uscis.gov/E-

Verify.

This Interface Control Agreement (ICA) details the service available from the E-Verify Web

Service. It is meant to be used by Employers and E-Verify employer agents that have a business

requirement to perform employment status verifications using E-Verify and have selected Web

service as their primary access methodology.

A Web service is a piece of executable code running on a Web server with an interface that

makes it available for access by other programs through the Hypertext Transport Protocol

(HTTP) and Simple Object Access Protocol (SOAP) protocols. A Web service may be used by

an application from across the Internet or via the Department of Homeland Security (DHS)

intranet.

The methods described in this ICA allow an employer’s (or E-Verify employer agent’s) Web

service client to:

Perform initial verifications;

Perform Social Security Administration (SSA) reverifications;

Perform SSA referrals;

Perform SSA resubmittals;

Confirm photos returned during initial verification;

Perform DHS reverifications;

Request additional verifications;

Request additional verification responses;

Initiate DHS referrals;

Retrieve DHS referral responses;

Perform case closures.

Sections 1.1 through 1.6 outline requirements and responsibilities associated with the E-Verify

Web Service access method:




1.1 Web Service Certification Overview

A Memorandum of Understanding (MOU) must be established before any testing and data

exchange can take place. The employer or E-Verify employer agent must appoint a program

administrator who will be provided access to E-Verify. The program administrator must log on

and successfully complete the online tutorial before the employer (or E-Verify employer agent)

will be allowed to initiate testing in the E-Verify Web Service stage environment. The employer

or E-Verify employer agent must complete a period of testing with CSC on the E-Verify Web

Service test system to demonstrate that the employer’s (or E-Verify employer agent’s) Web

service client is functioning properly before access is provided to the E-Verify Web Service

production system.

The timeline for Web service integration can vary widely depending on the amount of

development time required by an employer. This document provides the framework for

development of a Web service interface for E-Verify. There are a number of steps that must be

completed once an employer has completed the development of its Web service. Employers must

request a test account for the E-Verify stage environment from the Web service support team.

Once the employer has completed development and testing, certification must occur. Outlined in

Exhibit 1 is the high level certification process.

Exhibit 1: Web Service Technical Certification Overview

1.2 Training Materials

There are a number of training materials available on the E-Verify Web site -- User Manuals,

Tutorials, I-9 instructions, etc. Only people familiar with both the ICA and those other resources

should contact the Web Services Support Team. Our purpose is to provide technical assistance in

connecting Web service client software to E-Verify; we are unable to provide training or teach

E-Verify business logic. The training materials available will provide you with the foundational

understanding of the E-Verify business logic. Questions surrounding business logic and policy

must be presented to DHS directly at [email protected] or [email protected].

Many of these materials can be found by logging into your E-Verify Website account, in either

the production or stage environment.

Under the View Essential Resources link you may find the following documentation useful:

E-Verify Quick Reference Manual

E-Verify User Manual

mailto:[email protected]





A Guide to Selected Travel Documents

Form I-9

Handbook for Employers, Instructions for Completing the Form I-9

Additionally, the following resources are essential to understanding E-Verify:

E-Verify Tutorial (“Take Tutorial” link)

E-Verify Case Verification Process (running test data in the stage E-Verify Website)

These resources were created to help provide baseline knowledge of E-Verify which will help in

understanding and communicating in your Web service interface development.

1.3 Obtaining a Test Account for Testing Prior to Certification

Accounts to access the staging environment may be obtained by contacting the Web Services

Support Team at the following email address: [email protected]. Please

include your current E-Verify Website (browser) production User ID, received during

registration in this email (testers must have a valid Web browser ID prior to commencing

testing). We will create a company in the staging environment mirroring your production

company with the following:

1. The Web service stage environment User ID you receive will be generated based on the

specifications of the User ID provided (identical name, contact information, etc.).

2. You will receive a stage environment E-Verify Website User ID (Program

Administrator). This will allow you to verify the case verification process in the stage E-

Verify Website (https://stage.e-verify.uscis.gov/emp or https://stage.e-

verify.uscis.gov/emp).

3. You will also be provided with a set of test data. This test data will allow you to test the

responses included in the initial verification as well as any exception processes. Testing

of the subsequent manual verifications will require resolution of the case by the Web

Services Support Team. This resolution will be facilitated through communication via the

Web service test email address provided above.

1.4 Certification Process

After an employer successfully completes the testing of their Web service software, an email

request for certification must be sent to the Web Services Support Team at the Web service test

email address provided above. A set of specific test cases will be provided to the employer for

certification. Certification usually takes a few days depending on how quickly the employer

cycles through the steps and the current demand on the Web Services Support Team. It should

be noted that conducting certification close to the DHS compliance deadlines will inevitably

result in longer delays. We suggest planning your certification timetable far in advance of DHS

compliance deadlines for the smoothest experience and recommend you submit your request for

certification at least six weeks before the deadline. During the certification, the certifier will

mailto:VISWebservices.e-verify@

https://stage.e-verify.uscis.gov/emp




ensure that the employer is able to utilize its Web service integration along with the use of the E-

Verify Website to complete the entire verification process.

Please keep in mind:

Certification applies solely to the organization’s software

Certification ensures that the software can send and receive verification transactions

Software must satisfy the entire certification test to be successfully certified

E-Verify does not certify organizations

No evidence of certification is provided – we do not provide certificates

In most cases, successful Web service certification will result in the production Web service

User ID and URL being issued and conveyed. Additional User IDs must be requested through

the [email protected] email address.

Note: Please, refrain from submitting dummy test data in the production environment (e.g.

“Last” for the Last Name field, and “Name” for the First Name field.)

1.5 Outage Notification - Maintaining Points of Contact

To ensure you receive all notifications for the E-Verify Web service community, including

notification of any outage events, please keep your points of contact up to date. This must be

done through the production E-Verify website through the Edit Company Profile link. This link

is available only to Program Administrators. A screenshot is provided below in Exhibit 2.

Additional instruction can be found in the E-Verify User Manual listed in section 1.2 “Training

Materials.” Program Administrators can also visit the E-Verify GUI and click on the left-hand

side navigation menu section called “My Web Services,” then click on the “Manage Web

Services” link in that section and see the news area on the right-hand side of the screen for news

and updates.





Exhibit 2: Maintaining Points of Contact in E-Verify

1.6 Web Services Support

We have implemented an automatic ticketing program to track your service requests, but we

need your help.

1. Please send service requests concerning urgent production issues to VISWebServices.E-

[email protected]. Please use this address only for urgent production related

requests. The more responsible you are in using this address for only urgent requests, the

more attention requests to this address will generate.

2. If you are unable to reach one of us, you can also report an urgent production issue to the

general E-Verify Help Desk at 800-741-5023. They will be able to contact us in the case

of an emergency. Please note that you should not call this number and create a ticket for

routine Web service requests or to emphasize the urgency of your test cases. We work

through the queue of requests as we receive them.

3. Send all routine requests to [email protected]. That address will

automatically log your request and enter it into our ticketing system. The system will also







forward your email to each of us working on these requests. Please do not “CC” the

request to any of us individually -- duplicate emails only create confusion.

4. Make the following line (with your own UserID instead of ABCD1234) the first line in

the body (not subject line) of every email that you send to us. NOTE: Be sure to place the

colon after UserID this will help us better track your request.

5. UserID: ABCD1234

If your message is part of an ongoing conversation with a member of the CSC Web

Services Team, you may put that person's first name in all caps at the end of the subject

line. This will ensure that the message gets routed to that person.

6. When requesting support for troubleshooting code, the following must be provided for

timely resolution of the issue:

Test or Production URL being used to send method call.

IP address you are using to send the call to E-Verify.

Attach .XML files for both the method call request and the E-Verify response.

(Please do not embed XML code in your email text)

Include the entire SOAP envelope in both .XML files:

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope ............>

<soap:Header>

...............

</soap:Header>

<soap:Body>

...............

</soap:Body>

</soap:Envelope>

1.6.1 Contact Information

Policy Related DHS Support: [email protected] or [email protected]

Web Services Support Email: [email protected]

Urgent Web Service Production Issues: [email protected]

E-Verify Help Desk at 800-741-5023 (primarily for E-Verify website technical support, will not

be able to address most Web service issues)

1.6.2 Request Response Time

Our goal is to provide a streamlined experience for Web service interface development and

support for all E-Verify users. While most requests are resolved within 24 hours, resource

constraints, the level of demand for Web service support, reporting requirements, and the

continued growth in the E-Verify Web Service may impact our ability to respond to requests in

that time frame. We strive to provide the best customer service possible and attempt to turn








around all requests within three business days. If you find your request not being addressed in

this time frame, we may be experiencing higher demand than usual. We appreciate your

patience and we will respond to your request as soon as possible. If your request has not

received a response after three days, please forward your original request to VISWebServices.E-

[email protected] to ensure it has been received.

1.7 Web Services Management GUI

When an employer or employer agent registers for E-Verify and signs up for Web Services, the

user is given a Program Administrator (PA) user account with the WS role. When the user with

the WS role logs into the E-Verify GUI, there is a link on the left-hand navigation menu that

takes the user to the Web Services (WS) Management GUI. This link is available to E-Verify

GUI Program Administrators associated with an employer who has WS-EMP. The WS

Management GUI provides WS users with a “one-stop shop” for information on WS, including

documentation and important news and information.

Exhibit 3 shows the Manage Web Services link in the Web Services Management GUI.

Exhibit 3: E-Verify GUI Showing Manage Web Services Link

For more information on the Web Services Management GUI, refer to the VIS System Design

Document, R9.0.0.0 (ITDL 182430).






2.0 DOCUMENT REFERENCES

The following document was used to produce this ICA:

Verification Information System (VIS) System Design Document (SDD), ITDL - 182430

3.0 CPS E-VERIFY WEB SERVICE INTERFACE

3.1 CPS E-Verify Web Service Interface Description

The VIS system hosts the CPS E-Verify Web Service on the CPS Web server. This server hosts

the Web service using Microsoft .NET Framework 4.0 and Windows Communication

Foundation (WCF). The client end points may be implemented in any technology supporting

standard SOAP/XML messaging standards. The WSDL file from version 25 and up introduced a

change in how elements are declared as required or non-required. For versions 25 and later

WSDLs, all of the elements now have a minimum occurrence of one. You must submit each

element tag found in the WSDL for all methods even when they are marked optional on every

request. If you are not submitting data for a specific element, then you may send it in as an

empty element, a zero for integer elements, or a null date. Do not use “nil=true” statements, just

empty tags. Also please note that the elements have to be in the same order as in the WSDL.

Communication access from employer systems to VIS is provided over the public Internet. All

messaging traffic between employer systems and VIS is via SOAP messages over HTTPS

communication. Exhibit 4 shows the major VIS architectural components and highlights the

primary components supporting this ICA.

Exhibit 4: Components Interface Diagram

Employer System

VIS

E-Verify

Employer Web Service

Employer

Application

Employer

End User

DHS Data

Provider Systems

Internet

USCIS Data

Provider Systems

3.2 CPS E-Verify Web Service Interface User Accounts and Authentication

The E-Verify Web Service authentication is based on UsernameToken authentication provided

as defined in the WS-Security (Web Service Security: SOAP Message Security 1.1

BasicHttpBinding or 1.2 WsHttpBinding (WS-Security 2004) Organization for the Advancement

of Structured Information Standards (OASIS) Standard 200401). Along with these two bindings

we use a security mode of "TransportWithMessageCredential" which means that a User ID and

Password is expected with each request (See Appendix H for sample incoming message). WS-

Security is an OASIS standard as of April 2004.

In the <UsernameToken> XML element (under <Security> SOAP header), the <Username>

child element contains the login ID. The <Password> child element contains the associated

password.




A sample SOAP authentication header would look something like:

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<wsse:Security soap:mustUnderstand="1">

<wsse:UsernameToken namespaces>

<wsse:Username>username</wsse:Username>

<wsse:Password Type="type info">password</wsse:Password>

<wsse:Nonce>nonce</wsse:Nonce>

<wsu:Created>date created</wsu:Created>

</wsse:UsernameToken>

<wsse:Security>

</soap:Header>

<soap:Body>

<WebServiceMethodName xmlns="Web Service Namespace" />

</soap:Body>

</soap:Envelope>

The username is the 8 character logon ID.

The password is the 8-14 character password associated with the logon ID transmitted in plain-

text. The https must be used to make the Web service call secure. Password construction rules

and usage policies are described in section 3. CPS E-Verify Web Service Interface User

Accounts and Authentication. All cases created using this Web service are associated with the

logon ID identified by username.

3.3 CPS E-Verify Web Service Functionality

3.3.1 CPS E-Verify Web Service Data Flow Characterization

This section depicts several example usage scenarios of the CPS Employer Web Service. Each

sample scenario is presented as a single UML sequence diagram. These diagrams depict the

invocation of E-Verify Web service business methods in the context of end-user initiated

business processes. These diagrams aid employer and E-Verify employer agents in developing

their interfaces to E-Verify. These diagrams depict and describe the calling order of methods

and responses received to accomplish the E-Verify processes.

Note: Web services integrators must allow for cases to be closed and rerun for the same hiring

event as certain conditions may require such actions.

3.3.1.1 Initial Verification Query Scenario

The initial employment eligibility verification scenario starts with the employer or E-Verify

employer agent submitting an initial verification query. In response, CPS interacts with SSA to

verify the Social Security number and interacts with the CPS database for Alien Registration,

Form I-94, Passport, and Visa numbers (i.e., when the employee attests to being a lawful

permanent resident or an alien authorized to work). The response code can indicate employment

authorized, invalid SSN data, duplicate case, or that the query was referred to DHS for additional

verification (see Appendix D, Table 78: “Initial Verification Response Codes”). When a




response code value of 08 or 16 (EMPLOYMENT AUTHORIZED) is returned, the user

typically closes the case. Sections 3.3.1.2 through3.3.1.12 address when the initial verification

query does not result in employment authorized.

Exhibit 5 depicts the call sequence where an employer’s (or E-Verify employer agent’s) Web

service client is used to perform employment eligibility verification. The client first calls the

EmpInitBPVerif method passing the required parameters (the USERID and password are passed

in the SOAP header). This method validates the input parameters and performs the initial

verification query.

Exhibit 5: Call Sequence for Initial Employment Eligibility Verification

EmpInitVerifResp21


ClientEmployer Web Service

EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp

Client closes case only if

a 0 (SUCCESSFUL) return

status code is returned

and the case is not sent

to additional verification.

EmpInitVerifResp25

The results of the query are passed back to the client via the EmpInitVerifResp message. If a

return status code of 0 (SUCCESSFUL) is returned, then the member EligStatementCd is

examined to determine the employee’s eligibility status. If the EligStatementCd has a response

code of 05 (INSITITUTE ADDITIONAL VERIFICATION), the case is automatically sent to

additional verification and AdditionalPerInd is set to Y to indicate this. All other response codes

are described in Appendix D, Table 78: Initial Verification Response Codes”.

In this scenario the case was not automatically sent to additional verification. The employer’s

(or E-Verify employer agent’s) Web service client calls the EmpCloseCase method to mark the

case closed. By doing this, the user is signaling that the case will not be subsequently modified

(i.e., submitted for additional verification). See Appendix D Table 82: Closure Codes and Table

83: Closure Codes Usage Based on Case “State”: ‘Employee Continues to Work for the

Employer for valid closure codes and case states for closure codes.

3.3.1.2 Initial Verification Query with Potential Duplicate Case Scenario

If the end user submits an initial verification attempt (EmpInitBPVerif, EmpInitDABPVerif) or

an SSA re-verification attempt (EmpSSAReVerify) query and the system detects an SSN that has

been submitted by any user within that company in the last 30 days, the system will send an

EligStatementCd of 41 and EligStatementTxt of “Duplicate Case” indicating that there is a

potential duplicate. It provides the opportunity to continue without changes, update the SSN

information, or close the case. The employer’s (or E-Verify employer agent’s) Web Service

client will call the EmpGetDuplicateCaseList to get a list of cases with the same SSN and then

has the option to call the EmpDupCaseContinueWithChanges,

EmpDupCaseContinueWithoutChanges, or EmpCloseCase methods.




The EmpDupCaseContinueWithChanges provides employers the chance to review and update

the SSN when a duplicate case response is returned during the initial or SSA re-verification

process.

The EmpDupCaseContinueWithoutChanges provides employers the opportunity to

acknowledge that a case is a duplicate, supply a reason for continuing, and continue the

processing of a duplicate case without changing any of the original input values.

If the employer deems the case a true duplicate, the employer can close a case after getting a

duplicate case message of 41 by calling the EmpCloseCase method, using the value "U" when

the "CurrentlyEmployed" element is present, and selecting one of the following closure codes

EmpGetClosureCodes: ISDP ̶ The case is a duplicate because the employer created a case with

the same data within the past 30 days; or INCDAT ̶ The case is invalid because the data entered

is incorrect.

Exhibit 6: Call Sequence for Initial Verification Query with Potential Duplicate Case



EmpInitAndAdditVerifResp

EmpInitAndAdditVerif()

EmpCloseCase()

EmpCloseCaseResp

Message code 41 received

and Client calls

EmpGetDuplicateCaseList

to retrieve potential dup

cases list.

EmpInitBPVerif()

EmpInitBPVerifResp25 (Message Code= 41)

EmpGetDuplicateCaseList

EmpGetDuplicateCaseListResp

EmpCloseCase()

EmpCloseCaseResp

EmpCloseCase()

EmpCloseCaseResp

EmpCloseCase()

EmpCloseCaseResp

EmpDupCaseContinueWithChangesResp

EmpDupCaseContinueWithChanges

Message code 41 received and

Client has the option to call

EmpDupCaseContinueWithChanges,

EmpDupCaseContinueWithoutChanges

to continue processing the case or

EmpCloseCase to close the case.

EmpDupCaseContinueWithoutChanges

EmpDupCaseContinueWithoutChangesResp

3.3.1.3 Employment Eligibility Verification Requests with Automatic Additional Scenario

If the employee claims to not be a U.S. citizen, CPS may not be able to resolve the request

through automated checks of its local databases. Should this happen, CPS will automatically

refer the request to DHS for processing. DHS will check other DHS databases, and sometimes

paper records, to resolve the case. Typically, it will take from one to three days for DHS to

research the case and provide a status. The user will periodically have to poll the CPS system to

pick up status on cases that have been referred to DHS for additional verification. Exhibit 7

shows this call sequence.




Exhibit 7: Call Sequence for Initial Employment Eligibility Verification with Automatic

Additional Verification

The employer’s (or E-Verify employer agent’s) Web service client first calls the EmpInitBPVerif

method passing the required parameters. This method validates the input parameters and

performs the initial verification query. CPS could not make a conclusive determination on the

initial verification query, so it automatically sends the request to DHS for additional verification

without the employer or E-Verify employer agent specifically having to request it.

The results of the query are passed back to the client via the EmpInitVerifResp message. If a

return status code of 0 (SUCCESSFUL) is returned, then the member EligStatementCd is

examined to determine the employee’s eligibility status. If the EligStatementCd has a response

code of 05 (INSITITUTE ADDITIONAL VERIFICATION), the case has automatically been

sent to additional verification and AdditionalPerInd is set to Y to indicate this. All other

response codes are described in Appendix D, Table 78: Initial Verification Response Codes. In

this scenario, the case was automatically sent to additional verification. Any case that is sent to

additional verification must have the response picked up at a later time. Cases submitted for

additional verification are manually researched/worked by DHS. This manual verification

process may take several days.

To retrieve additional verification query results, the Web service client calls the

EmpGetNextResolvedCaseNbrs method. This method returns either one or all of the case

numbers with SSA, DHS Additional, or DHS Referral responses or a status indicating that no

responses are available for viewing. The SearchType parameter in this method indicates whether

to return one or all of the resolved case numbers. The AcknowledgeFlg parameter indicates

whether or not to automatically delete the case number from the case response queue after

returning it to the Web service client. If the user does not use the automatic deletion, the Web



EmpInitVerifResp (Message Code = 05)


EmpGetNextResolvedCaseNbrs


EmpAckReceiptOfResolvedCaseNbr

EmpAckReceiptOfResolvedCaseNbrResp

EmpCloseCase

EmpCloseCaseResp

EmpInitBPVerif

SVS Case Mgt System

DHS MPA is assigned case and

works it. May take several

days to determine resolution.

Additional Verification Rsp

Ack method is called if

AcknowledgeFlg in

EmpGetNextResolved-

CaseNbrs

is set to "N".




service client must call the EmpAckReceiptOfResolvedCaseNbr method to delete the queue

entry. The results of this method are returned in the EmpGetNextResolvedCaseNbrsResp25

message. The results include the case number, case type (i.e., SSA, DHS Additional, or DHS

Referral) and the EligStatementCd and EligStatementStmt.

Once the Web service client successfully receives this data, the

EmpAckReceiptOfResolvedCaseNbr method must be called (i.e. if AcknowledgeFlg was set to

N in EmpGetNextResolvedCaseNbrs method) to cause the case to be deleted from the CPS case

response queue. If this method is not called or the queue entry is not automatically deleted, the

Web service client will receive the same case number(s) the next time the

EmpGetNextResolvedCaseNbrs method is called. The status of the

EmpAckReceiptOfResolvedCaseNbr operation is returned to the Web service client via the

EmpAckReceiptOfResolvedCaseNbrResp message.

After processing the additional verification query response, the Web service client calls the

EmpCloseCase method to mark the case closed.

3.3.1.4 Sending Case to Additional Verification Scenario

The E-Verify Web Service also provides the means for an employer or E-Verify employer agent

to manually request additional verification by DHS. This is done when there are discrepancies in

the initial verification query results (i.e., the name returned on the initial request does not match

the name on the documents provided by the employee). However, the user may only manually

request an additional verification if the initial verification query returned a response code of 08

(EMPLOYMENT AUTHORIZED) and the verification citizen type is 6 (lawful permanent

resident) or 7 (alien authorized to work). U.S. citizen and U.S. National cases may not be sent to

additional verification. Exhibit 8 depicts the call sequence where an employer’s (or E-Verify

employer agent’s) Web service client is used to perform employment eligibility verification,

submit the case for additional verification, and retrieve the additional verification query

response. The Web service client first calls the EmpInitBPVerif method passing the required

parameters. This method validates the input parameters and performs the initial verification

query. The results of the query are passed back to the Web service client via the

EmpInitVerifResp response object.




Exhibit 8: Call Sequence to Send Case to Additional Verification


Client Employer Web Service

EmpInitVerifResp

EmpSubmitAdditVerif()

EmpSubmitAdditVerifResp

EmpGetNextResolvedCaseNbrs()

EmpGetNextResolvedCaseNbrsResp

EmpAckReceiptOfResolvedCaseNbr()

EmpAckReceiptOfResolvedCaseNbrResp()

EmpCloseCase()

EmpCloseCaseResp

EmpInitBPVerif()

SVS Case Mgt System



DHS MPA is assigned

case and works it. May

take several days to

determine resolution.


AcknowledgeFlg in

EmpGetNextResolved-

CaseNbrs

is set to "N".

The Web service client then calls the EmpSubmitAdditVerif method with the case number of the

case to send to additional verification. Only when a response code of 08 (EMPLOYMENT

AUTHORIZED) is returned on the initial verification query may the user submit a case for

additional verification. The status of this operation is returned in the EmpAdditVerfResp

message. Any case that is sent to additional verification must have the response picked up at a

later time. Cases submitted for additional verification are manually researched/worked by DHS.

This manual verification process may take several days.

After issuing the EmpSubmitAdditVerif the employer must monitor the case response queue for

an additional verification query response. To retrieve additional verification query responses, the

Web service client calls the EmpGetNextResolvedCaseNbrs method. This method returns either

one or all of the case numbers with SSA, DHS Additional, or DHS Referral responses or a status

indicating that no responses are available for viewing. The SearchType parameter in this method

indicates whether to return one or all of the resolved case numbers. The AcknowledgeFlg

parameter indicates whether or not to automatically delete the case number from the case

response queue after returning it to the Web service client. If the user does not use the automatic

deletion, they must call the EmpAckReceiptOfResolvedCaseNbr method to delete the queue

entry. The results of this method are returned in the EmpGetNextResolvedCaseNbrsResp25

message. The results include the case number, case type (i.e., SSA, DHS Additional, or DHS

Referral), and the EligStatementCd and EligStatementStmt.


EmpAckReceiptOfResolvedCaseNbr method must be called (i.e., if AcknowledgeFlg was set to

N in EmpGetNextResolvedCaseNbrs method) to cause the case to be deleted from the CPS case





Web service client will receive the same case number the next time the




After processing the additional verification query response, the Web service client calls the

EmpCloseCase method to mark the case closed (see Appendix D, Table 82: Closure Codes).

3.3.1.5 SSA Referral

There are two scenarios supporting the SSA Referral business process. The first scenario depicts

the situation where the initial verification query returns a response code of 27 (SSA

TENTATIVE NONCONFIRMATION) for an employee who is not believed to have a

naturalization issue with their SSN (PotentialNaturalizedInd). In this case, the employee may

contest and go to SSA to have their issue resolved.

The second scenario depicts the situation in which the initial verification query returns a

response code of 27 (SSA TENTATIVE NONCONFIRMATION) for an employee who may

have a naturalization issue with their SSN. In this case, the employee may contest and has the

option to either go to SSA or DHS to resolve their issue.

3.3.1.5.1 SSA Referral

The SSN, employee name, and employee date of birth that employers provide as part of every

initial verification query are checked by SSA against its databases. If the SSN is not found or if

there is an inconsistency between the SSN, name, and/or date of birth, the employer will get an

initial verification response code of 27 (SSA TENTATIVE NONCONFIRMATION). The

employer should notify the employee of this determination before it refers the case to SSA. The

employee can then visit an SSA office and attempt to reconcile the data in SSA’s database.


service client is used to perform initial employment verification query, submit an SSA Referral,

and monitor the system for an SSA Referral response.




Exhibit 9: Call Sequence to Perform an SSA Referral



EmpInitVerifResp(PotentialNaturalizedInd = NULL)

EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp

EligstatementTxt =

"SSA TENTATIVE NONCONFIRMATION"

EmpSubmitSSAReferral()

EmpSubmitSSAReferralResp

Monitor "case response" queue

for an SSA Referral response by

calling EmpGetNextResolvedCaseNbrs.



SSA

SSA representative works SSA

referral through EV-STAR. May

take several days to determine

resolution.

SSA Referral

SSA Referral Rsp

EmpSaveSSATNCNotification()

EmpSaveTNCNotificationResp

Provide employee a copy of the Notice To

Employee Of Tentative NonConfirmation.

If employee chooses to contest, provide

employee with an SSA Referral letter (for

Not Naturalized Employee). System must notify CPS

that a SSA TNC notification was provided to an

employee by calling EmpSaveSSATNCNotification.

Notify CPS of the SSA Referral by calling

EmpSubmitSSAReferral.

The Web service client first calls the EmpInitBPVerif method passing the required parameters.

This method validates the input parameters and performs the initial verification query. The

results of the query are passed back to the Web service client via the EmpInitVerifResp message.

A response code of 27 (SSA TENTATIVE NONCONFIRMATION) is received in response to

the initial verification query. This indicates that SSA was unable to confirm the data provided in

the query (EmpInitBPVerif). This response does not necessarily mean that the employee is not

authorized to work. When this response is received, the employee should be provided a copy of

the Further Action Notice (FAN). Then the employee should be instructed to indicate on the

FAN whether or not they want to contest. If the employee chooses to contest, the employee

should be provided with a copy of the SSA FAN letter. If the employee wants to contest the

SSA Tentative Nonconfirmation the Web service client must signal to CPS that the employee has

been referred to the SSA by calling the EmpSubmitSSAReferral method. The status of the

method call is passed back to the Web service client via the EmpSubmitSSAReferralResp25

message. The employee has eight federal government workdays from the date of referral to

contact their local SSA office.

Before invoking EmpSubmitSSAReferral method, the Web service client is required to call first

EmpSaveSSATNCNotification method to notify CPS that the employee has been notified of the

SSA TNC. After issuing the EmpSubmitSSAReferral the user must monitor the case response

queue for an SSA Referral response. To retrieve SSA Referral results, the Web service client

calls the EmpGetNextResolvedCaseNbrs method. This method returns either one or all of the

case numbers with SSA, DHS Additional or DHS Referral responses or a status indicating that

no responses are available for viewing. The SearchType parameter in this method indicates

whether to return one or all of the resolved case numbers. The AcknowledgeFlg parameter

indicates whether or not to automatically delete the case number from the case response queue

after returning it to the Web service client. If the user does not use the automatic deletion, they




must call the EmpAckReceiptOfResolvedCaseNbr method to delete the queue entry. The results

of this method are returned in the EmpGetNextResolvedCaseNbrsResp25 message. The results

include the case number, case type (i.e., SSA, DHS Additional, or DHS Referral) and the

EligStatementCd and EligStatementStmt.


EmpAckReceiptOfResolvedCaseNbr method must be called (i.e., if AcknowledgeFlg was set to

N in EmpGetNextResolvedCaseNbrs method) to cause the case to be deleted from the cases


Web service client will receive the same case number the next time the




3.3.1.6 SSA Resubmittal

An SSA Resubmittal is issued in response to an SSA Referral response code of 35 (Review and

Update Employee Data Then Resubmit Case). This reissues the initial verification query.

Exhibit 10 depicts the call sequence in which an employer’s (or E-Verify employer agent’s) Web

service client is used to monitor the system for an SSA Referral response and issue an SSA

Resubmittal based on the SSA Referral response code of 35 (Review and Update Employee Data

Then Resubmit Case)

Exhibit 10: Call Sequence to Perform an SSA Resubmittal



EmpGetNextResolvedCaseResp

EmpGetNextResolvedCaseNbrs()If a response code of 35

(Review and Update Employee

Data Then Resubmit) call

EmpSSAResubmittal to

resubmit the case to SSA.



Monitor "case response" queue

for an SSA Referral response by

calling EmpGetNextResolvedCaseNbrs

EmpSSAResubmittal()

EmpSSAResubmittalResp


AcknowledgeFlg in

EmpGetNextResolved-

CaseNbrs

is set to "N".

EmpCloseCaseResp

EmpCloseCase()

If SSA Resubmittal returns a

response code of

08 (EMPLOYMENT AUTHORIZED)

or 28 (SSA Final Nonconfirmation)

close the case.

After issuing the EmpSubmitSSAReferral, the Web service user must monitor the case response

queue for an SSA Referral response. To retrieve SSA Referral results, the Web service client

calls the EmpGetNextResolvedCaseNbrs method. This method returns either one or all of the

case numbers with SSA, DHS Additional, or DHS Referral responses or a status indicating that




no responses are available for viewing. The SearchType parameter in this method indicates

whether to return one or all of the resolved case numbers. The AcknowledgeFlg parameter

indicates whether to automatically delete the case number from the case response queue after

returning it to the Web service client. If you do not use the automatic deletion, you must call the

EmpAckReceiptOfResolvedCaseNbr method to delete the queue entry. The results of this

method are returned in the EmpGetNextResolvedCaseNbrsResp25 message. The results include

the case number, case type (i.e., SSA, DHS Additional, or DHS Referral) and the


Once the client successfully receives this data, the EmpAckReceiptOfResolvedCaseNbr method

must be called (i.e., if AcknowledgeFlg was set to N in EmpGetNextResolvedCaseNbrs method)

to cause the case to be deleted from the case response queue. If this method is not called or the

queue entry is not automatically deleted, the client will receive the same case number the next

time the EmpGetNextResolvedCaseNbrs method is called. The status of the

EmpAckReceiptOfResolvedCaseNbr operation is returned to the client via the


If a response code of 35 (Review and Update Employee Data Then Resubmit) is returned from

SSA, via SSA Referral response, the user must call EmpSSAResubmittal to resubmit the initial

verification query with the appropriate input data. The status of the case (i.e., employment

authorized, final nonconfirmation, DHS verification in progress) is returned in the

EmpSSAResubmittalResp message.

3.3.1.7 DHS Referral

The employer or E-Verify employer agent may receive a code of U (DHS TENTATIVE

NONCONFIRMATION) in response to an additional verification query. The employer should

notify the employee of this determination. The employee then has the option of contacting DHS

in order to present additional data that might cause DHS to reconsider the DHS Tentative

Nonconfirmation (TNC). The employer must ask the employee whether they choose to contest

the case. If the employee chooses to contest, the employer would then initiate a DHS Referral

(i.e., third-step). This is a means to tell CPS and DHS that the employee will be contesting a

DHS TNC. The employee has eight federal government workdays to contact DHS. The user

will have to poll CPS for the DHS response to the third-step referral.


service client is used to perform initial verification, submit a case for additional verification,

retrieve an additional response, submit a DHS referral, retrieve the DHS referral response, and

close the case.




Exhibit 11: Call Sequence to Perform a DHS Referral



EmpInitVerifResp





EmpInitBPVerif()

EmpCloseCase()EmpCloseCaseRespEligstatementTxt = "DHS

TENTATIVE NONCONFIRMATION"

EmpSubmitDHSReferral

EmpSubmitDHSReferralResp





SVS Case Mgt System



DHS Referral

DHS Referral Rsp

DHS MPA is assigned

case and works it.

May take several days

to determine resolution.

DHS MPA talks to

the employee

and processes the

referral.

EmpSaveDHSTNCNotification()

EmpSaveTNCNotificationResp

If employee chooses to contest,

provide employee with a DHS

Referral letter and notify CPS

that a DHS TNC notification was provided

to an employee by calling

EmpSaveDHSTNCNotification. Then notify

CPS of the DHS Referral.

(EmpSubmitDHSReferral)

The Web service client first calls the EmpInitBPVerif method passing the required parameters.

This method validates the input parameters and performs the initial verification query. The

results of the query are passed back to the Web service client via the EmpInitVerifResp message.

In this example the case is automatically sent to additional verification. Any case that is sent to

additional verification must have the response picked up at a later time. Cases submitted for

additional verification are manually researched/worked by DHS. This manual verification

process may take several days, so clients may submit multiple cases for additional verification

before retrieving the results.

Once a case is sent to additional verification, the user must monitor the case response queue for a

DHS additional resolution response (see Appendix D, Table 80: DHS Additional Resolution

Codes). To retrieve DHS additional verification results, the Web service client calls the

EmpGetNextResolvedCaseNbrs method. This method returns either one or all of the case

numbers with SSA, DHS Additional or DHS Referral responses or a status indicating that no

responses are available for viewing. The SearchType parameter in this method indicates whether

to return one or all of the resolved case numbers. The AcknowledgeFlg parameter indicates

whether or not to automatically delete the case number from the case response queue after




returning it to the Web service client. If you do not use the automatic deletion, you must call the

EmpAckReceiptOfResolvedCaseNbr method to delete the queue entry. The results of this

method are returned in the EmpGetNextResolvedCaseNbrsResp25 message. The results include

the case number, case type (i.e., SSA, DHS Additional, or DHS Referral) and the


Once the client successfully receives this data, the EmpAckReceiptOfResolvedCaseNbr method

must be called to cause the case to be deleted from the CPS case response queue. This method

call is not needed if the AcknowledgeFlg parameter in the EmpGetNextResolvedCaseNbrs call is

set to Y (i.e., automatically delete queue entry). If the queue entry is not deleted the client will

receive the same case number the next time the EmpGetNextResolvedCaseNbrs method is

called. The status of the EmpAckReceiptOfResolvedCaseNbr operation is returned to the client

via the EmpAckReceiptOfResolvedCaseNbrResp message.

If a response code of U (DHS TENTATIVE NONCONFIRMATION) is received in the

EmpGetNextResolvedCaseNbrsResp25 message, the employer must notify the employee of the

DHS Tentative Nonconfirmation (TNC) and determine whether the employee wants to contest it

or not.

If the employee wants to contest the DHS TNC, a referral notice is sent to the DHS by calling the

EmpSubmitDHSReferral method with a date of referral parameter. The status of the method call

is passed back to the client via the EmpSubmitDHSReferralResp25 message. The employee has

eight federal government workdays from the date of referral to resolve the discrepancy in their

case by contacting DHS and providing DHS with their verification number and other information

on the referral notice.

Before invoking EmpSubmitDHSReferral method, the Web service client is required to call first

EmpSaveDHSTNCNotification method to notify CPS that the employee has been notified of the

DHS TNC.The system should then be checked periodically for a referral response using the same

methods used to poll and retrieve the additional response (i.e., EmpGetNextResolvedCaseNbrs,

EmpAckReceiptOfResolvedCaseNbr). Once the referral has been processed, the EmpCloseCase

method should be called to close the case.

3.3.1.8 SSA ReVerify

Exhibit 12 depicts the call sequence required after receiving an EligStatementCd of 36 on an

initial verification attempt. A code of 36 indicates that one of the SSA required parameters was

found to be in error and, instead of returning an SSA TNC, a code of 36 is returned, which

provides employers with a second chance for a successful verification before an SSA TNC is

returned to the employer.

The call sequence includes: a call to EmpInitBPVerif to submit an initial verification, a returned

eligibility code of 36, a call to EmpSSAReVerify with all of the SSA required parameters, a

returned eligibility code of 8, a call to EmpCloseCase to close the case, and a good return

response from the close call.




Exhibit 12: Call Sequence to Perform a SSA ReVerify



EmpInitVerfResp9 (36)

EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp

EligStatementCd = 36

EligstatementTxt =

"Verification Incomplete"

EmpSSAReVerify

EmpInitVerfResp9EligStatementCd = 8

EligstatementTxt =

"Employment Authorized"

EmpInitVerifResp25 (36)

EmpInitVerifResp25

3.3.1.9 DHS ReVerify


initial verification attempt. A code of 30 indicates that one of the DHS required parameters was

found to be in error and instead of sending the case to SVS for additional (second step)

processing, a code of 30 is returned, which provides employers with a second chance for a

successful verification before the case is sent to SVS for additional processing.


eligibility code of 30, a call to EmpDHSReVerify with all of the DHS required parameters (the

required parameter depends on the citizenship and document types used in the initial

verification), a returned eligibility code of 8, a call to EmpCloseCase to close the case, and a

good return response from the close call.




Exhibit 13: Call Sequence to Perform a DHS ReVerify




EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp


EligstatementTxt =


EmpDHSReVerify

EmpInitVerfResp21(8)EligStatementCd = 8

EligstatementTxt =




3.3.1.10 Confirm Photo


initial verification attempt (this applies to photos returned as a result of verifications of Legal

Permanent Residents (LPRs), Aliens Authorized to Work, or U.S Citizens with passport

documents). A code of 31 indicates that a photo of the employee being verified was found during

the initial verification process and a confirmation of the photo is required by the issuing

employer. The employer is required to compare the returned photo against the employee’s

documentation and call the EmpConfirmPhoto method confirming or rejecting the

photo/verification.


eligibility code of 31, a call to EmpEmpConfirmPhoto confirming or rejecting the photo

(confirming in this example), a returned eligibility code of 8, a call to EmpCloseCase to close the

case, and a good return response from the close call.




Exhibit 14: Call Sequence to Perform a Confirm Photo




EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp


EligstatementTxt =


EmpConfirmPhoto ("Y")

EmpConfirmPhotoRespEligStatementCd = 8

EligstatementTxt =



3.3.1.11 Reject Photo


initial verification attempt (this applies to photos returned as a result of verifications of LPRs,

Aliens Authorized to Work, or U.S Citizens with passport documents). A code of 31 indicates

that a photo was found of the employee being verified during the initial verification process and

a confirmation of the photo is required by the issuing employer. The employer is required to

compare the returned photo against the employee’s documentation and call the

EmpConfirmPhoto method confirming or rejecting the photo/verification. When a photo is

rejected by an employer an eligibility code of 29 is returned which indicates that the employer

must start the DHS referral process instead of sending the case to SVS for additional (second

step) processing. Photo confirmation takes the place of second step processing.


eligibility code of 31, a call to EmpEmpConfirmPhoto confirming or rejecting the photo

(rejecting in this example), a returned eligibility code of 29, a call to EmpSubDHSReferral, a

referral return status, a call to EmpGetNextResolvedCaseNbrs to check the queue for a resolution

from the referral (third step) call, a response from the getnext call, a call to EmpCloseCase to

close the case, and a good return response from the close call.




Exhibit 15: Call Sequence to Perform a Reject Photo




EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp


EligstatementTxt =


EmpConfirmPhoto ("N")

EmpConfirmPhotoRespEligStatementCd =29

EligstatementTxt =

DHS TENTATIVE NONCONFIRMATION"

EmpSubDHSReferral






3.3.1.12 Combined Flow

Exhibit 16 depicts the call sequence combining EmpSSAReVerify, EmpDHSReVerify, and

EmpConfirmPhoto.


eligibility code of 36, a call to EmpSSAReVerify, a returned eligibility code of 30, a call to

EmpDHSReVerify, a returned eligibility code of 31, a call to EmpEmpConfirmPhoto confirming

or rejecting the photo (rejecting in this example), a returned eligibility code of 29, a call to

EmpSubDHSReferral, a referral return status, a call to EmpGetNextResolvedCaseNbrs to check

the queue for a resolution from the referral (third step) call, a response from the getnext call, a

call to EmpCloseCase to close the case, and a good return response from the close call.




Exhibit 16: Call Sequence to Show a Combined Flow




EmpInitBPVerif()

EmpCloseCase()

EmpCloseCaseResp


EligstatementTxt =


EmpConfirmPhoto ("N")

EmpConfirmPhotoResp

EligStatementCd =29

EligstatementTxt =

DHS TENTATIVE NONCONFIRMATION"

EmpSubDHSReferral




EmpSSAReVerify


EligstatementTxt =

"Verification Incomplete" EmpDHSReVerify


EligstatementTxt =






3.3.1.13 CPS Employment Eligibility Verification State Machine

The employment eligibility verification business process is validated against a state machine.

This ensures that employer (or E-Verify employer agent) Web service client calls to the various

E-Verify Web service methods are performed in the correct order. Exhibit 17 depicts the CPS

employment eligibility verification state machine.

Each state is identified by a four-character code. The state machine starts with the state PRCV

and ends with the state CRCV. The flows connecting the states identify the actions that

transition a case from one state to the next state.

For example, when the employer (or E-Verify employer agent) initiates the employment

eligibility verification, the case is created and the case is placed in the PRCV state. If the Web

service client calls the EmpSubmitSSAReferral method, the case transitions to the PRSS state.

While in this state, the only valid method that may be called is EmpGetNextResolvedCaseNbrs.

All Web methods are validated against this state machine. If a Web method is called when the

case is not in the appropriate state, an error is returned to the caller indicating that the requested

action may not be performed while the case is in the current state.

Also notice that while the case is in the states FCOR or FCOV, the client may retrieve additional

resolution information by calling the EmpGetNextResolvedCaseNbrs method (see Appendix D,

Table 80: DHS Additional Resolution Codes).




Also notice that while the case is in the states FCO3, or S3CV the client may retrieve DHS

Referral Resolution codes (third-step) information by calling the EmpGetNextResolvedCaseNbrs

method (see Appendix D Table 81: DHS Referral Resolution Codes “DHS Referral Resolution

Codes”).




Exhibit 17: CPS Employment Eligibility Verification State Machine

Primary Received

States

SSA Domain

Managed States

FCOS

FCOR

FCOV

CRCV

04/26/2010 R4.0

U:\Workareas\DesignTeam\CaseStateSequenceFlows\

CaseStateMachineV27.vsd

Updated for Release 7.0

States

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

CRCV - Closure Received

FCO3 - Sent 3rd

Step

FCOR - 2nd

Step Continuance Received

FCOS - Sent Secondary

FCOV - Resolved Secondary

FSRR - Resolved 3rd

Step

PRCV - 1st Initial Verification

PRC2 – 2nd

Initial Verification Performed (on SSA reverify)

PRSS - SSA Referral

PRRS - SSA Referral Completed

PRS2 – DHS Indicates SSA must resolve SSA Referral

S3CV - 3rd

Step Continuance Received

PRRD - DHS Resubmittal

PPVR - Photo Verified

SSAC – SSA Pending – Need Required Docs from New Hire

(Case In Continuance)

SSAV – SSA Pending – SSA Validation of Docs Needed

SSAF – SSA Final – Final Disposition

TNCR – First TNC resolved (e.g., Fraud Alert), SSA TNC

Pending

Message Codes

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

05 - Institute Additional Verification

08 - Employment Authorized

17 - SSA Employment Not Authorized

27 - SSA Tentative Non-Confirmation

29 - DHS Tentative Non-Confirmation

30 – DHS Verification Incomplete (user to confirm inputs)

31 – DHS Verification Incomplete (when photo is avail)

33 - DHS Verification in Process

35 - Review and Update Employee Data then Resubmit

36 – SSA Verification Incomplete (user to confirm inputs)INITIATE_SECONDARY

(System Initiates

Secondary current

msg_code = 05)

INITIATE_SECONDARY

(User Initiates

Secondary

current

msg_code = 08)

SECONDARY_CONTINUANCE

(ISV Requests

Secondary

Continuance)

RESOLVE_SECONDARY

(ISV Resolves

Secondary)

RESOLVE_SECONDARY

UISV Resolves Secondary)

3RD

_STEP_REQUEST

(User Performs

DHS Referral

Request)

CLOSE_CASE

(User Closes

Case)

RESOLVE_3RD

_STEP

(ISV Resolves

DHS Referral)

CLOSE_CASE

(User Closes

Case)

CLOSE_CASE

(User Closes)

Case

New CPS Employment Verification State Machine

Both Trans 20 and Trans 40

All Access Methods

3RD

_STEP_CONTINUANCE

(ISV Requests

3rd

Step Continuance)

RESOLVE_3RD

_STEP

ISV Resolves

DHS Referral

PRCV

User Initiates

Employment Verification,

Dup Not Found

PRSS

PRRS

CLOSE_CASE

(User Closes

Case)

INITIATE_SECONDARY

(User Initiates

Secondary

current

msg_code = 08)

INITIATE_SECONDARY

(System

Initiates

Secondary current

msg_code = 05)

User Initiates

SSA Resubmittal

CLOSE_CASE

(User Closes

Case)

CLOSE_CASE

(User Closes

Case)

SECONDARY_CONTINUANCE

(ISV Requests

Secondary Continuance)

3RD

_STEP_CONTINUANCE

ISV Requests

3rd

Step

Continuance

RESOLVE_SECONDARY

(ISV Resolves

Secondary)

REROUTE_CASE

(Case Is Rerouted

Between FCOs)

DHS_RESUBMITTAL

(User Initiates

DHS Resubmittal

Current msg_code=30)

DHS_RESUBMITTAL

(User Initiates

DHS Resubmittal

current

msg_code=30)

INITIATE_SECONDARY

(User Initiates

Secondary current

msg_code = 08)

CLOSE_CASE

(User Closes

Case)

VERIFY_PHOTOGRAPH

(User Verifies

Photocurrent

msg_code=31)

INITIATE_SECONDARY

(System Initiates

Secondary current

msg_code = 05)

3RD

_STEP_REQUEST

User Performs

DHS Referral

Request

current

msg_code = 29, 33,38

INITIATE_SECONDARY

User Initiates

Secondary

Current msg_code = 08)

CLOSE_CASE

(User Closes

Case)

VERIFY_PHOTOGRAPH

(User Verifies Photo

Current msg_code=31)

VERIFY_PHOTOGRAPH

User Verifies

Photo current

msg_code=31)

Msg_code 29

returned when

user indicated

card data does

not match.

Msg_code 33

returned when

user indicated “I

don’t know” on

card match.

User indicated

card data does

match but

something else

wrong.

SSAC SSAV

CLOSE_CASE

(User Closes

Case)

SSA_RESPONSE_RECEIVED

SSA_AUTO_RSP_DOC_REQ

SSA_AUTO_RSP_DOC_VERIF

(Employee Appears At SSA)


(SSA Determines

Final Disposition)


(SSA Needs to Verify Docs)


(SSA Needs Docs from New Hire)


(SSA Determines

Final Disposition)


(SSA Determines

Final Disposition)



SYSTEM_ABANDONS_CASE

(System Initiates

SSA Resubmittal

When Abandon Case)

PRC2

SSA_REFERRAL

(User Performs

SSA Referral

current

msg_code = 17 or 27

[SSA Tentative Non Conf.])SSA_REVERIFY

(User Performs

SSA Reverify

current

msg_code = 36),

DUP Not found

SSA_RESUBMITTAL

(System Initiates

SSA Resubmittal

When No Show)

Goes away

after

Trans 20 is

deprecated

System Derives

Eligibility Stmt.

User Initiates

SSA Resubmittal

current

or

Web Service user

Initiates resubmittal

Only for cases

that are referred

to SSA before

EV-Star goes

live. Goes away

after last “old”

case is

resubmitted by

user.

PRS2




(Employee Appears At SSA)

SSA_REFERRAL_FROM_DHS

msg_code = 27

(DHS Indicates

SSA Must Resolve Referral)

RESOLVE_3RD

_STEP

(NATZ - DHS Determines

Final Disposition

[Emp Auth])

CLOSE_CASE

(User Closes

Case)

REROUTE_CASE

3RD

_STEP_

CONTINUANCE

RESOLVE_3RD

_STEP

(ISV Resolves

DHS Referral)

RESOLVE_3RD

_STEP

And msg_code = 29 or 38

(ISV Resolves

DHS Referral)

3RD

_STEP_CONTINUANCE

(ISV Requests

3rd

Step Continuance)

3RD

_STEP_CONTINUANCE

(ISV Requests

Msg_code = 29 or 38

3rd

Step Continuance)

3RD

_STEP_REQUEST

User Performs

DHS Referral

Request

current

msg_code = 38

FCO3

3RD

_STEP_REQUEST

User Performs

DHS Referral

Request

current

msg_code = 38

3RD

_STEP_REQUEST

User Performs

DHS Referral

Request

current

msg_code = 38

S3CV

3RD

_STEP_CONTINUANCE msg_code = 38

(ISV Requests

3rd

Step Continuance)

3RD

_STEP_CONTINUANCE

And msg_code = 38

(ISV Requests

3rd

Step Continuance)

PRRD

3RD

_STEP_CONTINUANCE msg_code = 38

(ISV Requests

3rd

Step Continuance)

PPVR

FSRR

RESOLVE_3RD

_STEP

and msg_code = 38

(ISV Resolves

DHS Referral)

RESOLVE_3RD

_STEP

and msg_code = 38

(ISV Resolves

DHS Referral)

RESOLVE_3RD

_STEP

and msg_code = 38

(ISV Resolves

DHS Referral)


msg_code = 27


DHS Natz II Resolution

TNCR

TNC_RESOLVED_SSA_TNC_PENDING

(e.g., Fraud Alert TNC Resolved)




msg_code = 27

(SSA Tentative Non Conf





(SSA Determines

Final Disposition)

SSAF


(SSA Needs Docs from New Hire)



IDUP

User Initiates

Employment Verification,

Dup Found

Continue Verification

(With or

Without changes)

Dup Found

Continue Verification

(With or

Without changes)

Dup Not Found

PDUP

Continue SSA ReVerification

(With or

Without changes)

Dup Found

Continue SSA ReVerification

(With or

Without changes)

Dup Not Found

SSA_REVERIFY

(User Performs

SSA Reverify

current

msg_code = 36),

DUP Found




3.3.2 CPS E-Verify Web Service Protocol and Transfer Method

This service is accessible via a Web service (SOAP over HTTPS). This Web service API is

defined as a set of Hypertext Transfer Protocol Secure (HTTPS) request messages along with a

definition of the structure of response messages, expressed in an Extensible Markup Language

(XML). This interface conforms to the SOAP specifications as defined by the World Wide Web

Consortium (W3C) Recommendation.

This Web service is accessible to employers via the public Internet.

All Web service method invocations are processed by VIS immediately in real-time immediately

upon receipt. The Web service methods all support concurrency in that VIS may process

multiple invocations of the Web service methods as the same time.

All methods are implemented using a synchronous model; a request is received by VIS; the

caller waits until VIS returns the Web method response. All Web service methods are processed

in the order in which they are received.

3.3.3 CPS E-Verify Web Service Data Format and Content

3.3.3.1 CPS E-Verify Web Service Message Layout

The following section defines the set of methods that will be provided by the E-Verify Web

Service access method. These sections are intended to provide only an overview of the

parameters. The following sections do not provide the formal specification of the E-Verify Web

Service access method. As a result of the WFC transitions, please note that all elements must be

present even if they are optional. You can pass an empty tag for optional fields. Do not use

“nil=true” statements, just empty tags. For the complete formal specifications of E-Verify Web

Service visit the following URL:

https://stage.e-verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc?WSDL

This section defines the set of E-Verify Web service methods. Each Web service method accepts

one or more input parameters and returns a single response object. The response object contains

a set of output parameters. The last two parameters in each response object indicate whether the

call to the Web service method was successful.

The calls to the Web service methods are contained in a SOAP Message. Exhibit 18 shows the

format for a SOAP Message.




Exhibit 18: SOAP Message Layout

A SOAP message is encoded as an XML document, consisting of an <Envelope> element, which

contains an optional <Header> element, and a mandatory <Body> element.

The SOAP envelope

The SOAP <Envelope> is the root element in every SOAP message, and contains two

child elements, an optional <Header> and a mandatory <Body>.

The SOAP header

The SOAP <Header> is an optional sub-element of the SOAP envelope, and is used to

pass application-related information that is to be processed by SOAP nodes along the

message path.

The SOAP body

The SOAP <Body> is a mandatory sub-element of the SOAP envelope, which contains

information intended for the ultimate recipient of the message.

3.3.3.1.1 EmpInitBPVerif Content and Format

This method performs the initial verification for employers. It allows employers to verify the

employment eligibility of all newly hired employees. Employee identification information is

passed into this method through 30 input parameters. The employee’s employment eligibility is

returned in an eligibility response code output parameter. The response code indicates: the

employee is authorized for employment; a problem was encountered during the SSA check, DHS

check; or, the employment eligibility verification request was automatically sent to DHS for

manual resolution because the verification was inconclusive.

If a problem occurs during the SSA check or DHS check and eligibility code of 42 (Verification

in Process) is returned, then the initial verification is pending and the case is placed on a case

reprocessing queue. The employer must poll the CPS system (EmpGetNextResolvedCaseNbrs

method) for the initial verification response when the eligibility code of 42 is received.

If a problem occurs during the SSA check or DHS check and eligibility code of 43 (Unable to

Process) is returned, then the initial verification is completed and the case cannot be processed. It

is expected that the employer will create a new case for the employee.




If a problem occurs during the SSA check, an eligibility code of 36 is returned requiring the

employer to issue an EmpSSAReVerify to re-verify the SSA required data. This is done to try to

avoid SSA TNCs. The same processing applies to the DHS check, except an eligibility code of

30 is received and the EmpDHSReVerify method is called.A photo may be returned in the results

of an initial verification. An eligibility code of 31 will accompany the photo that indicates that

the issuing employer is required to confirm or reject the photo by calling the EmpConfirmPhoto

method.

There is no way to know which non-U.S. citizen cases will be automatically sent to DHS for

additional verification. A single flag in the output indicates the case was sent for additional

verification. As with the EmpSubmitAdditVerif method, the user must pick up the DHS

additional response at a later time. This is performed using the EmpGetNextResolvedCaseNbrs

method.

The EmailAddress parameter, which captures the employee’s email address, was recently added.

This field is optional. If the initial verification of the case or any subsequent processing event

results in a SSA TNC or DHS TNC, a notification email is sent out to the employee using this

email address. The system also uses the email address captured in this field to send out NATZ

reminder notification. If the sending of email notification fails for any reason, (e.g. the email

address provided is incorrect or the SMTP server is unavailable), an error is not returned by the

system.

Table 1: EmpInitBPVerif Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description

ClientSftwrVer string 1 30 N The version number of the employer’s (or

E-Verify employer agent’s) Web service

client that is calling this method.

LastName string 1 40 Y Employee’s last name. May contain only

alphabetic characters, spaces, and single

quotes. Other special characters and

numbers are not allowed.

FirstName string 1 25 Y Employee’s first name. May contain only




MiddleInitial string 1 1 N The first letter of the middle name of the

employee.

OtherNamesUsed string 1 40 N Other names that the employee may have

used. May contain only alphabetic

characters, spaces, and single quotes.

Other special characters and numbers are

not allowed.

SSNNumber string 9 9 Y Employee’s SSN. The SSN should

contain only numbers with no spaces or

special characters.

EmailAddress string 1 60 N Employee’s email address. Must follow a

valid e-mail format (e.g.




Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description

[email protected])

BirthDate dateTime N/A N/A Y Employee’s birth date. Date is in XML

date format YYYY-MM-DD.

This cannot be a future date.

HireDate dateTime N/A N/A Y The hire date in XML date format

YYYY-MM-DD. The hire date must be

between 11/07/1986 and current date +

365 days.

OverDueVerifyReason string 1 60 Y/N An employee must be verified through E-

Verify within 3 days of hire date. If

he/she is not, an OverDueVerifyReason

must be provided. If an overdue reason is

not provided an error is returned. See

Appendix D Table

“OverDueVerifyReason Valid Values ”

for valid overdue reasons.

OverDueVerifyReasonOther string 1 200 Y/N If LATE_HIRE_DT_RSN_OTHER is

provided in the OverDueVerifyReason

field, this field must contain free-form

text explaining the reason for the late

verification. Otherwise this field must be

blank.

CitizenshipStatus Int 1 1 Y Employee’s declared citizenship flag.

Must be one the following values:

4 = A citizen of the United States

5 = A noncitizen national of the United

States

6 = A lawful permanent resident

7 = An alien authorized to work

For a mapping of Citizenship types and

Document types refer to Table 77: DHS

Document Types.

AlienNumber string 9 9 Y/N The 9-digit Alien Registration Number

(ARN). If the presented DHS document

has this field as 8 digits, then zero fill

from the left so that what is passed is

exactly 9 digits.

Must be blank when the citizenship flag =

4 (A citizen of the United States) or 5 (A

noncitizen national of the United States).

Must contain the ARN when the

citizenship flag = 6 (A lawful permanent

resident).

May contain the ARN when

CitizenshipStatus = 7 (An alien

authorized to work). Either the

AlienNumber or the I94Number field




Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description

must have a value when

Citizenshipstatus = 7 (An alien

authorized to work) and DocumentId

not equal to 28.

Either the AlienNumber or the

I94Number or Foreign Passport

Number field must have a value when

CitizenshipStatusCode = 7 and

DocumentId = 28.

I94Number string 11 11 Y/N This is an alien’s admission number. The

Form I-94 number must be zero filled

from the left so that it is 11 characters.

May contain the Form I-94 number

when CitizenshipStatus = 7 (An alien

authorized to work). Either the

AlienNumber or the 194Number field

must have a value when


authorized to work) and DocumentId

not equal to 28.

Either the AlienNumber or the

194Number or Foreign Passport

Number field must have a value when

CitizenshipStatusCode = 7 and

DocumentId = 28.

CardNbr string 13 13 Y/N Card number must be exactly 3 alphabetic

characters [A-Z] followed by 10 digits [0-

9].

This field is required when

CitizenshipStatus = 6 and

DocumentId = 13 (I-551) or


DocumentId = 17 (I-766)

PassPortNumber (foreign)

PassPortNumber (U.S)

string

string

6

6

12

9

Y/N

Y/N

If the input parameter is a foreign

passport the field can be between 6 and

12 alphanumeric characters.

If the input parameter is a U.S. passport

the field can be between 6 and 9

alphanumeric characters.

This field is required if:

(CitizenshipStatus = 4 (A citizen of the

United States) or CitizenshipStatus = 5 (A

noncitizen national of the United States))

and Document Id= 29 (U.S. Passport or




Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description

Passport Card)


authorized to work) and DocumentId = 24

(foreign passport with Form I-94 Stamp).

CitizenshipStatus = 6 (A lawful

permanent resident) and DocumentId

= 25 (foreign passport with Form I-

551 Stamp).


DocumentId = 28

(Either the AlienNumber or the

194Number or Foreign Passport

Number field must have a value)

NoForeignPassport string 0 0 N This field must be left empty due to Form

I-9 changes. .

CountryOfIssuance string 3 3 Y/N A foreign passport is an official document

issued by the government of a foreign

country. If you enter a foreign passport

number in E-Verify, you must also select

the country that issued the passport from

the country of issuance list ONLY for

citizenship type 7. Refer to Appendix D

Table for a list of valid country codes or

call the GetCountryOfIssuanceList

method to retrieve the latest list of COI

country codes. This data is subject to

change.

VisaNumber string 8 8 N This field is 8 alphanumeric characters

long.


authorized to work) and DocumentId = 24

(foreign passport with Form I-94 Stamp).

DocumentID

int N/A N/A Y This ID describes the document type

presented by the employee. See Table 77:

DHS Document Types for valid

document types. The document type must

also be compatible with the selected

citizenship flag.

ListBDocumentId int N/A N/A Y/N This ID describes the List B document

type presented by the employee. See

Appendix D, Table 77: for valid

document types. This field is required

when DocumentID contains a 28 (List B

and C Documents) otherwise it should be

null.

ListCDocumentId int N/A N/A Y/N This ID describes the List C document




Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description


Table 77: DHS Document Types for valid

document types. This field is required

when DocumentID contains a 28 (List B

and C Documents) otherwise it should be

null.

SupportingDocumentId int N/A N/A Y/N This ID describes a Supporting Document


Appendix D, Table 77: DHS Document

Types for valid document types. This

field is required when ListBDocumentId

contains a 1 (Driver's license or ID card

issued by a U.S. state or outlying

possession) otherwise it should be null.

This field describes the type of DMV

query to perform.

StateIssuingAuthority string 2 2 Y/N This field contains the state that issued

the driver’s license or state ID card that is

being used as a List B document. See

Appendix D, Table 90: for valid Issuing

Authorities. This field is required when

ListBDocumentId contains a 1 (Driver's

license or ID card issued by a U.S. state

or outlying possession) otherwise it

should be null.

DMVDocumentNbr string 1 25 Y/N This is an alpha-number document

number (driver’s license or state ID card

number). This field is required when

ListBDocumentId contains a 1 (Driver's


or outlying possession) and the

StateIssuingAuthority supports E-Verify

and the SupportingDocumentId presented

(you can find the states that support E-

Verify by calling the

EmpGetIssuingAuthorities method. The

states that show a supporting document

support E-Verify. A state may support

multiple “supporting documents”)

otherwise this field should be null.

* The validation on this field will be on a

per StatIssuingAuthority (state) basis.

Some states allow alpha-numeric while

other states only allow numeric. The

number of characters in this document

number may also vary from state to state.

See Appendix D, Table 90: for valid

Issuing Authorities and their

DMVDocumentNbr format.




Parameter XML/CPS

Type

Min

Len

Max

Len*

Req Description

DMVDocNoExpirationDate string 1 1 Y/N This field can only contain a “Y” or a

null. This field is set to “Y” when there is

no expiration date on the DMV document

(driver’s license, state ID card) being

presented as a List B Document type 1

(Driver's license or ID card issued by a

U.S. state or outlying possession). If the

document being presented contains an

expiration date, this field must be null and

the date must be put in the DocExpDate

field.

DocExpDate dateTime N/A N/A Y/N The expiration date of the document in

format: YYYY-MM-DD. Must represent

a valid date. Appendix D, Table 77:

identifies which document types require

the document expiration date to be

provided.

SubmittingOfficial string 1 30 N Person in authority who is submitting the

case. May contain only alphabetic



not allowed.

SubmittersPhoneNbr string 1 10 N The phone number for the submitting

official. This is used as a point-of-contact

phone number. The phone number may

only consist of 10 digits with no spaces or

special characters.

EmployerCaseID string 1 40 N This field is for the requesting employer

to hold a related key into its system, if

desired. Every time this particular case is

referenced, the CPS Web server will

return the Employer Case ID as part of

the output. It can be used by employers to

tie the DHS key (i.e. initial verification

case number) to the user’s case reference.

3.3.3.1.2 EmpInitDABPVerif Content and Format

This method is identical to the initial verification method for employers (EmpInitBPVerif),

except it is used by E-Verify employer agents. Employee identification information is passed

into this method through 31 input parameters.

The parameters for this method are identical to EmpInitBPVerif (see Table 1 above) except for

ClientCompanyId, which is an additional parameter. ClientCompanyId is shown in the table

below:

Note: ClientCompanyId must be the first parameter in the method call.




Table 2: EmpInitDABPVerif Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

ClientCompanyId

(This must be the first

parameter in the

EmpInitDABPVerif

method call).

int N/A 9 Y/N This is an ID representing a client

company of the DABP performing the

employment eligibility verification. The

value for the ClientCompanyId may be

obtained using the DA-E-VERIFY

application by querying for the client

company.

3.3.3.1.2.1 EmpInitVerfResp25 Content and Format

This data type is used to package the output data for performing initial employment eligibility

verifications. It is used for the following methods: EmpInitBPVerif , EmpInitDABPVerif, and

EmpSSAReVerify.

Table 3: EmpInitVerfResp25 Data Elements Table

Member XML/CPS Type Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This is the CPS-generated initial

verification number. It serves as the

transaction identifier (key).

LastName string 1 40 N Employee’s last name as previously

recorded in the DHS database.

FirstName string 1 25 N Employee's first name as previously


EligStatementCd string N/A N/A Y The eligibility statement code as derived

from the initial verification. A value of

05 (INSTITITUTE ADDITIONAL

VERIFICATION) always means that

CPS automatically initiated the

additional verification.

See Appendix D Table 76: Return

Status Codes Table for a list of initial

verification response codes.

EligStatementTxt string 1 64 Y Eligibility statement text. Appendix D,

Table defines the set of possible

eligibility statement text messages.

EligStatementDetailsTxt string 1 64 N The eligibility statement details text

string is a field that contains a

description of why a response code of

27 (SSA TENTATIVE NON-

CONFIRMATION) was returned. This

field will aid in filling out the SSA FAN

Letter. The reasons that may be returned

are:

SSA unable to confirm U.S.





Len

Max

Len

Req Description

citizenship

SSN does not match

SSN is invalid

SSA unable to process data

SSN record does not verify (other

reason)

LetterTypeCodeList ArrayOfString N/A N/A N This field describes the type of SSA or

DHS letter (if any) that should be

presented to the employee.

SSA_FAN - SSA TENTATIVE

NONCONFIRMATION FAN

LETTER

SSA_NATZ_FAN – SSA

POTENTIALLY NATURALIZED

CITIZEN FAN LETTER

SSA_FA_FAN – SSA FRAUD

ALERT LETTER

DHS_FAN – DHS TENTATIVE

NONCONFIRMATION FAN

LETTER

SSA_RDC – SSA REFERRAL

DATE CONFIRMATION LETTER

DHS_RDC – SSA REFERRAL


(Additional letters may be added at a

later time)

AdditionalPerfInd string 1 1 Y A flag to indicate if an additional

verification was performed. If the value

= Y, an additional verification was

performed.

PhotoIncluded string 1 1 Y Y – Photo is included.

N – Photo is not included.

Photo base64Binary 1 - N JPEG photo byte stream.

NumberOfReferralReaso

ns

int N/A N/A Y Number of referral reasons returned in

ReferralReasonList.

ReferralReasonList ArrayOfString N/A N/A N Contains the reason(s) for a referral

which indicates the checkboxes on the

SSA FAN to be checked.

ReturnStatus int N/A N/A Y Return status code. Normal completion

= 0 (SUCCESSFUL). All other codes

are indicative of an error condition. See

Appendix D Table for a list of return

status codes.

ReturnStatusMsg string 1 200 Y Text message for the ReturnStatus.




3.3.3.1.3 EmpSSAReVerify Content and Format

This method performs an SSA re-verification by resending the data (input parameters) required

by SSA for its portion of an initial verification. This method provides employers with a second

chance for a successful verification before an SSA TNC is returned to the employer.

A call to this method is required after receiving an EligStatementCd of 36 and EligStatementTxt

of “Case Incomplete” from an initial verification attempt (EmpInitBPVerif,EmpInitDABPVerif):

in addition this method may only be called after an eligibility code of 36. An eligibility code of

36 can only be returned once during the initial verification process. Even though only one field

may be in error all of the following fields are required for the SSA re-verify:

CaseNbr,LastName,FirstName,SSNNumber, and BirthDate.

If the SSA re-verify data passes the SSA check the case continues with the normal verification

process. If the new SSA data does not pass the verification an SSA TNC is returned.


in Process) is returned, then the SSA re-verification is pending and the case is placed on a case


method) for the SSA re-verification response when the eligibility code of 42 is received.


Process) is returned, then the SSA re- verification is completed and the case cannot be processed.

It is expected that the employer will create a new case for the employee.

The response structure returned from this method (EmpInitVerfResp25) is the same structure

returned from the EmpInitBPVerif and EmpInitDABPVerif methods. It will contain the same

type of data that is returned from a normal initial verification call.

Table 4: EmpSSAReVerify Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This is the CPS initial verification

number.










employee.

OtherNamesUsed string 1 40 N Other names the employee may have




not allowed.




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description



special characters.






verifications. It is used for the following methods: EmpInitBPVerif , EmpInitDABPVerif, and

EmpSSAReVerify.


Member XML/CPS

Type

Min

Len

Max

Len

Req Description









from the initial verification. A value of 05

(INSTITITUTE ADDITIONAL

VERIFICATION) always means that CPS

automatically initiated the additional

verification.

See Appendix D, Table 78: for a list of

initial verification response codes.


Table defines the set of possible eligibility

statement text messages.

EligStatementDetailsTxt string 1 64 N The eligibility statement details text string

is a field that contains a description of why

a response code of 27 (SSA TENTATIVE

NON-CONFIRMATION) was returned.

This field will aid in filling out the SSA

FAN Letter. The reasons that may be

returned are:


citizenship

SSN does not match

SSN is invalid





Member XML/CPS

Type

Min

Len

Max

Len

Req Description


reason)


DHS letter (if any) that should be



NONCONFIRMATION FAN

LETTER



CITIZEN FAN LETTER


ALERT LETTER


NONCONFIRMATION FAN

LETTER

SSA_RDC – SSA REFERRAL DATE

CONFIRMATION LETTER



(Additional letters may be added at a later

time)


verification was performed. If the value =

Y, an additional verification was

performed.



Photo base64Binary 1 - N JPEG photo byte stream.

NumberOfReferralReasons int N/A N/A Y Number of referral reasons returned in

ReferralReasonList.

ReferralReasonList ArrayOfString N/A N/A N Contains the reason(s) for a referral which

indicate the checkboxes on the SSA FAN

letter to be checked.

ReturnStatus int N/A N/A Y Return status code. Normal completion = 0

(SUCCESSFUL). All other codes are

indicative of an error condition. See

Appendix D, Table 76: Return Status

Codes Table for a list of return status

codes.


3.3.3.1.4 EmpUpdateSSALetterReceived Content and Format (Removed)

This method still appears in the WSDL but is no longer needed.




Table 6: EmpUpdateSSALetterReceived Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This field specifies the case verification

number for the employment eligibility

verification that has been referred to SSA.

LetterTypeCodeList string 1 30 Y This field describes the type of SSA that was

presented to the employee based on the

results of the initial verification.


NONCONFIRMATION FAN LETTER



CITIZEN FAN LETTER

SSA_FA_FAN – SSA FRAUD ALERT

LETTER


time)

3.3.3.1.4.1 EmpLetterReceivedResp Content and Format (Removed)

This data type is no longer in the WSDL.

3.3.3.1.5 EmpSaveSSATNCNotification Content and Format

This method is used to indicate that the employee has received a notification of the SSA TNC. It

should be called when the initial verification or re-verify queries return a response code requiring

the employer to notify the employee of a SSA TNC. This method is required to be called before

invoking EmpSubmitSSAReferral method to indicate that the employee has been notified of the

SSA TNC.

Table 7: EmpSaveSSATNCNotification Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

EmployeeNotified string 1 1 Y This field should contain either a “Y” or

an “N”.

Y – Yes the employee has been notified.

N – No, the employee has not been

notified.

3.3.3.1.5.1 EmpSaveTNCNotificationResp Content and Format

This data type is used to report the status of a call to EmpSaveSSATNCNotification.




Table 8: EmpSaveTNCNotificationResp Data Elements Table


Len

Max

Len

Req Description

ReturnStatus Int N/A N/A N/A Return status code. Normal completion = 0

(SUCCESSFUL). All other codes are indicative

of an error condition. See Appendix D, Table

for the return status codes.

ReturnStatusMsg string 1 200 N/A Text message for the ReturnStatus.

3.3.3.1.6 EmpSubSSAReferral Content and Format

This method is used to notify CPS that the employee was referred to SSA to resolve the

verification issue. It should be called when the initial verification query returns a response code

of 27 (SSA TENTATIVE NONCONFIRMATION) and the employee contests the Tentative

Nonconfirmation (TNC).

Employees who receive a SSA TNC due to SSA not having up-to-date naturalization information

have the option to contact DHS to resolve their issue. Employers must provide these employees

with the SSA Referral Letter specific to potentially naturalized citizens.

The employee has eight federal government workdays from the date of the referral to resolve

their discrepancy by visiting his or her local SSA office. After the employee visits SSA, an SSA

operator processes and resolves the case. The employer must poll the CPS system

(EmpGetNextResolvedCaseNbrs) for the referral response. The referral status information is

returned in the EmpGetNextResolvedCaseNbrsResp25 response.

Table 9: EmpSubSSAReferral Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

ClientSftwrVer string 1 30 N The version number of the employer’s (or E-

Verify employer agent’s) Web service client

that is calling this method.

CaseNbr String 15 15 Y This field specifies the case verification

number for the employment eligibility

verification that has been referred to SSA.

3.3.3.1.6.1 EmpSubmitSSAReferralResp25 Content and Format

This data type is used to report the status of a call to EmpSubSSAReferral.

Table 10: EmpSubmitSSAReferralResp25 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

LetterTypeCodeList ArrayOfString N/A N/A N This field describes the type of SSA FAN

letter (if any) that should be presented to the

employee.






Member XML/CPS

Type

Min

Len

Max

Len

Req Description



CITIZEN FAN LETTER


LETTER


CONFIRMATION LETTER


time)


(SUCCESSFUL). All other codes indicate an

error condition. See Appendix D, Table 76:

Return Status Codes Table for a list of return

status codes.


3.3.3.1.7 EmpSSAResubmittal Content and Format

This method is used to resubmit an employment eligibility verification query that previously

returned a response code of 27 (SSA TENTATIVE NONCONFIRMATION). It may only be

called after the employee has been referred to SSA and SSA resolves the case with a response

code of 35 (Review and Update Employee Data Then Resubmit). When a case is resubmitted,

the information is matched against the SSA’s database and an immediate response is returned.


in Process) is returned, then the SSA resubmit is pending and the case is placed on a case


method) for the SSA resubmit response when the eligibility code of 42 is received.


Process) is returned, then the SSA resubmit is completed and the case cannot be processed. It is

expected that the employer will create a new case for the employee.

Table 11: EmpSSAResubmittal Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description




CaseNbr string 15 15 Y This is the CPS-generated initial verification

number. It serves as the transaction identifier

(key).








Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description





MiddleNameInitial string 1 1 N The first letter of the middle name of the

employee.

OtherNamesUsed string 1 40 N Other names the employee may have used.

May contain only alphabetic characters,

spaces, and single quotes. Other special

characters and numbers are not allowed.

SocialSecurityNbr string 9 9 Y Employee’s SSN. The SSN should contain

only numbers with no spaces or special

characters.

BirthDate dateTime N/A N/A Y Employee’s birth date. Date is in XML date

format YYYY-MM-DD.


3.3.3.1.7.1 EmpSSAResubmittalResp25 Content and Format

This data type is used to package the output data from performing an EmpSSAResubmittal.

Table 12: EmpSSAResubmittalResp25 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description



FirstName string 1 25 N Employee’s first name as previously



from the initial verification. A value of

05 (INSTITITUTE ADDITIONAL



verification.



EligStatementTxt string 1 64 Y Response code text. Appendix D, Table

defines the set of possible response code

text messages.


verification was performed. A value of Y

indicates an additional verification was

performed.






Member XML/CPS

Type

Min

Len

Max

Len

Req Description

Photo base64Binary N JPEG photo byte stream.

LetterTypeCodeList

ArrayOfString N/A N/A N This field describes the type of SSA (if

any) that should be presented to the

employee.


NONCONFIRMATION FAN

LETTER



CITIZEN FAN LETTER


ALERT LETTERSSA_RDC – SSA

REFERRAL DATE

CONFIRMATION LETTER


later time)

ReturnStatus int N/A N/A Y Numeric return status code. Normal

completion = 0 (SUCCESSFUL). All

other codes are indicative of an error

condition. See Appendix D, Table for the

return status codes.


3.3.3.1.8 EmpDHSReVerify Content and Format

This method performs a DHS re-verification for “lawful permanent residents” and “aliens

authorized to work” by resending the data (input parameters) required by DHS for its portion of

an initial verification. This method provides employers with a second chance for a successful

verification before a case is sent to SVS for additional processing.


of “Case Incomplete” from an initial verification attempt of an employee with a citizenship status

type of either “lawful permanent resident” or “alien authorized to work”. An eligibility code of

30 can only be returned once during the initial verification process. The data/fields sent to this

method should match the fields sent in for the initial verification. For example: If only an alien

number was sent in for the initial verification only send an alien number to this method. If an

alien number and card number was used for the initial verification call this re-verify method with

an alien number and card number. The required input fields in this method are determined by the

previous initial verification citizenship status and document type combination.

If the DHS re-verify data passes the DHS check the case continues with the normal verification

process. If the new DHS data does not pass verification the case is sent to SVS for

additional/secondary processing.

If a problem occurs during the DHS check and eligibility code of 42 (Verification in Process) is

returned, then the DHS re-verify is pending and the case is placed on a case reprocessing queue.




The employer must poll the CPS system (EmpGetNextResolvedCaseNbrs method) for the DHS

re-verify response when the eligibility code of 42 is received.

If a problem occurs during the DHS check and eligibility code of 43 (Unable to Process) is

returned, then the DHS re-verify is completed and the case cannot be processed. It is expected

that the employer will create a new case for the employee.

The response object returned from this method (EmpInitVerfResp9) will contain the same type

of data that is returned from a normal initial verification call.

Table 13: EmpDHSReVerify Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.





exactly 9 digits.




CardNbr string 13 13 Y/N Card number must be exactly 3 alphabetic

characters [A-Z] followed by 10 digits [0-

9].

PassPortNumber

(foreign)

string 6 12 Y/N If the input parameter is a foreign

passport the field can be between 6 and

12 alphanumeric characters.


I-9 changes. .







citizenship type 7. Refer to Appendix D –

Table for a list of valid country codes or

call the GetCountryOfIssuanceList

method to retrieve the latest list of COI

country codes. This data is subject to

change.

VisaNumber string 8 8 N This field is 8 alphanumeric characters.






verifications. It is used for the following methods: EmpSSAReVerify, EmpDHSReVerify, and

EmpCitDHSReVerify.


Member XML/CPS

Type

Min

Len

Max

Len

Req Description









from the initial verification. A value of 05

(INSTITITUTE ADDITIONAL



verification.






EligStatementDetailsTxt string 1 64 N Not used by this method.


DHS FAN letter (if any) that should be



NONCONFIRMATION FAN

LETTER



CITIZEN FAN LETTER


ALERT LETTER


NONCONFIRMATION FAN

LETTER


CONFIRMATION LETTER




time)






Member XML/CPS

Type

Min

Len

Max

Len

Req Description


performed.



Photo base64Binary - - N JPEG photo byte stream.




Appendix D, Table for a list of return

status codes.


3.3.3.1.9 EmpCitDHSReVerify Content and Format

This method performs a DHS re-verification for U.S citizens providing a passport as their

verification document. This task is accomplished by resending a citizen’s passport number and

date of birth in case the original parameters were sent in error in the initial verification. This

method provides employers with a second chance for a successful verification before a DHS

TNC is returned for the case.


of “Case Incomplete” from an initial verification attempt (EmpInitBPVerif, EmpInitDABPVerif)

of an U.S citizen or Naturalized citizen with a document type of “Unexpired U.S Passport or U.S

Passport Card”. An eligibility code of 30 can only be returned once during the initial verification

process.

If the DHS re-verify data (Passport Number and Birth Date) passes the DHS check the case

continues with the normal verification process. If the new DHS data does not pass verification an

eligibility code of 29 (DHS Tentative Nonconfirmation) is returned and DHS TNC processing

must begin.








The response object returned from this method (EmpInitVerfResp25) contains the same type of

data that is returned from a normal initial verification call.




Table 15: EmpCitDHSReVerify Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

PassPortNumber (U.S) string 6 9 Y The U.S. passport field can be between 6

and 9 alphanumeric characters.





This data type is used to package the output data from the following re-verify methods

EmpSSAReVerify, EmpDHSReVerify, EmpCitDHSReVerify and EmpDMVDHSReVerify.


Member XML/CPS

Type

Min

Len

Max

Len

Req Description









from the initial verification. A value

A 31 requires a call to EmpConfirmPhoto.

A 29 requires a call to

EmpSubDHSReferral.

See Appendix D, Table 78: Initial

Verification Response Codes for a list of





EligStatementDetailsTxt string 1 64 N Not used in this method.

LetterTypeCodeList ArrayOfStri

ng

N/A N/A N This field describes the type of SSA or




NONCONFIRMATION FAN

LETTER



CITIZEN FAN LETTER




Member XML/CPS

Type

Min

Len

Max

Len

Req Description


ALERT LETTER


NONCONFIRMATION FAN

LETTER


CONFIRMATION LETTER




time)




performed.



Photo base64Binar

y

- - N JPEG photo byte stream.

Passport photo for U.S citizen.





status codes.


3.3.3.1.10 EmpDMVDHSReVerify Content and Format

This method performs a DHS re-verification for employees providing a driver's license or state

ID card as their verification document. This task is accomplished by resending the employee’s

driver’s license/state ID number and date of birth for citizens and alien/I94 number, driver’s

license/state ID number and date of birth for non-citizens in case the original parameters were

sent in error in the initial verification. This method provides employers with a second chance for

a successful verification before a DHS TNC is returned for the case. This method can only be

used for driver’s licenses that are returned by the GetIssuingAuthorities method (see Appendix

D, Table 90: Issuing Authorities Valid Values for valid Issuing Authorities and their

DMVDocumentNbr format).


of “Case Incomplete” from an initial verification attempt (EmpInitBPVerif, EmpInitDABPVerif)

of any citizen type with a document ID of 28 (“List B and C Documents”) and list B document

ID of 1 (“Driver's license or ID card issued by a U.S. state or outlying possession”). An

eligibility code of 30 can only be returned once during the initial verification process.

If the DHS re-verify data (DMVDocumentNbr and BirthDate) passes the DHS check the case

continues with the normal verification process. If the new DHS data does not pass verification an




eligibility code of 29 (DHS Tentative Nonconfirmation) is returned and DHS TNC processing

must begin.








The response object returned from this method (EmpInitVerfResp25) contains the same type of

data that is returned from a normal initial verification call.

Table 17: EmpDMVDHSReVerify Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.





exactly 9 digits.




PassPortNumber

(foreign)

string 6 12 Y/N This field can be between 6 and 12



I-9 changes.







citizenship type 7. Refer to Appendix D –

Table 91 (COI Country Codes) for a list

of valid country codes or call the

GetCountryOfIssuanceList method to

retrieve the latest list of COI country

codes. This data is subject to change.

DMVDocumentNbr string 9 9 Y/N This is an alpha-numeric document

number (driver’s license or state ID card

number). This field is required when

ListBDocumentId contains a 1 (driver's


or outlying possession), the




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

StateIssuingAuthority supports E-Verify

(you can find the states that support E-

Verify by calling the

EmpGetIssuingAuthorities method), and

the SupportingDocumentId is present (the

states that show a supporting document

support E-Verify; a state may support

multiple “supporting documents”).

Otherwise this field should be null.

* The validation on this field will be on a

per StateIssuingAuthority (state) basis.

Some states allow alpha-numeric while

other states only allow numeric. The

number of characters in this document

number may also vary from state to state.

See Appendix D, Table 90:for valid

Issuing Authorities and their

DMVDocumentNbr format.





This data type is used to package the output data from the following re-verify methods

EmpSSAReVerify, EmpDHSReVerify, EmpCitDHSReVerify and EmpDMVDHSReVerify.


Member XML/CPS

Type

Min

Len

Max

Len

Req Description









from the initial verification. A value of:

31 requires a call to EmpConfirmPhoto.

29 requires a call to EmpSubDHSReferral.

See Appendix D Table 78: for a list of





EligStatementDetailsTxt string 1 64 N Not used in this method.




Member XML/CPS

Type

Min

Len

Max

Len

Req Description

LetterTypeCodeList ArrayOfStr

ing








CITIZEN FAN LETTER


LETTER




CONFIRMATION LETTER

DHS_RDC – SSA REFERRAL DATE

CONFIRMATION LETTER


time)




performed.



Photo base64Bina

ry


Passport photo for U.S citizen.





status codes.


3.3.3.1.11 EmpRetrievePhoto Content and Format

This method returns an U.S citizen passport photo and its supporting data after a third-step

request and response.

A call to this method is required after receiving an EligStatementCd of “P” and EligStatementTxt

of “Photo Matching Required” from SVS as an answer to a DHS referral (third-step) request.

This method will return a passport photo and corresponding verification data. After receiving the

photo the EmpConfirmPhoto method is called to confirm or reject the photo.

*Note – This is the one scenario that you can receive two DHS TNCs in the same flow.

Example:




Send - Initial Verification - U.S citizen/passport document

Receive – 30/Case Incomplete

Send – EmpCitDHSReVerify

Receive – 29/DHS Tentative Nonconfirmation

Send – EmpSubDHSReferral

Send – EmpGetNextResolvedCaseNbrs

Receive – “P”/Photo Matching Required

Send – EmpRetrievePhoto

Receive – 31/Photo Matching Required

Send – EmpConfirmPhoto (reject photo)

Receive – 29/DHS Tentative Nonconfirmation (**second DHS TNC)

Send – EmpSubDHSReferral

Send – EmpGetNextResolvedCaseNbrs

Process case normally

Table 19: EmpRetrievePhoto Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

3.3.3.1.11.1 EmpRetrievePhotoResp Content and Format

This data type is used to package the output data of an EmpRetrievePhoto method call. It returns

a U.S citizen passport photo and the data needed to confirm the photo.

Table 20: EmpRetrievePhotoResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description









from the initial verification

A 31 requires a call to EmpConfirmPhoto.

See Appendix D, Table 78 for a list of




Member XML/CPS

Type

Min

Len

Max

Len

Req Description



Table 76 defines the set of possible


EligStatementDetailsTxt string 1 64 N Not used by this method.



Photo base64Binar

y

- - N U.S citizen passport JPEG photo byte

stream.




Appendix D, Table 76 for a list of return

status codes.


3.3.3.1.12 EmpConfirmPhoto Content and Format

This method confirms or rejects a photo returned as part of an initial verification. It allows

employers to become part of the verification process by requiring employers to compare a

returned photo with an employee’s documentation and confirming or rejecting the verification

with this method.

After an EligStatementCd of 31 and EligStatementTxt of “Photo Matching Required” is received

from an initial verification attempt a call to this method is required to confirm the returned photo.

In addition, this method may only be called after an eligibility code of 31.

Photos may be returned by the following methods: EmpInitBPVerif, EmpInitDABPVerif,

EmpSSAReVerify, EmpDHSReVerify, EmpSSAResubmittal. Photos are not returned with every

initial verification. Photos are returned based on a combination of citizenship type and document

type and photo availability.

If a photo is rejected (PhotoConfirmation = “N”) a DHS TNC (EligStatementCd 29) is returned

as though the case had gone through second step process and the employer is required to go

through the DHS referral (third step) process. The employer photo confirmation process replaces

the DHS additional (second step) process.

Table 21: EmpConfirmPhoto Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

PhotoConfirmation string 1 1 Y This field should contain either a “Y” or

an “N”.

Y – Yes photo matches employee

documentation.




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

N – No, photo does not match employee

documentation.

3.3.3.1.12.1 EmpConfirmPhotoResp25 Content and Format


verifications. It is used for both EmpInitBPVerif and EmpInitDABPVerif.

Table 22: EmpConfirmPhotoResp25 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description




LetterTypeCodeList ArrayOfString N/A N/A N This field describes the type of DHS FAN

letter (if any) that should be presented to

the employee.


NONCONFIRMATION FAN

LETTER




time)

EligStatementCd string N/A N/A Y The eligibility statement code See

Appendix D, Table 78 for a list of initial

verification response codes.







Appendix D Table 76 for a list of return

status codes.


3.3.3.1.13 EmpUpdateDHSLetterReceived Content and Format (Removed)

This method is no longer needed and has been removed from the WSDL.

3.3.3.1.13.1 EmpLetterReceivedResp Content and Format (Removed)

This data type was removed from the WSDL and is no longer needed.




3.3.3.1.14 EmpSaveDHSTNCNotification Content and Format

This method is used to indicate that the employee has received a notification of the DHS TNC. It

should be called when the initial verification or re-verify queries return a response code requiring

the employer to notify the employee of a DHS TNC. This method is required to be called before

invoking EmpSubmitDHSReferral method to indicate that the employee has been notified of the

DHS TNC.

Table 23: EmpSaveDHSTNCNotification Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

EmployeeNotified string 1 1 Y This field should contain either a “Y” or

an “N”.

Y – Yes the employee has been notified.

N – No, the employee has not been

notified.

3.3.3.1.14.1 EmpSaveTNCNotificationResp Content and Format

This data type is used to report the status of a call to EmpSaveDHSTNCNotification.

Table 24: EmpSaveTNCNotificationResp Data Elements Table


Len

Max

Len

Req Description

ReturnStatus Int N/A N/A N/A Return status code. Normal completion = 0

(SUCCESSFUL). All other codes are indicative

of an error condition. See Appendix D, Table


ReturnStatusMsg string 1 200 N/A Text message for the ReturnStatus.

3.3.3.1.15 EmpSubDHSReferral Content and Format

This method is used to notify DHS that an employee plans to contest a DHS Tentative

Nonconfirmation (TNC) that was returned from the additional verification query. The employee

has eight federal government workdays from the date of referral to resolve the discrepancy by

contacting DHS and providing DHS with their verification number and other information on the

referral notice. The employer has the option to upload a GIF or JPG file (maximum 5 MB) of an

employee’s document or mail a photograph directly to DHS. Bear in mind that a photo upload

can only be done when the photo in the document does not match the photo generated by the

system, not when the data does not match. The employer must choose one of these options if the

employee contests this TNC.




Table 25: EmpSubDHSReferral Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description





verification number returned from a call

to EmpInitBPVerif or

EmpInitDABPVerif method.

UploadDoc string 1 1 Y Y – Document is being uploaded.

N – Document is not being uploaded.

DocFile base64Binary N Image document (GIF or JPG) being

uploaded instead of being mailed directly

to DHS.

3.3.3.1.15.1 EmpSubmitDHSReferralResp28 Content and Format

This data type is used to report the status of a call to the EmpSubmitDHSReferral method.

Table 26: EmpSubmitDHSReferralResp28 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description





NONCONFIRMATION FAN

LETTER




time)

ContactDHSByDt dateTime N/A N/A Y This field contains the date the employee

has to contact DHS by before the case is

marked “No Show”.

ReturnStatus int N/A N/A Y Return status code. Normal completion =

0 (SUCCESSFUL). All other codes are


Appendix D Table 76 for the return status

codes.


3.3.3.1.16 EmpSubmitAdditVerif Content and Format

This method submits additional data to DHS. It is used by DHS to confirm the status of a case.

It may be used only when the CPS Web server has returned a response code of 08

(EMPLOYMENT AUTHORIZED) from a call to EmpInitBPVerif or EmpInitDABPVerif and




the verification citizen type of the case is 6 (lawful permanent resident) or 7 (alien authorized to

work). U.S citizen and U.S National cases may not be sent to additional verification. This

method may not be used when the CPS Web server has returned any other eligibility code. An

employer may use this call to request additional verification of a case when discrepancies are

noticed between the verification’s returned data and a non-U.S. citizen employee’s

documentation. A case sent to additional verification must have the response picked up at a later

time using the EmpGetNextResolvedCaseNbrs method.

Table 27: EmpSubmitAdditVerif Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description





number.

SubmittingOfficial string 1 30 N Person in authority who is submitting the

case. May contain only alphabetic


Other special characters and numbers not

allowed.

SubmittersPhoneNbr string 1 10 N The phone number for the submitting

official. This is used as a point-of-contact

phone number. The phone number may

only consist of 10 digits with no spaces or

special characters.

Comment string 1 150 N Comment text to be passed to DHS.

3.3.3.1.16.1 EmpSubmitAdditVerifResp Content and Format

This data type is used to report the status of a call to EmpSubmitAdditVerif.

Table 28: EmpSubmitAdditVerifResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description





status codes.


3.3.3.1.17 EmpGetNextResolvedCaseNbrs Content and Format

This method retrieves the case numbers and response codes for cases pending SSA or DHS

resolution. These cases have been either sent to SSA using EmpSubSSAReferral, automatically

sent to DHS for additional verification via the EmpInitBPVerif or EmpInitDABPVerif methods,




or sent to DHS for additional verification using EmpSubmitAdditVerif or EmpSubDHSReferral.

The VIS system provides the ability of placing a case on a case reprocessing queue due to a

transient technical failure when calling EmpInitBPVerif, EmpInitDABPVerif,

EmpSSAReVerify, EmpDupCaseContinueWithChanges,

EmpDupCaseContinueWithoutChanges, EmpSSAResubmittal, EmpDHSReVerify,

EmpCitDHSReVerify or EmpDMVDHSReVerify methods. The verification is placed in a

pending status to be automatically retried by VIS later. The EmpGetNextResolvedCaseNbrs

method should be used to retrieve the case numbers and response codes after the case

verification has been processed.

It is recommended that this method be called no more than once per hour. It is not necessary to

call this method more frequently as the cases with pending resolutions are manually worked by

either SSA case workers or DHS case workers.

This method provides the Web service client with a means to retrieve one or all of the

outstanding resolved case numbers and employment statuses. Cases are returned in the order

they were put in the queue. The Web service client defines the type of search to perform using

the SearchType parameter (i.e., retrieve one case, or retrieve all cases). The last input parameter,

AcknowledgeFlg, indicates whether or not CPS will automatically delete the case entries from

the response queue after it is returned to the employer’s (or E-Verify employer agent’s) Web

service client. If this parameter is set to Y, all returned case numbers are deleted from the

response queue. If this parameter is set to N, all returned case numbers are not deleted from the

response queue and the client must call EmpAckReceiptOfResolvedCaseNbr for each case

number returned. If the queue entries are not automatically or manually deleted, the next call to

EmpGetNextResolvedCaseNbrs will return the same case number(s) as the previous call.

Note: As of E-Verify Web Service Release 1.5, Version 18, a set of enhancements were added to

the VIS system that provide the ability for both SSA and DHS staff to access unreferred cases

(i.e., cases which the employer failed to refer to SSA or DHS) during the case resolution process.

Therefore, a Web service client may receive SSA and DHS case responses from the

EmpGetNextResolvedCaseNbrs method that were not previously referred.

Example: A user verifies an employee and receives a response code of 08 (SSA TENTATIVE

NONCONFIRMATION). The employer provides the appropriate letters to the employee and

tells him/her to go to SSA, but forgets to refer the case. The employee visits SSA and resolves

his/her problem. SSA will then have access to the case even if the employer did not refer it.

SSA resolves the case and a case resolution is placed into the case queue. If the employer did

not refer the case, the employer’s (or E-Verify employer agent’s) Web service client may not

expect this response.

Table 29: EmpGetNextResolvedCaseNbrs Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description




SearchType string 1 1 Y Indicates whether a single case or multiple




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

cases are returned for a specified case type.

1 = Retrieve next case

2 = Retrieve all cases

AcknowledgeFlg string 1 1 Y This flag is used to indicate whether the

case(s) are to be automatically acknowledged

(deleted from response queue) or whether the

user will manually acknowledge the case by

calling EmpAckReceiptOfResolvedCaseNbr.

Y = Automatically acknowledge (delete

from case response queue) all of the

cases returned from this method. If you

use this option you will not be able to re-

retrieve the case numbers.

N = Do not automatically acknowledge

the returned cases. You must call

EmpAckReceiptOfResolvedCaseNbr for

each case returned. If you do not

acknowledge a case, the case will stay

on the case response queue and will be

returned again with the next call to

EmpGetNextResolvedCaseNbrs.

3.3.3.1.17.1 EmpGetNextResolvedCaseNbrsResp25 Content and Format

This data type is used to return the response code(s) and case number(s) of pending SSA or DHS

cases.

Table 30: EmpGetNextResolvedCaseNbrsResp25 Data Elements Table


Len

Max

Len

Req Description

NumberOfCases int N/A N/A Y The number of records returned in

CaseList.

CaseList (ArrayOf)Case25 N/A N/A Y A list of records. Each record contains a

case number and the case type, response

code and resolution date. See section

4.4.2 Case9.




Appendix D, Table for the return status

codes.


3.3.3.1.17.2 (ArrayOf)Case25 Content and Format




This data type is used to report the status of cases with pending resolutions. One record in this

list exists for each case with a pending resolution. Each record identifies the case number, the

type of pending resolution, and resolution information pertinent for the type of resolution.

Table 31: Case25 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description


number for an SSA or DHS resolved

case.

TypeOfCase string 1 1 Y 1 = SSA response

2 = DHS Additional response

3 = DHS Third Step response

EmployerCaseID string 1 40 N This field contains the data received in

the EmployerCaseID field of the initial

verification query.

ResponseCode string 1 3 Y This field contains either an SSA

response code (see Appendix D, Table

79:), an additional resolution code

(Appendix D, Table 80:) or a DHS

referral resolution code (Appendix D,

Table ) Use the TypeOfCase field to

determine which response code the field

contains.

ResponseStmt string 1 64 Y This field contains the text description of

the code returned in the ResponseCode

field.

ResolveDate dateTime N/A N/A Y This field contains the date in which the

case was resolved either by SSA or by

DHS.





NONCONFIRMATION FAN

LETTER




time)

3.3.3.1.18 EmpGetCaseDetails Content and Format

This method retrieves all current information on file for an existing case. It may be called at any

time for a period of one year after the case has been created to retrieve the details of the case.

After a period of one year, cases in the CPS database are archived and are no longer available to

employer users.




Table 32: EmpGetCaseDetails Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This is the initial verification number that

is returned from EmpInitBPVerif or

EmpInitDABPVerif.

3.3.3.1.18.1 EmpGtCseDetailsResp25 Content and Format

This data type is used to report the status of a call to the EmpGetCaseDetails method.

Table 33: EmpGetCaseDetails25 Data Elements Table

Member XML/CP

S Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This is the CPS generated primary



CurrentState string 4 4 Y The current state of the case.

Initial Input Fields

InitiCitizenshipDescr string 10 25 Y The citizen status that was submitted on

the initial query.

4 = A citizen of the United States

5 = A noncitizen national of the

United States

6 = A lawful permanent resident

7 = An alien authorized to work

InitiAlienNum string 9 9 N The 9-digit alien number that was

submitted on the initial query.

InitiI94Num string 11 11 Y The Form I-94 number that was

submitted in the initial query.

InitiReceiptNum string 13 13 N Card number submitted with the initial

query.

InitiVisaNum string 8 8 N The 8 character Visa number that was

submitted with the initial query.

InitiPassportNum string 6

6

9

12

N U.S passports are 6-9 alphanumeric

characters. Foreign passports are 6-12


InitiNoForeignPassport string 0 0 N This field must be left empty due to

Form I-9 changes.

InitiCountryOfIssuance string 3 3 N This field contains the country that

issued the passport used as input to this

initial verification.

InitiCountryOfIssuanceDes

c

string 1 100 N This field contains the full name of the

country code used in the

InitiCountryOfIssuance field.




Member XML/CP

S Type

Min

Len

Max

Len

Req Description

InitiLogonId string 12 12 Y The user ID of the person who

submitted the initial query.

InitiDt dateTime N/A N/A Y The date the initial query was submitted.

InitiLastNm string 1 40 Y Employee's last name that was


InitiFirstNm string 1 25 Y Employee's first name that was


InitiMiddleInitial string 1 1 N Employee's middle initial that was


InitOtherNamesUsed string 1 40 N Other name the employee may have

used that was submitted in the initial

query.

InitiSsn string 9 9 Y The Social Security Number that was


InitiEmailAddress string 1 60 N Employee’s email address that was


InitiBirthDt dateTime N/A N/A Y Employee's birth date that was


InitiHireDt dateTime N/A N/A Y Employee's hire date that was submitted

in the initial query.

InitiDocType string 1 1 Y The document ID that was submitted in

the initial query.

InitiListBDocType string 1 100 N The List B Document name that was


InitiListCDocType string 1 100 N The List C Document name that was


InitiSupportingDocType string 1 1 N Document ID supporting List B

Document Type 1.

InitiStateIssuingAuthority string 2 2 N State that issued DMV document used

as a List B document by employee.

InitiDMVDocumentNbr string 9 9 N DMV Document number (driver’s

license, state ID card number).

InitiNoDocExpDate string 1 1 N Flag indicating that the DMV document

presented did not have an expiration

date on it.

InitiDocExpireDt dateTime N/A N/A N The expiration date of the document that

was submitted in the initial query.

InitiEmployerCaseID string 1 40 N This field is for the requesting employer

to hold a related key into its system, if

desired.

InitiLateHireDateReason string 1 60 N An employee must be verified through

E-Verify within 3 days of hire date. If

he/she is not, an OverDueVerifyReason

must be provided. If an overdue reason




Member XML/CP

S Type

Min

Len

Max

Len

Req Description

is not provided an error is returned. See

Appendix D Table

OverDueVerifyReason Valid Values for

valid overdue reasons.

InitiLateHireDateRsnOther string 1 200 N If LATE_HIRE_DT_RSN_OTHER is

provided in the OverDueVerifyReason

field, this field must contain free-form

text explaining the reason for the late

verification. Otherwise this field must

be blank.

Initial Output Fields

InitoLastNm string 1 40 Y Employee's last name that was returned

in the initial query response.

InitoFirstNm string 1 25 Y Employee's first name that was returned

in the initial query response.

InitoMessageCode int N/A N/A Y The eligibility statement code that was

returned in initial query. A value of 05

(INSTITUTE ADDITIONAL

VERIFICATION) always means that

CPS automatically initiated the

additional verification. See Appendix D,

Table 76 for valid response codes.

InitoEligibStmt string 1 64 Y Eligibility statement text that was

returned in initial query. Appendix D,



InitoEligibStmtDetails string 1 64 N The eligibility statement details text

string that was returned in additional

query. This field contains a description

of why a response code of 27 (SSA

TENTATIVE NONCONFIRMATION)

was returned. This field will aid in

filling out the SSA referral letter. The

reasons that may be returned are:


citizenship

SSN does not match

SSN is invalid


LetterTypeCodeList ArrayOfSt

ring





NONCONFIRMATION FAN

LETTER






Member XML/CP

S Type

Min

Len

Max

Len

Req Description

CITIZEN FAN LETTER


ALERT LETTER


NONCONFIRMATION FAN

LETTER

SSA_RDC – SSA REFERRAL





later time)

Additional input

AddiiComments string 1 150 N The comment text that was submitted in

the additional query. These comments

were passed to DHS.

AddiiLogonId string 8 8 Y The user ID of the person who was that

submitted the additional query.

AddiiDt dateTime N/A N/A Y The date the additional query was

submitted.

AddiiTransCd string 5 5 Y The transaction code that was used to

initiate the additional verification.

Additional output

AddioEligibStmt string 64 64 Y Eligibility statement text that was

returned in the additional query.

Appendix D Table 76 defines the set of

possible eligibility statement text

messages.

AddioResolutionCode string 1 1 Y A code indicating the CPS case

resolution status.

AddioResolvedDt dateTime N/A N/A Y The date the case was resolved by DHS.

Close case output

ClosureCdDescr string 50 50 Y The case closure code description.

ClosedBy string 12 12 Y The user ID of the person who closed

the case.

ClosedDt dateTime N/A N/A Y The date the case was closed.

DHS referral input

InsReferiDt dateTime N/A N/A Y The date the case was referred to the

DHS.

InsReferiBy string 12 12 Y The user ID of the person who referred

the case to DHS.

DHS referral output

InsReferoEligibStmt string 1 64 Y Resolution code that was returned in




Member XML/CP

S Type

Min

Len

Max

Len

Req Description

DHS re-submittal query. Appendix D,


resolution codes.

InsReferoResolutionCode string 1 1 Y A code indicating the CPS case

resolution status.

InsReferoResolvedDt dateTime N/A N/A Y The date the case was resolved by DHS.

InsReferoContactDHSByDt dateTime N/A N/A N The date that the SSA Referred

employee should contact SSA before the

case is marked as “No Show”.

DHS additional referral input

InsAddlReferiDt dateTime N/A N/A Y The date a U.S Citizen/passport case

was referred to the DHS for the second

time.

InsAddlReferiBy string 12 12 Y The user ID of the person who referred a

U.S Citizen/passport case to the DHS

for the second time.

DHS additional referral output

InsAddlReferoEligibStmt string 1 64 Y Resolution code corresponding to a U.S

Citizen/passport case that was referred

to DHS for the second time. Table 81:

DHS Referral Resolution Codes4

defines the set of possible resolution

codes.

InsAddlReferoResolutionC

ode

string 1 1 Y A code indicating the CPS case

resolution status of a U.S.

Citizen/passport case referred to DHS

for the second time.

InsAddlReferoResolvedDt dateTime N/A N/A Y The date the case was resolved by DHS.

SSA referral Input

SsaReferiDt dateTime N/A N/A Y The date the case was referred to SSA.

SsaReferiBy string 12 12 Y The user ID of the person who referred

the case to SSA.

SsaoDispositionDt dateTime N/A N/A The date the case was processed by

SSA.

SsaoMessageCode string 1 2 N The eligibility statement code assigned

by SSA.

See Appendix D, Table 79: SSA

Referral Response Codes for a list of

SSA Referral response codes.

SsaoEligibStmt string 1 64 N Eligibility statement text See Appendix

D, Table 79: SSA Referral Response

Codesfor a list of SSA Referral response

codes.

SsaoElibibilityStmtDetail string 1 64 N The eligibility statement details text




Member XML/CP

S Type

Min

Len

Max

Len

Req Description

string is a field that contains a

description of why a response code of

27 (SSA TENTATIVE NON-

CONFIRMATION) was returned. This

field will aid in filling out the SSA

Referral Letter. The reasons that may be

returned are:


citizenship

SSN does not match

SSN is invalid



reason)

SSA automated resubmittal input

SsaResubmiLastNm string 1 40 Y Employee's last name that was

submitted on the SSA re-submittal.

SsaResubmiFirstNm string 1 25 Y Employee's first name that was

submitted in the SSA re-submittal.

SsaResubmiMiddleInitial string 1 1 N Employee's middle initial that was


SsaResubmiOtherNamesUs

ed

string 1 40 N Other name the employee may have

used that was submitted on the SSA re-

submittal.

SsaResubmiSsn string 9 9 Y The Social Security Number that was


SsaResubmiBirthDt dateTime N/A N/A Y Employee's birth date that was


SsaResubmiLogonId string 12 12 Y The user ID of the person who re-

submitted the case to SSA.

SsaResubmiDt dateTime N/A N/A Y The date the case was re-submitted to

SSA.

SSA resubmittal response output

SsaResubmoMessageCode string 1 1 Y A code indicating the SSA case

resolution status.

SsaResubmoEligibStmt string 1 64 Y The response code that was returned in

SSA resubmittal query. Appendix D



SSA referral response output

SsaReferralRespDueDate dateTime N/A N/A N When this field contains a value, it

represents the date that a resolution to

the SSA Referral is expected. This field

will contain a value when either SSA or




Member XML/CP

S Type

Min

Len

Max

Len

Req Description

DHS places the SSA Referral into

“continuance” because the case worker

needs time to resolve the case (i.e. the

case worker cannot resolve the SSA

Referral immediately, and therefore may

need several days to work the case).

This date may change in value if, for

example, DHS places the case into

continuance, and later determines that

the employee needs to be referred to

SSA for Referral resolution.

Misc output

ClientCompanyName string 1 100 Y Field used for DABPs only.

The name of the client company for

which the DABP is performing the

employment eligibility verification.

ClientCompanyId string Y



Photo base64Bin

ary


NumberOfReferralReasons int N/A N/A Y Number of referral reasons returned in

ReferralReasonList.

ReferralReasonList ArrayOfSt

ring

N Contains the reason(s) for a referral

which indicate the checkboxes on the

SSA TNC Notice or SSA Referral letter

to be checked.





status codes.


3.3.3.1.19 EmpAckReceiptOfResolvedCaseNbr Content and Format

This method is used by the Web service client to notify CPS that the client has successfully

received the case resolution information and the case number can be deleted from the case

resolution queue. If this method is not called or the AcknowledgeFlg parameter in the

EmpGetNextResolvedCaseNbrs method is not set to Y, then the next call to

EmpGetNextResolvedCaseNbrs will return the same case number(s) as the previous call




Table 34: EmpAckReceiptOfResolvedCaseNbr Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description





number that the Web service client is

acknowledging has been successfully

retrieved.

TypeOfCase string 1 1 Y The type of case being acknowledged:

1 = SSA response

2 = DHS Additional response

3 = DHS Third Step response

3.3.3.1.19.1 EmpAckReceiptOfResolvedCaseNbrResp Content and Format

This data type is used to report the status of a call to the EmpAckReceiptOfResolvedCaseNbr

method.

Table 35: EmpAckReceiptOfResolvedCaseNbrResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description



indicative of an error condition. See Table

76: Return Status Codes Table for a list of

return status codes.


3.3.3.1.20 EmpGetClosureCodes Content and Format

This method is the employer transaction used to retrieve the closure codes that can be used to

close a particular case. The closure codes allowed to close a case is determined based on “if the

employee still works for the employer” and the state of the case (where the case is in the

verification process). See Appendix D, Table and Table .

Table 36: EmpGetClosureCodes Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


verification number of the case being

closed.

CurrentlyEmployed string 1 1 Y Valid values:

“Y” – Yes the employee still works for

the employer.

“N” – No, the employee does not work




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

for the employer.

3.3.3.1.20.1 EmpClosureCodesResp Content and Format

This data type is used to report the status of a call to the EmpGetClosureCodes.

Table 37: EmpClosureCodesResp Data Elements Table

Members XML/CPS Type Min

Len

Max

Len

Req Description

NumberOfClosureCodes int N/A N/A Y Number of closure codes

returned.

ClosureCodeList ArrayOfClosureCode N/A N/A Y List of valid closure codes for

input case.

ReturnStatus int N/A N/A Y Return status code. Normal

completion = 0

(SUCCESSFUL). All other

codes are indicative of an error

condition. See Appendix D

Table 76 for the return status

codes.

ReturnStatusMsg string 1 200 Y Text message for the

ReturnStatus

3.3.3.1.20.2 ClosureCode Content and Format

This data type is returned in the EmpClosureCodesResp. It contains a list of closure codes that

can be used to close the case sent in the EmpGetClosureCodes method.

Table 38: ClosureCode Data Elements Table

Members XML/CPS

Type

Min

Len

Max

Len

Req Description

Code string 1 6 Y Code to use in the call to EmpCloseCase.

Descr string 1 200 Y Description of closure code.

3.3.3.1.21 EmpCloseCase Content and Format

This method is the employer transaction used to close a case. Additional information is used to

track the closure type and indicate how the employer processed this case. This transaction makes

the case unavailable for any further processing.

Table 39: EmpCloseCase Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description








verification number of the case being

closed.

CloseStatus string 2 6 Y Case close code. See Appendix D, Table

for valid values.

CurrentlyEmployed string 1 1 Y Valid values:

Y – Yes, the employee still works for

the employer.

N – No, the employee does not work

for the employer.

U – Unknown, the case has been

identified as a duplicate.

3.3.3.1.21.1 EmpCloseCaseResp Content and Format

This data type is used to report the status of a call to the EmpCloseCase.

Table 40: EmpCloseCaseResp Data Elements Table

Members XML/CPS

Type

Min

Len

Max

Len

Req Description

Employer Case ID string 1 40 N This is the same value that was provided

by the user when the initial verification

was performed.




Appendix D, Table 76 for the return

status codes.

ReturnStatusMsg string 1 200 Y Text message for the ReturnStatus

Note: On December 17, 2008 DHS USCIS published an interim final rule revising the list of

identity and employment authorization documents which employers may accept for completion

of the Form I-9. The rule requires that all documents presented for the Form I-9 be unexpired.

Upon DHS notice, all employers and E-Verify employer agents will be required to use the

Revised Form I-9 for employment eligibility verification. E-Verify Release 1.5, Version 18 and

beyond will support the Revised Form I-9 requirements.

The following methods have been added to support the above requirement:

EmpGetCitizenshipStatusCodes, EmpGetAvailableDocumentTypes, and EmpGetAllDataFields.

These methods must be used in the employer’s (or E-Verify employer agent’s) Web service

client to retrieve the citizenship and document types configured for users. Citizenship and

document types must NOT be hard-coded in the Web service client because they are subject to

change.

3.3.3.1.22 EmpGetCaseAlertCounts Content and Format

This method returns the case count of three types of system alerts:




CloseCount – The number of cases to be closed: Cases with a status change to Employment

Authorized (EA), No Show, or Final Nonconfirmation (FNC) – within the last 30 calendar

days

UpdatedCasesCount – Cases where the status has been updated either by the system or via a

status verifier – within the last 30 calendar days.

ExpiringCasesCount - Cases for which a work authorization document is expiring within 90

calendar days or has expired in the last 30 calendar days (expiration refers to system

expiration date, not date entered by employer)

Note: Applicable work authorization documents include the following:

Employment Authorization Document (Form I-766)

Arrival/Departure Record (Form I-94)

Unexpired Foreign Passport with Form I-94

* No input parameters.

3.3.3.1.22.1 EmpCaseAlertsResp Content and Format

This data type returns results for a call to EmpGetCaseAlertCounts.

Table 41: EmpCaseAlertsResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

CloseCount

int N/A N/A Y The number of cases to be closed: Cases

with a status change to Employment

Authorized (EA), No Show, or Final

Nonconfirmation (FNC) – within the last

30 calendar days

UpdatedCasesCount int N/A N/A Y Cases where the status has been updated

either by the system or via a status

verifier – within the last 30 calendar days.

ExpiringCasesCount int N/A N/A Y Cases for which a work authorization

document is expiring within 90 calendar

days or has expired in the last 30 calendar

days (expiration refers to system

expiration date, not date entered by

employer)





Codes Table for the return status codes.





3.3.3.1.23 EmpGetAlertCases Content and Format

This method returns the cases associated with a particular alert type: C – Cases to be closed; U-

Cases that have been updated; E – Cases where the authorization document is expiring.

Table 42: EmpGetAlertCases Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

AlertType string 1 1 Y The type of “alert” cases to return:

C – Cases to be closed.

U – Cases that have been updated.

E – Cases where the authorization

document is expiring.

3.3.3.1.23.1 EmpAlertCasesResp Content and Format

This data type returns results for a call to EmpGetAlertCases.

Table 43: EmpAlertCasesResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseCount int N/A N/A Y The number of cases returned.

CaseNbrList ArrayOfString N/A N/A Y A list of case numbers.







3.3.3.1.24 EmpGetCitizenshipStatusCodes Content and Format

This method returns all citizenship codes and descriptions associated with the user’s Web service

account. There are no input parameters for this method.

3.3.3.1.24.1 EmpGetCitizenshipCodesResp Content and Format

This data type returns results for a call to EmpGetCitizenshipStatusCodes.

Table 44: EmpGetCitizenshipCodesResp Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NumberOfCitizenshipCodes int N/A N/A Y The number of entries returned in

the CitizenshipCodeList.

CitizenshipCodeList ArrayOfCiti

zenshipCode

N/A N/A Y A list of records. Each record

contains a citizenship code,

citizenship description and

citizenship name. See section




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

3.3.3.1.22.2 CitizenshipCode.


completion = 0 (SUCCESSFUL).

All other codes are indicative of an

error condition. See Appendix D,

Table 76: Return Status Codes Table



3.3.3.1.24.2 CitizenshipCode Content and Format

This data type is used to report all citizenship codes, citizenship descriptions and citizenship

names associated with the user’s Web service account.

Table 45: CitizenshipCode Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

Code string 1 1 Y This field specifies the citizenship code.

Descr string 1 100 Y This field specifies the citizenship

description for the citizenship code.

Name string 1 50 N This field specifies the citizenship name

for the citizenship code.

3.3.3.1.25 EmpGetAvailableDocumentTypes Content and Format

This method returns all document types for a citizenship code. Also, if the citizenship code is

not specified all document types are returned.

Table 46: EmpGetAvailableDocumentTypes Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

CitizenshipCode string 1 1 N This field specifies the citizenship code.

3.3.3.1.25.1 EmpGetAvailableDocumentTypesResp Content and Format

This data type returns results for a call to EmpGetAvailableDocumentTypes.

Table 47: EmpGetAvailableDocumentTypesResp Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NumberOfDocTypes int N/A N/A Y The number of entries returned in the

DocTypeList.

DocTypeList ArrayOfDocT

ype

N/A N/A Y A list of records. Each record contains a

document ID, document type, citizenship

code and citizenship name. See section

3.3.3.1.23.2 DocType.




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description







3.3.3.1.25.2 DocType Content and Format

This data type is used to report all document IDs, document types, citizenship codes and

citizenship names associated with the user’s Web service account.

Table 48: DocType Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

DocumentId int N/A N/A Y This field specifies the document ID

DocumentType string 1 100 Y This field specifies the document type.

CitizenshipCode string 1 1 Y This field specifies the citizenship code.

CitizenshipName string 1 50 Y This field specifies the citizenship name

for the citizenship code.

3.3.3.1.26 EmpGetListBCDocumentTypes Content and Format

This method returns all document types for a citizenship code.

Table 49: EmpGetListBCDocumentTypes Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description


Return the List B and List C document types

valid for this citizenship code.

3.3.3.1.26.1 EmpGetListBCDocumentTypesResp Content and Format

This data type returns results for a call to EmpGetListBCDocumentTypes.

Table 50: EmpGetListBCDocumentTypesResp Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NumberOfListBDocu

ments

int N/A N/A Y The number of List B entries returned in

the ListBDocumentList.

ListBDocumentList ArrayOfListB

CDocument


document ID and document type See

section 3.3.3.1.24.2 ListBCDocument




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NumberOfListCDocu

ments

int N/A N/A Y The number of List C entries returned in

the ListCDocumentList.

ListCDocumentList ArrayOfListB

CDocument



section 3.3.3.1.24.2 ListBCDocument







3.3.3.1.26.2 ListBCDocument Content and Format

This data type is used to report all document IDs, and document types associated with citizenship

code type.

Table 51: ListBCDocument Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

DocumentId int N/A N/A Y This field specifies the document ID


3.3.3.1.27 EmpGetSupportingDocumentTypes Content and Format

This method returns the valid supporting documents for the specified List B document.

Supporting documents are used to describe a List B/C document (for example, driver’s license or

state ID card). Please call this method at least once a month to ensure you have the latest list of

document types.

Table 52: EmpGetGetSupportingDocumentTypes Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

ListBDoc string 1 1 Y This field specifies the List B document ID.

Return the valid supporting documents for the

specified List B document.

3.3.3.1.27.1 EmpGetSupportingDocumentTypesResp Content and Format

This data type returns results for a call to EmpGetSupportingDocumentTypes.

Table 53: EmpGetSupportingDocumentTypesResp Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

ListBDoc string 1 1 Y The List B document received in the

EmpGetSupportingDocumentTypes




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

request.

NumberOfSupporting

Documents

int N/A N/A Y The number of Supporting document

entries returned in the

SupportingDocumentList.

SupportingDocument

List

ArrayOfSuppo

rtingDocument



section 3.3.3.1.25.2 SupportingDocument




Appendix D, Table for the return status

codes.


3.3.3.1.27.2 SupportingDocument Content and Format

This data type is used to report all document IDs and document types associated a List B

document.

Table 54: SupportingDocument Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

Id int N/A N/A Y This field specifies the document

ID

Type string 1 100 Y This field specifies the document

type.

3.3.3.1.28 EmpGetIssuingAuthorities Content and Format

This method returns the Issuing Authorities (states) and the Supporting Documents supported by

the Issuing Authorities for the specified List B document. This list is updated dynamically and

can change at any time. Please call this method at least once a month to ensure you have the

latest list of Issuing Authorities. An Issuing Authority is required when using a List B document

of Driver’s License. If an Issuing Authority has an associated Supporting Document(s) the

Issuing Authority supports E-Verify for that particular document type (the supporting document

number must be entered in the initial verification). An Issuing Authority may support multiple

document types.

Table 55: EmpGetIssuingAuthorities Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

ListBDoc string 1 1 Y This field specifies the List B document ID.

Return the valid Issuing Authorities (states) for

the specified List B document.




3.3.3.1.28.1 EmpGetIssuingAuthoritiesResp Content and Format

This data type returns results for a call to EmpGetIssuingAuthorities.

Table 56: EmpGetIssuingAuthoritiesResp Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NumberOfIssuingAuthorities int N/A N/A Y The number of Issuing Authority

entries returned in the

IssuingAuthorityList.

IssuingAuthorityList ArrayOfIssu

ingAuthority

N/A N/A Y A list of records. Each record

contains an Issuing Authority. There

may be multiple records for an

Issuing Authority if the Issuing

Authority supports multiple

Supporting Document types. See

section 3.3.3.1.26.2

IssuingAuthority





Table for the return status codes.


3.3.3.1.28.2 IssuingAuthority Content and Format

This data type is used to report all Issuing Authorities associated a List B document.

Table 57: IssuingAuthority Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

Code string 2 2 Y This field specifies an Issuing

Authority.

SupportingDocumentId int N/A N/A N A supporting document that is

supported by the IssuingAuthority.

This field may be blank.

3.3.3.1.29 EmpGetAllDataFields Content and Format

This method returns all the required fields associated with all citizenship codes and all document

IDs. If both the citizenship code and document ID are omitted, all required fields for all

document IDs and all citizenship codes are returned. If the citizenship code is omitted, all

required fields for all citizenship codes for the specified document ID are returned. Likewise, if

the document ID is omitted, all required fields for all documents or the specified citizenship code

are returned.




Table 58: EmpGetAllDataFields Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

CitizenshipCode string 1 1 N This field specifies the citizenship code.

DocumentId int N/A N/A N This field specifies the document ID.

3.3.3.1.29.1 EmpGetAllDataFieldsResp Content and Format

This data type returns results for a call to EmpGetAllDataFields.

Table 59: EmpGetAllDataFieldsResp Data Elements Table


Len

Max

Len

Req Description

NumberOfFieldRecords int N/A N/A Y The number of entries

returned in the FieldList.

FieldList ArrayOfDocumentField N/A N/A Y A list of records. Each record

contains all of the required

fields. See section

3.3.3.1.27.2 DocumentField


completion = 0

(SUCCESSFUL). All other

codes are indicative of an

error condition. See Appendix

D, Table 76: Return Status

Codes Table for the return

status codes.

ReturnStatusMsg string 1 200 Y Text message for the

ReturnStatus.

3.3.3.1.29.2 DocumentField Content and Format

This data type is used to report all required fields associated with all citizenship codes and all

document IDs.

Table 60: DocumentField Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

DataElementName string 1 100 Y Parameters used in the EmpInitBPVerif and

EmpInitDABPVerif method calls.

RequiredInd string 1 1 Y A flag indicating whether or not the

DataElementName is required.

DocumentId int N/A N/A Y The field specifies the document ID.



CitizenshipName string 1 50 Y This field specifies the citizenship name for




Member XML/CPS

Type

Min

Len

Max

Len

Req Description

the citizenship code.

3.3.3.1.30 EmpGetCountryOfIssuanceList Content and Format

This Web Service method is used to retrieve a set of valid COI codes.

Table 61: EmpGetCountryOfIssuance Table

Members XML Type

Min Len

Max Len

Req Description

N/A N/A N/A N/A N/A N/A

This method returns an object of type: CountryOfIssuanceResp

3.3.3.1.30.1 CountryOfIssuanceResp Data Elements Content and Format

Table 62: CountryOfIssuanceResp Data Elements Table

Members XML

Type

Min

Len

Max

Len

Req Description

NumberOfCountryCodes int N/A N/A Y Number of country codes returned in

the CountryCodeList

CountryCodeList ArrayOfCountryCode N/A N/A Y List of CountryCode objects. This

list contains the set of CountryCode

objects. Each instance of a

CountryCode object identifies one of

the valid “Country of Issuance”

country codes.





Table for the return status codes.

ReturnStatusMsg string 1 64 Y Text message for the returnStatus.

3.3.3.1.30.2 CountryCode Data Elements

Table 63: CountryCode Data Elements Table

Members XML

Type

Min

Len

Max

Len

Req Description

Code string 1 5 Y The COI country code.

Descr string 1 100 Y The text description of the country code.




3.3.3.1.31 EmpCpsVerifyConnection Content and Format

This method is used to test the communications path to the employer’s (or E-Verify employer

agent’s) Web service client. It also tests the validity of a user ID/password combination. There

are no parameters for this method.

3.3.3.1.31.1 EmpCpsVerifyConnectionResp Content and Format

This data type returns results for a call to EmpCpsVerifyConnection.

Table 64: EmpCpsVerifyConnectionResp Data Elements Table

Members XML/CPS

Type

Min

Len

Max

Len

Req Description







3.3.3.1.32 EmpRetrieveFAN Content and Format

This method retrieves a pre-filled SSA or DHS Further Action Notice (FAN) or Referral Date

Confirmation (RDC) pdf letter. When a LetterTypeCode(s) is returned from a method call, this

method should be called with that LetterTypeCode to retrieve the appropriate letter. The

EmpRetrieveFAN method should be called once for each LetterTypeCode that is returned (If 2

LetterTypeCodes are listed, the method call will be called 2 times). This letter should be printed

and given to the employee associated with the E-Verify case used in this call. FAN letters are

associated with SSA and DHS TNCs. RDC letters are associated with referrals and states the

date by which an employee must contact SSA or DHS concerning his/her TNC.

Only the current active letter may be retrieved for a case.

Example: If an employee receives an SSA TNC, clears the TNC and receives a DHS TNC on the

resubmittal. You cannot retrieve the SSA FAN Letter because the DHS FAN letter is the active

letter.

Table 65: EmpRetrieveFAN Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

LetterTypeCode string 1 12 Y This field should contain one of the

following:

SSA_FAN

SSA_FA_FAN

SSA_NATZ_FAN

DHS_FAN




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

SSA_RDC

DHS_RDC

Language Int N/A N/A N 1 – English

2 – Spanish

(Default is English if no input is

provided)

3.3.3.1.32.1 EmpRetrieveFANResp25 Content and Format

This data type is used to package the output data after performing an EmpRetrieveFAN method

call.

Table 66: EmpRetrieveFANResp25 Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 N This is the case number parameter received

in the EmpRetrieveFAN method call.

LetterTypeCode string 1 30 N This is the LetterTypeCode parameter

received in the EmpRetrieveFAN method

call.

FAN byte[] N/A N/A N Byte array containing an SSA or DHS

FAN or RDC letter pdf.





status codes.


3.3.3.1.33 EmpGetDuplicateCaseList Content and Format

This method retrieves a list of duplicate cases associated with a case number and an SSN. It

should be called when a response code of 41 (Duplicate Case) is received from the

EmpInitBPVerif, EmpInitDABPVerif, or EmpSSAReVerify method calls.

Table 67: EmpGetDuplicateCaseList Content Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.



special characters.




3.3.3.1.33.1 EmpGetDuplicateCaseListResp Content and Format

This data type is used to package the output data after performing an EmpGetDuplicateCaseList

method call.

Table 68: EmpGetDuplicateCaseListResp Data Elements Table


Len

Max

Len

Req Description

DuplicateCaseList ArrayOfDupCaseListItem N/A N/A Y A list of duplicate cases. Each record

contains all of the required fields.

See section 3.3.3.1.32.2

DupCaseListItem

ReturnStatus Int N/A N/A Y Return status code. Normal

completion = 0 (SUCCESSFUL). All

other codes are indicative of an error

condition. See Appendix D, Table for

the return status codes.

ReturnStatusMsg String 1 200 Y Text message for the ReturnStatus.

3.3.3.1.33.2 DupCaseListItem Content and Format

This data type is used to report all required fields associated with a duplicate of a case.

Table 69: DupCaseListItem Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description

CaseNbr string 15 15 Y This is the CPS initial verification number.

DocumentSsn string 9 9 Y Employee’s SSN. The SSN should contain

only numbers with no spaces or special

characters.

CreatedDate dateTime N/A N/A Y The case created date in XML date format

YYYY-MM-DD. The hire date must be

between 11/07/1986 and current date + 365

days.

CreatorUserName string 12 12 Y The user ID of the person who submitted

the initial query.

HireDate dateTime N/A N/A Y The hire date in XML date format YYYY-

MM-DD. The hire date must be between

11/07/1986 and current date + 365 days.

CaseState string 4 4 Y The current state of the case. It indicates if

the case has been submitted for second or

third step.







3.3.3.1.34 EmpDupCaseContinueWithChanges Content and Format

This method updates the existing duplicate case record with the input values and continues to

process the case. This method provides employers a second chance to review and update the

verification data when a duplicate case response is returned during the initial or SSA re-

verification process.

A call to this method is optional after receiving an EligStatementCd of 41 and EligStatementTxt

of “Duplicate Case” from an initial verification attempt (EmpInitBPVerif, EmpInitDABPVerif)

or an SSA re-verification attempt (EmpSSAReVerify). All of the following fields are required

for the SSA re-verify: CaseNbr, LastName, FirstName, SSNNumber, and BirthDate. If you think

the case is truly a duplicate and you no longer need to continue the verification process, you can

close the case by calling the EmpCloseCase method.

This method performs a duplicate case check using the updated values. If the duplicate case

check is passed, then the case continues with the normal verification process. If a problem occurs

during the SSA check or DHS check and eligibility code of 42 (Verification in Process) is

returned, then the Initial or SSA re-verification is pending and the case is placed on a case


method) for the Initial or SSA re-verification response when the eligibility code of 42 is

received.


Process) is returned, then the Initial or SSA re-verification is completed and the case cannot be

processed. It is expected that the employer will create a new case for the employee.




Table 70: EmpDupCaseContinueWithChanges Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.










employee.

OtherNamesUsed string 1 40 N Other names the employee may have







Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

not allowed.



special characters.




3.3.3.1.35 EmpDupCaseContinueWithoutChanges Content and Format

This method continues the processing of a duplicate case without changing any of the original

input values. The employer must supply a reason for continuing with a duplicate case, and

depending on the state of the case, either the initial verification or SSA re-verification process

will be followed. This method provides employers the opportunity to acknowledge that a case is

a duplicate, and supply a reason for continuing.

A call to this method is optional after receiving an EligStatementCd of 41 and EligStatementTxt

of “Duplicate Case” from an initial verification attempt (EmpInitBPVerif,EmpInitDABPVerif)

or an SSA re-verification attempt (EmpSSAReVerify). All of the following fields are required

for the SSA re-verify: continueDupCaseReason.


in Process) is returned, then the Initial or SSA re-verification is pending and the case is placed on

a case reprocessing queue. The employer must poll the CPS system

(EmpGetNextResolvedCaseNbrs method) for the Initial or SSA re-verification response when

the eligibility code of 42 is received.


Process) is returned, then the Initial or SSA re-verification is completed and the case cannot be

processed. It is expected that the employer will create a new case for the employee.




Table 71: EmpDupCaseContinueWithoutChanges Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description


number.

ContinueDupCaseReason string 1 60 Y Reason for continuing a duplicate case.

See Appendix D, Table 86 for valid

continue reasons.

ContinueDupCaseOtherTxt string 1 200 N If a ContinueDupCaseReason of

“OTHER” is entered, then a value must

also be entered or

continueDupCaseOtherTxt. May contain




Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

only alphabetic characters, spaces, and

single quotes. Other special characters

and numbers are not allowed.

3.3.3.1.35.1 EmpGetDupCaseContinueReasons Content and Format

This method returns a list of valid reasons for continuing to process a case which has been

identified as a duplicate. No input parameters are required.

3.3.3.1.35.2 EmpDupCaseContinueReasonsResp Content and Format

This data type is used to return all of the available reasons which can be used to continue

processing a duplicate case.

Table 72: EmpGetDupCaseContinueReasonsResp Data Elements Table


Len

Max

Len

Req Description

ContinueReasons ContinueReason [] N/A N/A N/A This is an array of type ContinueReason .

ReturnStatus int N/A N/A N/A Return status code. Normal completion =





ReturnStatusMsg string 1 200 Text message for the ReturnStatus.

Table 73: ContinueReason Data Elements Table


Len

Max

Len

Req Description

ReasonCode string 1 60 N/A Reason identifier that can be used in a call to the

method.EmpDupCaseContinueWithoutChanges.

Description string 1 200 N/A Description of the reason code.

3.3.4 CPS E-Verify Web Service Interface Technical Design

The technical design of the CPS E-Verify Web Service Interface is not described in this

document. It is fully described in the VIS SDD (ITDL 182430).

3.3.5 CPS E-Verify Web Service Data Exception and Error Handling

The CPS E-Verify Web Service data exception and error handling is covered in two ways:

Security Exception Handling

Application Method Invocation Error Handling

Organizations building an interface to the CPS E-Verify Web Service must ensure that error

processing and recovery are built into their systems to handle or prevent the possible exception

or errors returned from this Web service.




3.3.5.1 Security Exception Handling

Security errors are returned using standard WS-Security exception

“System.Web.Service.Protocols.SoapHeaderException”. This exception is thrown when an

XML Web service method is called over SOAP and an exception occurs during processing of the

SOAP header. This exception is returned to the clients when UserName Token authentication

fails. For example, this may happen in the context of a invalid user ID being passed to VIS in

the SOAP security header.

3.3.5.2 Application Method Invocation Error Handling

Every Web service response object contains two fields that are used to communicate application-

level error processing information:

ReturnStatus – is an integer code value that indicates the status of execution for the Web

service method invocation.

ReturnStatusMsg – is a string value that provides a textual description of the error received.

A full description of the values for the ReturnStatus and ReturnStatusMsg is defined in Appendix

D Table .

4.0 CPS E-VERIFY WEB SERVICE ADMINISTRATION INTERFACE

4.1 CPS E-Verify Web Service Administration Functionality

4.1.1 CPS E-Verify Web Service Administration Data Format and Content

The following section defines the set of methods that will be provided by the E-Verify Web

Service Administration methods. These sections are intended to provide only an overview of the

parameters. The following sections do not provide the formal specification of the E-Verify Web

Service Administration methods. As a result of the WFC transitions, please note that all elements

must be present even if they are optional. You can pass an empty tag for optional fields. For the

complete formal specifications of E-Verify Web Service visit the following URL:

https://stage.e-verify.uscis.gov/WcfWebService/Administration.svc?WSDL

This section defines the set of E-Verify Web service administration methods. Each Web service

method accepts one or more input parameters and returns a single response object.

4.1.1.1 CPS E-Verify Web Service Administration Message Layout

4.1.1.1.1 SetUserPassword Content and Format

Please refer to section 3.2 CPS E-Verify Web Service Interface User Accounts and

Authentication for the User ID and password authentication process.

This method is used to change the password associated with the user’s Web service account. This

method may also be used to establish a new password for an account for which the password has

already expired.

Password rules:




Passwords have a maximum lifetime of 90 days. Please reset your password at least 5-10

days before this timeframe or risk being locked out.

With the exception of the initial password, the password lifespan shall be no less than 5 days.

The re-use of any of the previous eight passwords is not allowed.

An 8 to 14-character password composed with the following characteristics:

At least one uppercase or lowercase letter.

At least one number.

At least one special character (! @ $ % * ( ) < > ? : ; { } + - ~).

Contain no more than two identical consecutive characters in any position from the

previous password.

Contain a non-numeric character in the first and last position.

Additionally, as a policy, passwords shall not:

Contain any dictionary word.

Contain any proper noun or the name of any person, pet, child, or fictional character, nor any

employee serial number, Social Security Number, birth date, phone number, or any

information that could be readily guessed about the creator of the password.

Contain any simple pattern of letters or numbers, such as "qwerty" or "xyz123".

Be any word, noun, or name spelled backwards.

Table 74: SetUserPassword Data Elements Table

Parameter XML/CPS

Type

Min

Len

Max

Len

Req Description

NewPassword string 8 14 Y 8 to 14 character password composed of

three of the following: upper-case letters,

lower-case letters, numbers, and special

characters.

4.1.1.1.1.1 SetUserPasswordResp Content and Format

This data type returns results for a call to SetUserPassword.

Table 75: SetUserPasswordResp Data Elements Table

Member XML/CPS

Type

Min

Len

Max

Len

Req Description










Appendix A—Acronyms and Abbreviations

The following list provides the meaning of each acronym used in this document.

Acronym Meaning

A Alert Status

A# Alien Number

A-Number Alien ID Number

API Application Programming Interface

ASP Active Server Pages

CBP Customs and Border Patrol

CIS Central Index System

COB Country of Birth

COM (Microsoft) Component Object Model

COO Country of Origin

CPS Customer Processing Subsystem

DBA Database Administrator

DHS Department of Homeland Security

DOB Date of Birth

DOJ Department of Justice

DOL Department of Labor

EAD Employment Authorization Document

EADS Employment Authorization Document System

EEA E-Verify Employer Agent

ESB Enterprise Service Bus

FAN Further Action Notice

FAQ Frequently Asked Question

FCO File Control Office

FY Fiscal Year

GIF Graphical Interchange Format

GUI Graphical User Interface

HLQ High Level Qualifier

HTML Hypertext Markup Language

HTTP Hypertext Transport Protocol

HTTPS Hyper Text Transport Protocol Secure

I# I-94 Number

ICA Interface Control Agreement

ICD Interface Control Document also known as Interface Control Agreement (ICA)

ICE Immigration and Customs Enforcement

ID Identifier




Acronym Meaning

INA Immigration and Nationality Act

INS Immigration and Naturalization Services

IP Internet Protocol

IRCA Immigration Reform and Control Act

M&C Monitoring and Compliance

MOA Memorandum Of Agreement

MOU Memorandum Of Understanding

OIT Office of Information Technology

PDF Portable Document Format

PII Personally Identifiable Information

RDC Referral Date Confirmation

SA System Administrator

SDD System Design Document

SOAP Simple Object Access Protocol

SQL Structured Query Language

SSL Secure Socket Layer

SVS Status Verification System

TCP/IP Transmission Control Protocol/Internet Protocol

TECS Treasury Enforcement Communications System

UML Unified Modeling Language

USCIS U.S. Citizenship and Immigration Services, Bureau of (www.uscis.gov)

VIDB VIS Integrated Database

VIS Verification Information System

WCF Windows Communications Foundation

WSDL Web Service Description Language




Appendix B—Signature Page

Interface Control Agreement Between

Customer Processing System (CPS) Employer Web Service

And

USCIS Verification Division as custodian of the Employer MOUs

Effective: 11/26/2014

Approved by:

Signature:

Djakoure R. Agre Date

VIS IT Project Manager USCIS Program Executive

Office

CPS E-Verify

Signature:

Chirag Bhavsar, representing Howard "Mac"

MacMillan as custodian of Employer MOUs

Date

Business System Owner USCIS Verification Division

This Agreement is valid until N/A

Date




Appendix C—WSDL File

To access the WSDL file, use the following URL:


The WSDL file for the E-Verify Web Service administration test system may be accessed using

the following URL:





Appendix D—Reference Codes Valid Values

Table depicts the set of Web service return codes.

Table 76: Return Status Codes Table

Return Status

Codes

Return Status Message Text Return Code Description

0 SUCCESSFUL Web service call completed successfully.

-3 NO DATA FOUND The system could not find the information. (For

example,if the WS client calls the GetNextResolvedCase

and the system cannot find a case number, this error will

be sent.)

-1000 Invalid or missing input parameter. An internal Web service or database error was detected

while processing a Web service request.

-1001 System error submitting Initial

Verification.

An internal Web service or database error was detected

while initiating an initial verification query.

-1001 Must provide Alien Number, I94 Number

or Passport Number

A required field error, either Alien Number or I94

Number or Passport Number must be in the Web service

call.

-1002 System error submitting Secondary

Request.


while initiating an additional verification query.

-1003 System error retrieving the next pending

case number.


while retrieving a pending case number.

-1004 System error retrieving a Secondary

Resolution.


while retrieving an additional resolution.

-1005 System error deleting next pending case

number.


while deleting a pending case number.

-1006 System error closing case “case number.” An internal Web service or database error was detected

while closing a case.

-1007 System error retrieving details for case

“case number.”


while retrieving case details.

-1008 System error setting password. An internal Web service or database error was detected

while changing a password.

-1020 Alien number or I-94 number must exist. A “required field” error, either an Alien Registration

Number or a Form I-94 Number must be in the Web

service call.

-1021 Cannot have both an Alien number and

an I-94 number.

An Alien Registration Number or a Form I-94 Number

must be in the Web service call but not both.

-1023 Required input field (Alien Number) is

null.

The required parameter Alien Registration Number was

not received by the Web service method.

-1024 Required input field (I-94 Number) is

null.

The required parameter Form I-94 Number was not

received by the Web service method.

-1025 Required input field (Case Number) is

null.

The required parameter Case Number was not received by

the Web service method.

-1026 Required input field (DocumentType) is The required parameter DocumentType was not received




Return Status

Codes


null. by the Web service method.

-1028 Required input field (DocExpDate) is

null.

The required parameter DocExpDate was not received by


-1029 Required input field (LastName) is null. The required parameter LastName was not received by the

Web service method.

-1030 Required input field (FirstName) is null. The required parameter FirstName was not received by


-1031 Required input field (BirthDate) is null. The required parameter BirthDate was not received by the

Web service method.

-1032 Required input field (Birth Date) is null. The required parameter BirthDate was not received by the

Web service method.

-1033 Required input field (Hire Date) is null. The required parameter HireDate was not received by the

Web service method.

-1034 Required input field (Referral Date) is

null.

The required parameter ReferralDate was not received by


-1035 Required input field (Close Status) is

null.

The required parameter CloseStatus was not received by


-1040 Invalid input field format, length/format

(Alien Number).

Alien Registration Numbers must be 9 characters long and

must be numeric.


(I-94 Number).

Form I-94 Numbers must be 11 characters long and must

be numeric.


(Case Number).

The length of the Case Number parameter is invalid. Case

numbers must be 15 characters long and can be

alpha/numeric.


(DocumentType).

The length of the Document Type parameter is invalid.

Document Types can be up to 35 characters long. See

Appendix D Table 77: for the set of valid values.


(LastName).

The length of the Last Name parameter is invalid. Last

name field can be up to 40 characters long.


(FirstName).

The length of the First Name parameter is invalid. First

Name field can be up to 25 characters long.

-1048 Invalid DocumentType. Invalid document type value received. See Appendix D

Table 77: for the set of valid values.

-1049 Invalid Document Expiration Date. Invalid date received. An invalid month, day or year was

received.

-1050 Invalid Birth Date. Invalid date received. An invalid month, day or year was

received.

-1051 Invalid input field length

(ClientSftwrVer)

The length of the ClientSftwrVer parameter is invalid.

ClientSftwrVer field can be up to 30 characters long.


(EmployerCaseID).

The length of the EmployerCaseID parameter is invalid.

First EmployerCaseID can be up to 40 characters long.

-1053 Invalid input field length (MaidenName). The length of the MaidenName parameter is invalid.

MaidenName field can be up to 40 characters long.




Return Status

Codes


-1055 No permissions to access this case. The Web service user does not have the appropriate

permissions to access a particular case.

-1056 Doc Other Description cannot have a

value for selected Doc Type.

The DocOtherDesc field may only contain data when the

DocType field is set to “Other.”

-1057 Invalid input field length (Comment). The length of the Comment parameter is invalid. The

Comment parameter can be up to 150 characters long.


(SubmittingOfficial).

The length of the SubmittingOfficial parameter is invalid.

The SubmittingOfficial parameter can be up to 30

characters long.


(SubmittersPhoneNbr).

The length of the SubmittersPhoneNbr parameter is

invalid. The SubmittersPhoneNbr parameter can be up to

10 characters long.

-1060 Invalid input field length (MiddleInitial). The length of the MiddleInitial parameter is invalid. The

MiddleInitial parameter can be 1 character.

-1061 Invalid input field length/format (SSN). The length of the SSN parameter is invalid. The SSN

parameter can be 9 characters long.

-1062 The Hire Date must be between

11/07/1986 and the current date + 365

days.

Hire Date has to be between 11/07/1986 and the current

date + 365 days.

-1063 The Referral Date must be equal to or

greater than the initial verification date

and less than or equal to the current date.

The Referral Date must be equal to or greater than the

initial verification date and less than or equal to the

current date.

-1064 Invalid ClientCompanyId for

User/Employer.

The Client Company does not exist or is not mapped to

the employer.

-1070 Invalid Citizenship Code or Citizenship

Code/DocType combination.

The Citizenship Code does not exist or is invalid for the

Doc Type chosen.

-1071 The Alien number must exist and the I-

94 number must not exist.

The Alien Registration Number must exist and the Form

I-94 number must not exist.

-1072 Invalid or missing input

field(ClientCompanyId).

The input Client Company does not exist in CPS or was

null coming into the method.

-1073 Invalid closure code. Closure Code is invalid. See Appendix D Table for valid

Closure Codes.

-1074 Invalid closure code for the current state

of the case.

The chosen Closure Code cannot be used because of the

current state of the case.

-1075 Invalid combination of fields:

AlienNumber, I-94Number, and

CitizenshipStatus

The CitizenshipStatus is not valid with an AlienNumber

or I-94Number.

-1076 User does not have access to this method. A BP user cannot use the DABP method and vice versa.

-1077 DABP users are required to call the

EmpInitDABPVerif method with a

ClientCompanyId parameter.

A DABP user is trying to call the BP Web service

method.

-1078 BP users may not call the

EmpInitBPVerif method with a

ClientCompanyId parameter.

A BP user is trying to call the DABP Web service

method.




Return Status

Codes


-1086 The Document Expiration Date field

should be null.

The Document Expiration Date information is not

required.

-1090 Case does not exist or you do not have

the correct privileges to access case.

The case number received in a method call does not exist

in the CPS database or the user invoking the method does

not have the correct privileges to access the case.

-1092 Invalid input field, SearchType. Missing or invalid parameter data in call to


1 – Retrieve next single case of specified TypeOfCase.

2 – Retrieve all cases of specified TypeOfCase.

3 – Retrieve all cases for all Case types. TypeOfCase must

be NULL.

-1093 Invalid input field, TypeOfCase. Missing or invalid parameter data in call to


1 – SSA Referral response

2 – DHS Secondary response

3 – DHS Third Step response

NULL – All case types

-1094 Invalid input field, AcknowledgeFlg. Missing or invalid parameter data in call to


Y – Delete case number from queue

N – Do not delete case number from queue

-1095 The uploaded file is too large. The

maximum file size is XXX.

An uploaded file is larger than the system defined

maximum upload file size.

-1096 This is not a GIF file. Only GIF files may

be uploaded.

Only GIF file can be uploaded to the system at this time.

-1097 The uploaded file failed a virus scan and

cannot be uploaded.

A virus was found in an upload file.

-1098 Required input field (Visa Number)is

null.

The required parameter VisaNumber was not received by



(Visa Number).

The VisaNumber length must be 8 characters.

-1100 Required input field (Passport Number)is

null.

The required parameter PassportNumber was not received

by the Web service method.


(Passport Number).

The PassportNumber length must be between 6 and 12

characters.

-1102 Required input field (Card Number)is

null.

The required parameter CardNumber was not received by



(Card Number).

The CardNumber length must be 13 characters.

-1104 Required input field

(PhotoConfirmation)is null.

The required parameter PhotoConfirmation was not

received by the Web service method.

-1105 Required input field (UnsureComment)is

null.This field is required with a

The required parameter UnsureComment was not received

by the Web service method.




Return Status

Codes


PhotoConfirmation of U.

-1106 Invalid input field (UnsureComment).

Field may only be used with a

PhotoConfirmation of U/field size 140.

The UnsureComment length must be between 1 and 140

characters and can only be used with a PhotoConfirmation

field containing U.

-1107 Required input field (UploadPhoto) is

null.

The required parameter UploadPhoto was not received by


-1108 Invalid input field (UploadPhoto). Field

must contain either a Y or N.

The Web service method received data other than a Y or

an N.

-1109 Required input field (Photo) is null. The required parameter Photo was not received by the

Web service method.

-1110 Invalid Card Number/Citizenship

Status/Document Type combination.

Invalid combination of input fields.

-1111 The Passport field should be null. The Web service method should not have received data in

the PassportNumber field.

-1112 The Visa field should be null. The Web service method should not have received data in

the VisaNumber field

-1113 Invalid Passport Number/Citizenship

Status/Document Type combination.

Invalid combination of input fields.

-1114 One or more of the following input fields

(Alien Number,I-94 Number,Card

Number,Visa Number or Passport

Number)is required.

A required field was not received by the Web method.

-1115 Required input fields (Passport Number

and Visa Number) are null.

The required parameters PassportNumber and

VisaNumber were not received by the Web service

method.

-1116 The CardNbr field should be null, this

field is not being used in this version.

Data was received in this field. Only a null can be

received in this field.

-1124 The Hire Date must be between

11/07/1986 and the current date + 365

days.

Hire Date has to be between 11/07/1986 and the current

date + 365 days. This will apply when FAR is active on

the E-Verify system.

-1125 Birth date cannot be greater than current

date.

Input Birth Date must be less than the current date.

-1126 Hire date must be greater than birth date. Input Hire Date must be greater than input Birth Date.

-1127 The file cannot be found. The file failed a

virus scan and cannot be uploaded

Uploaded file was discarded because it failed a virus scan.

-1128 OverDueVerifyReason cannot be NULL. OverDueVerifyReason is required with the verification

call because it has been over 3 days since the employee

was hired.

-1129 OverDueVerifyReasonOther cannot be

NULL.

An OverDueVerifyReason of “other” was selected so

free-form text explaining why the verification is after the

3 day rule must be included.

-1130 OverDueVerifyReason must be NULL. It has not been 3 days since the employee hiring. This

field must be blank.

-1131 OverDueVerifyReasonOther must be Other was not sent in the OverDueVerifyReason field so




Return Status

Codes


NULL. this field must be blank.

-1132 OverDueVerifyReason value is invalid. Not a valid OverDueVerifyReason value.

-1133 Invalid SSA Letter Code. Invalid letter code in the EmpUpdateSSALetterReceived

method call.

-1134 Invalid DHS Letter Code. Invalid letter code in the EmpUpdateDHSLetterReceived

method call.

-1135 System error updating letter receive date. Could not update database with letter received date.

-1136 System error retrieving case alert counts. Could not retrieve case alert counts.

-1137 CurrentlyEmployed must contain either a

Y or N.

Required field in EmpCloseCase method. Field describes

if employee is still working for employer.

-1138 Invalid AlertType. AlertType must

contain a C,U,or E.

Invalid alert type sent in the EmpGetAlertCases method.

-1139 System error retrieving Alert Cases. Could not retrieve alert cases.

-1140 Required input field (List B Document)is

null.

The ListBDocumentId input parameter must contain a

document ID.

-1141 Required input field (List C Document)is

null.

The ListCDocumentId input parameter must contain a

document ID.

-1142 An unexpired document is required

(DocExpDate).

The DocExpDate input parameter contains a date less than

the “current date”.

-1143 The document expiration date cannot be

more than 10 years in the future

(DocExpDate).

The DocExpDate input parameter contains a date more

than 10 years greater than the “current date”.

-1144 The List B or C document is invalid for

citzenship code.

The ListBDocumentId or ListCDocumentId input

parameter contains a document ID that can not be used

with the input citizenship code.


(StateIssuingAuthority) is null.

The StateIssuingAuthority input parameter must contain a

valid Issuing Authority.

-1146 The Issuing Authority Code

(StateIssuingAuthority) is invalid.

The StateIssuingAuthority input parameter must contain a

valid Issuing Authority.


(SupportingDocumentId) is null.

The SupportingDocumentId input parameter must contain

a valid Supporting Document ID.

-1148 Invalid Issuing Authority and List B or C

Document combination.

The StateIssuingAuthority input parameter is invalid with

the List B Document ID.

-1149 The Supporting Document ID

(SupportingDocumentId) is invalid.

The data in the SupportingDocumentId input parameter is

not a valid Supporting Document.

-1150 Required input field (DMVDocumentId)

is null.

The DMVDocumentId (driver’s license, state ID card

number) input parameter must contain a 9 digit number.

-1151 DMVDocumentId must be null. The DMVDocumentId (driver’s license, state ID card

number) input parameter should not contain data.

-1152 DMVDocumentId must be 9 digits. The length of the DMVDocumentId (driver’s license, state

ID card number) input parameter is invalid. This field

must contain a 9 digit number.




Return Status

Codes


-1153 DMVDocumentId must be numeric. The DMVDocumentId (driver’s license, state ID card

number) input parameter contains invalid characters. This

field must be numeric.

-1154 DMVDocNoExpirationDate must be

null.

The DMVDocNoExpirationDate flag input parameter

should not contain data.

-1155 DMVDocNoExpirationDate or

DocExpDate (not both) is required

Both DMVDocNoExpirationDate and DocExpDate

cannot contain input data for the same verification query.

-1156 Both DMVDocNoExpirationDate and

DocExpDate must not exist

Both DMVDocNoExpirationDate and DocExpDate

cannot contain input data for the same verification query.

-1157 DMVDocNoExpirationDate must be Y. The DMVDocNoExpirationDate input flag parameter

must contain a “Y”.

-1316 Cannot find a version number for Web

Service UserId.

Company/user invoking Web Service method does not

have a Web Service version number assigned.

-1317 Invalid Web Service version called. You

are configured for a different version.

A user is calling the wrong version of a Web Service

method.

-1319 System Error updating SSA TNC

Notification.


while initiating the TNC Notification.

-1320 Required input field (EmployeeNotified)

is null.

The EmployeeNotified input flag parameter must not be

null.

-1321 The (EmployeeNotified) field must

contain a Y or N.

The EmployeeNotified input flag parameter must contain

a “Y” or “N”.

-1322 System Error updating DHS TNC

Notification.


while initiating the TNC Notification.

-1323 Required input field (Employee Notified)

is null.

The EmployeeNotified input flag parameter must not be

null.

-1324 The (EmployeeNotified) field must

contain a Y or N.

The EmployeeNotified input flag parameter must contain

a “Y” or “N”.

-1327 Employee was not notified about the

SSA TNC.

EmpSaveSSATNCNotification Web Service method was

not called to notify CPS that the employee has been

notified of the SSA TNC. EmpSaveSSATNCNotification

Web Service method is required to be invoked first before

submitting the SSA Referral and invoking

EmpSubSSAReferral Web Service method.

-1328 Employee was not notified about the

DHS TNC.

EmpSaveDHSTNCNotification Web Service method was

not called to notify CPS that the employee has been

notified of the DHS TNC. EmpSaveDHSTNCNotification

Web Service method is required to be invoked first before

submitting the DHS Referral and invoking

EmpSubDHSReferral Web Service method.

-1329 This is not a GIF or JPG file. Only GIF

or JPG files may be uploaded.

Only GIF or JPG file can be uploaded to the system at this

time.

Table 77: depicts the set of valid document type codes for the current Form I-9 used by

employers or E-Verify employer agents and passed in the EmpInitBPVerif, EmpInitDABPVerif




and EmpSubmitAdditVerif Web service methods. The column labeled Document ID contains

the values passed as parameters in the E-Verify Web Service methods. The Description of

Document Type column is provided to aid the reader. The Document Expiration Date Input

Indicator column identifies for which document the document expiration date parameter must be

passed in the E-Verify Web Service methods.

Table 77: DHS Document Types

Docu-

ment

ID

Document Type Description

of Document

Type

DocumentE

xpirationDa

te Input

Indicator

Valid for

Citizenship

Flag of 4 – A

citizen of the

United

States

Valid for

Citizenship

Flag of 5 – A

noncitizen

national of

the United

States

Valid for

Citizenship

Flag of 6 -

A lawful

permanent

resident

Valid for

Citizenship

Flag of 7 -

An alien

authorized

to work

11 Arrival/Departur

e Record (Form

I-94) with

temporary I-551

stamp or refugee

admission

stamp(receipt)

Arrival/

Departure

Record

Optional N N Y Y

13 Permanent

Resident Card or

Alien

Registration

Receipt Card

(Form I-551)

Permanent

Resident or

Resident

Alien Card

Not Allowed N N Y N

17 Employment

Authorization

Document (Form

I-776)

Employment

Authorization

Required N N N Y

24 Foreign Passport

with

Arrival/Departur

e Record (Form

I-94)

Optional N N N Y

25 Foreign Passport

with temporary

I-551 stamp or

printed notation

on a MRIV

Optional N N Y N

28 List B and C

Documents

List B State

Driver’s

License or

State Issued

ID Card and

C Documents

Optional for

lawful

permanent

resident and

alien

authorized

to work

Y Y Y Y

29 U.S. Passport or Required Y Y N N




Docu-

ment

ID

Document Type Description

of Document

Type

DocumentE

xpirationDa

te Input

Indicator

Valid for

Citizenship

Flag of 4 – A

citizen of the

United

States

Valid for

Citizenship

Flag of 5 – A

noncitizen

national of

the United

States

Valid for

Citizenship

Flag of 6 -

A lawful

permanent

resident

Valid for

Citizenship

Flag of 7 -

An alien

authorized

to work

Passport Card

Required – Denotes that a value MUST be provided for the input field.

Optional – Denotes that a value may be provided for the input field.

The selected document type must be compatible with the selected citizenship flag. The last three

columns describe which document types may be used with each of the citizenship flags.

*This table is subject to change in future releases.

Table 78: depicts the set of response codes that are returned by the EmpInitBPVerif,

EmpInitDABPVerif, EmpSSAReVerify,EmpDHSReVerify, EmpCitDHSReVerify,

EmpDMVDHSReVerify and EmpSubmitResubmittal Web service methods.

Table 78: Initial Verification Response Codes

CP

S

Co

de

Mes

sag

e D

escr

ipti

on

Ret

urn

ed F

rom

Em

pIn

itB

PV

erif

an

d

Em

pIn

itD

AB

PV

erif

Ret

urn

ed F

rom

Em

pS

ub

mit

Resu

bm

itta

l

Ret

urn

ed F

rom

Em

pS

SA

ReV

erif

y

Ret

urn

ed F

rom

Em

pC

itD

HS

ReV

erif

y,

Em

pD

up

Ca

seC

on

tin

ueW

it

ho

utC

ha

ng

es

Ret

urn

ed F

rom

Em

pD

HS

ReV

eri

fy,

Em

pD

MV

DH

SR

eVeri

fy,a

nd

Em

pC

itD

HS

ReV

erif

y

05 Institute Additional

Verification

Y Y Y Y Y

08 Employment Authorized Y Y Y Y Y

16 SSA Employment Authorized Y Y Y Y N

27 SSA Tentative

Nonconfirmation (TNC)

-Start SSA referral process.

Y N Y Y N

29 DHS Tentative


-Start the DHS referral process.

This code can be received after

calling EmpConfirmPhoto to

“reject” a photo.

N N N N Y

30 Case Incomplete

-Some data in the initial query

verified by DHS is incorrect.

Y Y Y Y N




CP

S

Co

de

Mes

sag

e D

escr

ipti

on

Ret

urn

ed F

rom

Em

pIn

itB

PV

erif

an

d

Em

pIn

itD

AB

PV

erif

Ret

urn

ed F

rom

Em

pS

ub

mit

Resu

bm

itta

l

Ret

urn

ed F

rom

Em

pS

SA

ReV

erif

y

Ret

urn

ed F

rom

Em

pC

itD

HS

ReV

erif

y,

Em

pD

up

Ca

seC

on

tin

ueW

it

ho

utC

ha

ng

es

Ret

urn

ed F

rom

Em

pD

HS

ReV

eri

fy,

Em

pD

MV

DH

SR

eVeri

fy,a

nd

Em

pC

itD

HS

ReV

erif

y

Call one of the following

methods to retry initial

verification:

*Call EmpDHSReVerify or

EmpCitDHSReVerify

31 Photo Matching Required

EmpConfirmPhoto call

required

Y Y Y Y Y

36 Case Incomplete

-Some data in the initial query

verified by SSA is incorrect.

Call the following method to

retry initial verification:

EmpSSAReVerify call required

Y N N Y N

38 **DHS Tentative


Y N Y Y N

41 Duplicate Case

-A case with the same SSN

number has been processed for

this employer within the last

thirty days.

* Call

EmpDupCaseContinueWithCha

nges or

EmpDupCaseContinueWithout

Changes

Y N Y Y N

42 Verification in Process

Verification pending, case is on

the Case Reprocessing Queue

because of a remote call failure.

Y Y Y Y Y

43 Unable to Process

Max entries for the case to be

reprocessed exceeded. Could

not process case.

Y Y Y Y Y

* Call EmpDHSReVerify to reverify “Lawful Permanent Residents” and “Aliens Authorized to

Work”. Call EmpCitDHSReVerify to reverify U.S. citizens using an Unexpired Passport as their

verification document.




** CPS Code 38 (DHS Tentative Nonconfirmation (TNC) - If you receive this code you will

bypass the second-step process and go to the third-step process.

Example:

-Issue initial verification

-Receive a Response Code of 38

- Retrieve FAN/RDC and present employee with appropriate DHS FAN letter (you can

determine the appropriate letter by using the LetterTypeCodeList field in the DHS Referral

response)

-If employee chooses to contest, issue a DHS Referral


Table 79: depicts the set of SSA Referral Response codes that can be returned when an SSA

Referral is returned by the EmpGetNextResolvedCaseNbrs Web service method.

Table 79: SSA Referral Response Codes

CPS

Code Message Description

05 Institute Additional Verification

08 Employment Authorized

16 SSA Employment Authorized

28 SSA Final Nonconfirmation

30 Case Incomplete

-Some data in the initial query verified by DHS is incorrect. Call one of the following methods to retry

initial verification:

*Call EmpDHSReVerify or EmpCitDHSReVerify

31 Photo Matching Required

EmpConfirmPhoto call required

34 SSA Case In Continuance

-SSA needs more time to resolve case.

35 Review and Update Employee Data

-Review data and then call EmpSSAResubmittal to reissue the initial verification. If data is still invalid

an SSA FNC will be received.

D Empty String

Informational message code – SVS referred naturalized user back to SSA.


Table 80: depicts the set of DHS Additional (secondary) Resolution Codes that can be returned

when a DHS Additional Response is returned by the EmpGetNextResolvedCaseNbrs Web

service method.




Table 80: DHS Additional Resolution Codes

Resolution Code Resolution Description

A Employment Authorized

U DHS Tentative Nonconfirmation (TNC)

-Start the DHS referral process.

C DHS Case In Continuance

This is NOT a final response for this query. This value indicates that DHS is

requesting more time to resolve the additional verification request. When this

value is returned, the final resolution will be returned at a future time.


Table 81 depicts the set of DHS Referral Resolution Codes that can be returned when a DHS

Referral response is returned by the EmpGetNextResolvedCaseNbrs Web service method.

Table 81: DHS Referral Resolution Codes

Resolution Code Resolution Description

I DHS Case In Continuance

This is NOT a final response for this query. This value indicates that DHS is requesting

more time to resolve the DHS referral request. When this value is returned, the final

resolution will be returned at a future time.

N DHS Final Nonconfirmation

O Employment Authorized

S DHS No Show

DHS is indicating that the alien did not contact the MPA to discuss and resolve the DHS

referral within 10 business days.

P Passport Data verified.

SVS has verified the referred data for a U.S. Citizen with a passport and is requesting the

user to retrieve and confirm the passport photo.

Call EmpRetrievePhoto to retrieve the passport photo and then call EmpConfirmPhoto to

either confirm or reject the photo. (Note – If you reject the photo you will receive another

DHS TNC and will be required to go through the DHS referral process again.)

X Close and Resubmit the case.

SVS could not process the user’s passport data and is requesting that the current case be

closed and another initial verification started for the user.


Table depicts the set of Closure Codes that are used in the EmpCloseCase Web service method.

Table 82: Closure Codes

Closure

Code

Description

EELIG The employee continues to work for the employer after receiving an Employment Authorized result.

EFNC The employee continues to work for the employer after receiving a Final Nonconfirmation result..

ENOACT The employee continues to work for the employer after receiving a No Show result. Employer




retains employee

EUNCNT The employee continues to work for the employer after choosing not to contest a Tentative

Nonconfirmation.

TRMFNC The employee was terminated by the employer for receiving a Final Nonconfirmation result.

EQUIT The employee voluntarily quit working for the employer.

TERM The employee was terminated by the employer for reasons other than E-Verify.

NOACT The employee was terminated by the employer for receiving a No Show result.

UNCNT The employee was terminated by the employer for choosing not to contest a Tentative

Nonconfirmation.

DUP The case is invalid because another case with the same data already exists.

INCDAT The case is invalid because the data entered is incorrect.

ISDP The case is a duplicate because the employer created a case with the same data within the past 30

days.

TECISS This case is being closed because of technical issues with E-Verify.

EARCLS The case is being closed because DHS or SSA instructed this employer to close the case.

EARNEW The case is being closed because DHS or SSA instructed this employer to create a new case for this

employee.

EDEXPD The case is being closed because the document is expired.

ENCLNT The employer is no longer our client.

ENEMPD The employee is no longer employed by the employer for reasons unrelated to E-Verify and the

TNC process could not be completed.


Table depicts which set of Closure Codes are valid with the current state of the case and when

the employee still works for the employer. Not all closure codes may be used to close a case at

all times. The set of closure codes that are valid in the EmpCloseCase Web service method is

based on the current state of the case and/or the most recent eligibility associated with the case.

**Employee still works for the employer




Table 83: Closure Codes Usage Based on Case “State”: ‘Employee Continues to Work for

the Employer

Current Case

State/Eligibility EE

LIG

– T

he

em

plo

yee

co

nti

nu

es t

o w

ork

for

the

emp

loy

er a

fter

rece

ivin

g a

n

Em

plo

ym

ent

Au

tho

rize

d r

esu

lt

EF

NC

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk

for

the

emp

loy

er a

fter

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n r

esu

lt

EN

OA

CT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

rece

ivin

g a

No

Sh

ow

resu

lt

EU

NC

NT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

ch

oo

sin

g n

ot

to c

on

test

a T

enta

tiv

e N

on

con

firm

ati

on

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y

exis

ts

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta e

nte

red

is

inco

rrec

t.

TE

CIS

S -

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f te

ch

nic

al

issu

es

wit

h E

-Ver

ify

.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e

da

ta w

ith

in t

he

pa

st 3

0 d

ay

s.

After initial

verification &

message code = 27

(SSA TENTATIVE

NONCONFIRMATI

ON)

X X X

After initial

verification &

message code = 16

(SSA

EMPLOYMENT

AUTHORIZED)

X X X

After initial

verification &

message code = 08

(EMPLOYMENT

AUTHORIZED)

X X X

After SSA reverify

(EmpSSAReVerify) X X

After DHS reverify

(EmpDHSReverify) X X

After SSA Referral

and before response

(EmpSubSSAReferr

al)

X X

After SSA Referral

& message code =

28 Includes No

Show

(SSA FINAL

NONCONFIRMATI

ON)

X X X




Current Case


LIG

– T

he

em

plo

yee

co

nti

nu

es t

o w

ork

for

the

emp

loy

er a

fter

rece

ivin

g a

n

Em

plo

ym

ent

Au

tho

rize

d r

esu

lt

EF

NC

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk

for

the

emp

loy

er a

fter

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n r

esu

lt

EN

OA

CT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

rece

ivin

g a

No

Sh

ow

resu

lt

EU

NC

NT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

ch

oo

sin

g n

ot

to c

on

test

a T

enta

tiv

e N

on

con

firm

ati

on

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y

exis

ts

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta e

nte

red

is

inco

rrec

t.

TE

CIS

S -

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f te

ch

nic

al

issu

es

wit

h E

-Ver

ify

.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e

da

ta w

ith

in t

he

pa

st 3

0 d

ay

s.

After SSA Referral

& message code =

16

(SSA

EMPLOYMENT

AUTHORIZED)

X X X

After SSA Referral

& message code =

08

(EMPLOYMENT

AUTHORIZED)

X X X

After additional

response &

resolution code = U

(DHS TENTATIVE

NONCONFIRMATI

ON)

(not referred)

X X X

After DHS Referral

request and before

receiving

DHS Referral

response

X X

After Photo and

(EMPLOYMENT

AUTHORIZED)

X X X

After Photo and

DHS TNC X X X

After DHS Referral

response &

resolution code = O

(EMPLOYMENT

AUTHORIZED)

X

X X




Current Case


LIG

– T

he

em

plo

yee

co

nti

nu

es t

o w

ork

for

the

emp

loy

er a

fter

rece

ivin

g a

n

Em

plo

ym

ent

Au

tho

rize

d r

esu

lt

EF

NC

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk

for

the

emp

loy

er a

fter

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n r

esu

lt

EN

OA

CT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

rece

ivin

g a

No

Sh

ow

resu

lt

EU

NC

NT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

ch

oo

sin

g n

ot

to c

on

test

a T

enta

tiv

e N

on

con

firm

ati

on

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y

exis

ts

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta e

nte

red

is

inco

rrec

t.

TE

CIS

S -

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f te

ch

nic

al

issu

es

wit

h E

-Ver

ify

.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e

da

ta w

ith

in t

he

pa

st 3

0 d

ay

s.

After DHS Referral

response &

resolution code = N

(DHS FINAL

NONCONFIRMATI

ON)

X X X

After DHS Referral

response &

resolution code = S

(DHS NO SHOW)

X X X

After DHS Referral

response &

resolution code = X

(CLOSE AND

RESUBMIT CASE)

X

After DHS Referral

response &

resolution code = P

(PASSPORT DATA

VERIFIED)

X X

After Initial

Verification/ SSA

Reverify/ SSA

Resubmittal/ DHS

Reverify and

message code = 42

(VERIFICATION

IN PROCESS)

X X

After Initial

Verification/ SSA

Reverify/ SSA

Resubmittal/ DHS

Reverify and

message code = 43

(UNABLE TO

X X X




Current Case


LIG

– T

he

em

plo

yee

co

nti

nu

es t

o w

ork

for

the

emp

loy

er a

fter

rece

ivin

g a

n

Em

plo

ym

ent

Au

tho

rize

d r

esu

lt

EF

NC

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk

for

the

emp

loy

er a

fter

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n r

esu

lt

EN

OA

CT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

rece

ivin

g a

No

Sh

ow

resu

lt

EU

NC

NT

– T

he

emp

loy

ee c

on

tin

ues

to

wo

rk f

or

the

emp

loy

er a

fter

ch

oo

sin

g n

ot

to c

on

test

a T

enta

tiv

e N

on

con

firm

ati

on

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y

exis

ts

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta e

nte

red

is

inco

rrec

t.

TE

CIS

S -

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f te

ch

nic

al

issu

es

wit

h E

-Ver

ify

.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e

da

ta w

ith

in t

he

pa

st 3

0 d

ay

s.

PROCESS)

After Initial

Verification/ SSA

Reverify/ SSA

Resubmittal/ DHS

Reverify and

message code = 41

(Duplicate Case)

X X

After Continue

Without Changes X X X


Table depicts which set of “Closure Codes” are valid with the current “state” of the case and

“when the employee does not still work for the employer”. Not all closure codes may be used to

close a case at all times. The set of closure codes that are valid in the EmpCloseCase Web

service method is based on the current state of the case and/or the most recent eligibility

associated with the case.

**Employee does not work for the employer




Table 84: Closure Codes Usage Based on Case “State”: Employee Continues to Work for

the Employer

Current Case

State/Eligibility TR

MF

NC

– T

he

emp

loy

ee w

as

term

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n

resu

lt

NO

AC

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

No

Sh

ow

resu

lt.

UN

CN

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

cho

osi

ng

no

t to

co

nte

st a

Ten

tati

ve

No

nco

nfi

rma

tio

n.

EQ

UIT

– T

he

emp

loy

ee v

olu

nta

rily

qu

it w

ork

ing

for

the

emp

loy

er.

TE

RM

– T

he

em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rea

son

s o

ther

th

an

E-V

erif

y.

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y e

xis

ts.

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta

ente

red

is

inco

rrec

t

TE

CIS

S –

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f

tech

nic

al

issu

es w

ith

E-V

erif

y.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e d

ata

wit

hin

th

e p

ast

30

da

ys.

After initial verification &

message code = 27

(SSA TENTATIVE

NONCONFIRMATION)

X X X X X


message code = 16

(SSA EMPLOYMENT

AUTHORIZED)

X X X X


message code = 08

(EMPLOYMENT

AUTHORIZED)

X X X X

After SSA reverify

(EmpSSAReVerify) X X X X

After DHS reverify

(EmpDHSReverify) X X X X

After SSA Referral and

before response

(EmpSubSSAReferral)

X X X X

After SSA Referral &

message code = 28

Includes No Show

(SSA FINAL

NONCONFIRMATION)

X X X X X


message code = 16

(SSA EMPLOYMENT

AUTHORIZED)

X X X X




Current Case


MF

NC

– T

he

emp

loy

ee w

as

term

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n

resu

lt

NO

AC

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

No

Sh

ow

resu

lt.

UN

CN

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

cho

osi

ng

no

t to

co

nte

st a

Ten

tati

ve

No

nco

nfi

rma

tio

n.

EQ

UIT

– T

he

emp

loy

ee v

olu

nta

rily

qu

it w

ork

ing

for

the

emp

loy

er.

TE

RM

– T

he

em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rea

son

s o

ther

th

an

E-V

erif

y.

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y e

xis

ts.

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta

ente

red

is

inco

rrec

t

TE

CIS

S –

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f

tech

nic

al

issu

es w

ith

E-V

erif

y.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e d

ata

wit

hin

th

e p

ast

30

da

ys.


message code = 08

(EMPLOYMENT

AUTHORIZED)

X X X X

After additional response

& resolution code = U

(DHS TENTATIVE

NONCONFIRMATION)

(not referred)

X X X X X

After DHS Referral

request and before

receiving

DHS Referral response

X X X X

After Photo and

(EMPLOYMENT

AUTHORIZED)

X X X X

After Photo and DHS TNC X X X X X

After DHS Referral

response & resolution code

= O

(EMPLOYMENT

AUTHORIZED)

X X X X

After DHS Referral


= N

(DHS FINAL

NONCONFIRMATION)

X X X X X

After DHS Referral


= S

(DHS NO SHOW)

X X X X X




Current Case


MF

NC

– T

he

emp

loy

ee w

as

term

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

Fin

al

No

nco

nfi

rma

tio

n

resu

lt

NO

AC

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rece

ivin

g a

No

Sh

ow

resu

lt.

UN

CN

T –

Th

e em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

cho

osi

ng

no

t to

co

nte

st a

Ten

tati

ve

No

nco

nfi

rma

tio

n.

EQ

UIT

– T

he

emp

loy

ee v

olu

nta

rily

qu

it w

ork

ing

for

the

emp

loy

er.

TE

RM

– T

he

em

plo

yee

wa

s te

rm

ina

ted

by

th

e

emp

loy

er f

or

rea

son

s o

ther

th

an

E-V

erif

y.

DU

P –

Th

e ca

se i

s in

va

lid

beca

use

an

oth

er c

ase

wit

h t

he

sam

e d

ata

alr

ead

y e

xis

ts.

INC

DA

T –

Th

e ca

se i

s in

va

lid

bec

au

se t

he

da

ta

ente

red

is

inco

rrec

t

TE

CIS

S –

Th

is c

ase

is

bei

ng

clo

sed

bec

au

se o

f

tech

nic

al

issu

es w

ith

E-V

erif

y.

ISD

P–

Th

e ca

se i

s a

du

pli

cate

bec

au

se t

he

emp

loy

er c

rea

ted

a c

ase

wit

h t

he

sam

e d

ata

wit

hin

th

e p

ast

30

da

ys.

After DHS Referral


= X

(CLOSE AND

RESUBMIT CASE)

X

After DHS Referral


= P

(PASSPORT DATA

VERIFIED)

X X X X

After Initial Verification/

SSA Reverify/ SSA

Resubmittal/ DHS

Reverify and message

code = 42

(VERIFICATION IN

PROCESS)

X X X X


SSA Reverify/ SSA

Resubmittal/ DHS


code = 43

(UNABLE TO PROCESS)

X X X X X


SSA Reverify/ SSA

Resubmittal/ DHS


code = 41

(Duplicate Case)

X X

After Continue Without

Changes X X X





Table 85: LetterTypeCodes depicts the set of LetterTypeCodeLists that are returned by the

following methods and the letter/.PDF file that corresponds to the code:

EmpInitBPVerif

EmpInitDABPVerif


EmpGetCaseDetails

EmpSubSSAReferral

EmpSubmitDHSReferral

Table 85: LetterTypeCodes

LetterTypeCode Letter Description

SSA_FAN SSA_FAN - SSA TENTATIVE NONCONFIRMATION FAN LETTER

SSA_FA_FAN SSA_FA_FAN – SSA FRAUD ALERT LETTER

SSA_NATZ_FAN SSA_NATZ_FAN – SSA POTENTIALLY NATURALIZED CITIZEN FAN LETTER

DHS_FAN DHS_FAN – DHS TENTATIVE NONCONFIRMATION FAN LETTER

DHS_RDC DHS_RDC – SSA REFERRAL DATE CONFIRMATION LETTER

SSA_RDC SSA_RDC – SSA REFERRAL DATE CONFIRMATION LETTER


Table 86: OverDueVerifyReason Valid Values

OverDueVerifyReason Description

LATE_HIRE_DT_RSN_AWAIT_SSN Awaiting Social Security Number

LATE_HIRE_DT_RSN_TECH_PROB Technical Problems

LATE_HIRE_DT_RSN_AUDIT Audit Revealed that New Hire Was Not Run

LATE_HIRE_DT_RSN_FED_CONTR Federal Contractor with E-Verify Clause verifying an existing employee

LATE_HIRE_DT_RSN_OTHER Other





Table 87: List B Documents Valid Values

List B

Document

ID

Document Type Valid for

Citizenship

Type 4 – A

citizen of the

United

States

Valid for

Citizenship

Type 5 – A

noncitizen

national of

the United

States

Valid for

Citizenship

Type 6 - A

lawful

permanent

resident

Valid for

Citizenship

Type 7 - An

alien

authorized to

work

1 Driver's license or

ID card issued by

a U.S. state or

outlying

possession

Y Y Y Y

2 ID card issued by

a U.S. federal,

state or local

government

agency

Y Y Y Y

3 School ID card Y Y Y Y

4 Voter registration

card

Y Y Y Y

5 U.S. military card

or draft record

Y Y Y Y

6 Military

dependent's ID

card

Y Y Y Y

7 U.S. Coast Guard

Merchant Mariner

Card

Y Y Y Y

8 Native American

tribal document

Y Y Y Y

9 Driver's license

issued by a

Canadian

government

authority

Y Y Y Y

10 School record or

report card (under

age 18)

Y Y Y Y

11 Clinic, doctor or

hospital record

(under age 18)

Y Y Y Y

12 Day-care or

nursery school

record (under age

18)

Y Y Y Y




List B

Document

ID


Citizenship

Type 4 – A

citizen of the

United

States

Valid for

Citizenship

Type 5 – A

noncitizen

national of

the United

States

Valid for

Citizenship

Type 6 - A

lawful

permanent

resident

Valid for

Citizenship

Type 7 - An

alien

authorized to

work

21 Minor under age

18 without a List

B document

Y Y Y Y

22 Special Placement Y Y Y Y


Table 88: List C Documents Valid Values

List C

Docu-

ment

ID


Citizenship

Type 4 – A

citizen of the

United

States

Valid for

Citizenship

Type 5 – A

noncitizen

national of

the United

States

Valid for

Citizenship

Type 6 - A

lawful

permanent

resident

Valid for

Citizenship

Type 7 - An

alien

authorized to

work

13 Social Security Card Y Y Y Y

14 Certification of Birth

Abroad (Form FS-545)

Y Y N N

15 Certification of Report

of Birth (Form DS-1350)

Y Y N N

16 U.S. birth certificate

(original or certified

copy)

Y Y N N

17 Native American tribal

document

Y Y Y Y

18 U.S. Citizen ID Card

(Form I-197)

Y Y N N

19 ID Card for Use of

Resident Citizen in the

United States (Form I-

179)

Y Y N N

20 Employment

authorization document

issued by the U.S.

Department of

Homeland Security

Y Y Y Y





Table 89: Supporting Documents Valid Values

List B/C

Supporting

Document

ID

Document

Type

List B/C

Document

IDs

Supported

1 Driver's

license

1

3 ID card 1


Table 90: Issuing Authorities Valid Values

Issuing

Authority

Codes

Issuing Authority

Name

Supporting

Document

ID

Document Number Format**

AL Alabama

AK Alaska

AS American Samoa

AZ Arizona

AR Arkansas

CA California

CO Colorado

CT Connecticut

DE Delaware

DC District of Columbia

FL Florida 1 and 3 8-14 Alpha_Numeric.

GA Georgia

GU Guam

HI Hawaii

ID Idaho 1 and 3 8-14 Alpha_Numeric.

IL Illinois

IN Indiana

IA Iowa 1 and 3 8-14 Alpha_Numeric.

KS Kansas

KY Kentucky

LA Louisiana

ME Maine

MD Maryland

MA Massachusetts

MI Michigan

MN Minnesota




Issuing

Authority

Codes

Issuing Authority

Name

Supporting

Document

ID

Document Number Format**

MS Mississippi 1 and 3 8-14 Alpha_Numeric.

MO Missouri

MT Montana

NE Nebraska 1 and 3 8-14 Alpha_Numeric.

NV Nevada

NH New Hampshire

NJ New Jersey

NM New Mexico

NY New York

NC North Carolina

ND North Dakota

MP Northern Mariana

Islands

OH Ohio

OK Oklahoma

OR Oregon

PA Pennsylvania

PR Puerto Rico

RI Rhode Island

SC South Carolina

SD South Dakota

TN Tennessee

TX Texas

UT Utah

VT Vermont

VI Virgin Islands

VA Virginia

WA Washington

WV West Virginia

WI Wisconsin

WY Wyoming

* The Supporting Documents elements in this table are subject to change at any time. When an

Issuing Authority agrees to support a particular document this table is updated to reflect the

change.




** Employers are required to validate the field contents of this information in accordance with

the state identified before submitting the verification request to E-Verify. Table 91: COI Country

Codes depicts the set of Country Codes that should be used for Country of Issuance input

parameters.

These values are subject to change. To retrieve the latest list of COI Country Codes, call the

GetCountryOfIssuanceList method.

Table 91: COI Country Codes

Country

Code

Description

AUT AUSTRIA

AZE AZERBAIJAN

BHS BAHAMAS

BHR BAHRAIN

BGD BANGLADESH

BRB BARBADOS

BLR BELARUS

BEL BELGIUM

BLZ BELIZE

BEN BENIN

BMU BERMUDA

BTN BHUTAN

BOL BOLIVIA, PLURINATIONAL STATE OF

BIH BOSNIA AND HERZEGOVINA

BWA BOTSWANA

BVT BOUVET ISLAND

BRA BRAZIL

BRN BRUNEI DARUSSALAM

BGR BULGARIA

BFA BURKINA FASO

BDI BURUNDI

CYM CAYMAN ISLANDS

KHM CAMBODIA

CMR CAMEROON

CAN CANADA

CPV CAPE VERDE

CAF CENTRAL AFRICAN REPUBLIC

CHL CHILE

CHN CHINA

CXR CHRISTMAS ISLAND




Country

Code

Description

CYP CYPRUS

CCK COCOS (KEELING) ISLANDS

COL COLOMBIA

COM COMOROS

COG CONGO

COK COOK ISLANDS

KOR KOREA, REPUBLIC OF

PRK KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF

CRI COSTA RICA

CIV CÔTE D'IVOIRE

HRV CROATIA

CUB CUBA

DNK DENMARK

DJI DJIBOUTI

DOM DOMINICAN REPUBLIC

DMA DOMINICA

EGY EGYPT

SLV EL SALVADOR

ARE UNITED ARAB EMIRATES

ECU ECUADOR

ERI ERITREA

ESP SPAIN

EST ESTONIA

USA UNITED STATES

ETH ETHIOPIA

FLK FALKLAND ISLANDS (MALVINAS)

FRO FAROE ISLANDS

FJI FIJI

FIN FINLAND

FRA FRANCE

GAB GABON

GMB GAMBIA

GEO GEORGIA

SGS SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS

GHA GHANA

GIB GIBRALTAR

GRC GREECE




Country

Code

Description

GRD GRENADA

GRL GREENLAND

GLP GUADELOUPE

GUM GUAM

GTM GUATEMALA

GIN GUINEA

GNB GUINEA-BISSAU

GNQ EQUATORIAL GUINEA

GUY GUYANA

GUF FRENCH GUIANA

HTI HAITI

HMD HEARD ISLAND AND MCDONALD ISLANDS

HND HONDURAS

HKG HONG KONG

HUN HUNGARY

UMI UNITED STATES MINOR OUTLYING ISLANDS

VGB VIRGIN ISLANDS (BRITISH)

VIR VIRGIN ISLANDS (U.S.)

IND INDIA

IDN INDONESIA

IRN IRAN, ISLAMIC REPUBLIC OF

IRQ IRAQ

IRL IRELAND

ISL ICELAND

ISR ISRAEL

ITA ITALY

JAM JAMAICA

JPN JAPAN

JOR JORDAN

KAZ KAZAKHSTAN

KEN KENYA

KGZ KYRGYZSTAN

KIR KIRIBATI

KWT KUWAIT

LAO LAO PEOPLE'S DEMOCRATIC REPUBLIC

LSO LESOTHO

LVA LATVIA




Country

Code

Description

LBN LEBANON

LBR LIBERIA

LBY LIBYAN ARAB JAMAHIRIYA

LIE LIECHTENSTEIN

LTU LITHUANIA

LUX LUXEMBOURG

MAC MACAO

MKD MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF

MDG MADAGASCAR

MYS MALAYSIA

MWI MALAWI

MDV MALDIVES

MLI MALI

MLT MALTA

MNP NORTHERN MARIANA ISLANDS

MAR MOROCCO

MHL MARSHALL ISLANDS

MTQ MARTINIQUE

MUS MAURITIUS

MRT MAURITANIA

MYT MAYOTTE

MEX MEXICO

FSM MICRONESIA, FEDERATED STATES OF

MDA MOLDOVA, REPUBLIC OF

MCO MONACO

MNG MONGOLIA

MSR MONTSERRAT

MOZ MOZAMBIQUE

MMR MYANMAR

NAM NAMIBIA

NRU NAURU

NPL NEPAL

NIC NICARAGUA

NER NIGER

NGA NIGERIA

NIU NIUE

NFK NORFOLK ISLAND




Country

Code

Description

NOR NORWAY

NCL NEW CALEDONIA

NZL NEW ZEALAND

IOT BRITISH INDIAN OCEAN TERRITORY

OMN OMAN

UGA UGANDA

UZB UZBEKISTAN

PAK PAKISTAN

PLW PALAU

PAN PANAMA

PNG PAPUA NEW GUINEA

PRY PARAGUAY

NLD NETHERLANDS

PER PERU

PHL PHILIPPINES

PCN PITCAIRN

POL POLAND

PYF FRENCH POLYNESIA

PRI PUERTO RICO

PRT PORTUGAL

QAT QATAR

REU RÉUNION

ROU ROMANIA

GBR UNITED KINGDOM

RUS RUSSIAN FEDERATION

RWA RWANDA

ESH WESTERN SAHARA

SHN SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA

KNA SAINT KITTS AND NEVIS

LCA SAINT LUCIA

SMR SAN MARINO

SPM SAINT PIERRE AND MIQUELON

VAT HOLY SEE (VATICAN CITY STATE)

VCT SAINT VINCENT AND THE GRENADINES

SLB SOLOMON ISLANDS

WSM SAMOA

ASM AMERICAN SAMOA




Country

Code

Description

STP SAO TOME AND PRINCIPE

SEN SENEGAL

SYC SEYCHELLES

SLE SIERRA LEONE

SGP SINGAPORE

SVK SLOVAKIA

SVN SLOVENIA

SOM SOMALIA

SDN SUDAN

LKA SRI LANKA

ABC UNKNOWN

SWE SWEDEN

CHE SWITZERLAND

SUR SURINAME

SJM SVALBARD AND JAN MAYEN

SWZ SWAZILAND

SYR SYRIAN ARAB REPUBLIC

TJK TAJIKISTAN

TWN TAIWAN, PROVINCE OF CHINA

TZA TANZANIA, UNITED REPUBLIC OF

TCD CHAD

CZE CZECH REPUBLIC

ATF FRENCH SOUTHERN TERRITORIES

THA THAILAND

TLS TIMOR-LESTE

TGO TOGO

TKL TOKELAU

TON TONGA

TTO TRINIDAD AND TOBAGO

TUN TUNISIA

TKM TURKMENISTAN

TCA TURKS AND CAICOS ISLANDS

TUR TURKEY

TUV TUVALU

UKR UKRAINE

URY URUGUAY

VUT VANUATU




Country

Code

Description

VEN VENEZUELA, BOLIVARIAN REPUBLIC OF

VNM VIET NAM

WLF WALLIS AND FUTUNA

YEM YEMEN

COD CONGO, DEMOCRATIC REPUBLIC OF THE

ZMB ZAMBIA

ZWE ZIMBABWE

PSE PALESTINIAN TERRITORY, OCCUPIED

ALA ÅLAND ISLANDS

JEY JERSEY

IMN ISLE OF MAN

GGY GUERNSEY

MNE MONTENEGRO

SRB SERBIA

BLM SAINT BARTHÉLEMY

MAF SAINT MARTIN (FRENCH PART)

STL STATELESS

KVO KOSOVO

AFG AFGHANISTAN

ZAF SOUTH AFRICA

ALB ALBANIA

DZA ALGERIA

DEU GERMANY

AND ANDORRA

AGO ANGOLA

AIA ANGUILLA

ATA ANTARCTICA

ATG ANTIGUA AND BARBUDA

ANT NETHERLANDS ANTILLES

SAU SAUDI ARABIA

ARG ARGENTINA

ARM ARMENIA

ABW ARUBA

AUS AUSTRALIA




Table 92: ContinueDupCaseReason Valid Values

ContinueDupCaseReason Description

REHIRE The employee is a rehire and I am required to create a new

case.

INCORRECT_DATA The previous case is invalid because of incorrect data.

OTHER Reason other than those listed above





Appendix E—WEB SERVICES CALL/RESPONSE SUMMARY TABLE

Web Service Call/Response Descriptions

EmpInitBPVerif Performs initial verification for BP type users.

EmpInitVerfResp25 Reports the status of the initial verification call.

EmpInitDABPVerif Performs initial verification for DABP type users.

EmpInitVerfResp25 Reports the status of the initial call.

EmpSSAReVerify Reverify SSA required data.

EmpInitVerfResp25 Reports the status of the reverify.

EmpDHSReVerify Reverify “Lawful Permanent Resident” and “Alien

Authorized to Work” type employees


EmpCitDHSReVerify Reverify “U.S. Citizen” with passport document.


EmpRetrievePhoto Retrieve passport photo after receiving a “P” from SVS.

EmpRetrievePhotoResp Returns passport photo and case data.

EmpConfirmPhoto Confirm or reject an initial verification photo.

EmpConfirmPhotoResp25 Reports the status of the photo confirmation.

EmpSubmitAdditVerif Submits additional data to DHS.

EmpSubmitAdditVerifResp Reports the status of additional data submitted to DHS.

EmpGetNextResolvedCaseNbrs Retrieves case numbers and response codes.

EmpGetNextResolvedCaseNbrsResp25 Returns case number(s) of SSA or DHS resolved case(s).

Case25 Lists the status of cases with pending resolutions.

EmpGetCaseDetails Retrieves all current information for existing cases.

EmpGtCseDetailsResp24 Reports the current information on existing cases.

EmpAckReceiptOfResolvedCaseNbr Notifies E-Verify of successful client case resolution.

EmpAckReceiptOfResolvedCaseNbrResp Reports the status of notifying E-Verify of successful client

case resolution.

EmpSubSSAReferral Notifies E-Verify that an employee was referred to SSA.

EmpSubmitSSAReferralResp25 Reports the status of notifying E-Verify of successful client

case resolution.

EmpSSAResubmittal Resubmits an employment verification request to SSA.

EmpSSAResubmittalResp9 Reports the status of the resubmitted employment verification

request to SSA.SSA Resubmittal.

EmpSubDHSReferral Notifies DHS that an employee will contest the TNC.

EmpSubmitDHSReferralResp28 Reports the status of notifying DHS that an employee will

contest the TNC. TNC Contest.

EmpCloseCase Used to close a case.

EmpCloseCaseResp Reports the status of the close the case request.




Web Service Call/Response Descriptions

EmpGetClosureCodes Retrieves valid closure codes for a particular case.

EmpClosureCodesResp Reports the status of the EmpGetClosureCodes.

ClosureCodeList List of closure codes that can be used for a case.

EmpGetAlertCases Retrieves a list of a particular alert case type.

EmpAlertCasesResp Reports the status of the get alert cases method.

EmpGetCaseAlertCounts Retrieves counts for three types of alert cases.

EmpCaseAlertsResp Counts of alert cases.

EmpGetCitizenshipStatusCodes Returns all citizenship codes.

EmpGetCitizenshipCodesResp Reports all citizenship codes.

CitizenshipCodeList Lists the citizenship codes, descriptions, and names.

EmpGetAvailableDocumentTypes Returns all document types for a citizenship code.

EmpGetAvailableDocumentTypesResp Returns all document types for a citizenship code.

DocTypeList Lists all document information.

EmpGetAllDataFields Returns All Data Fields.

EmpGetAllDataFieldsResp Response to Return All Data Fields.

FieldList Reports all Citizenship Codes, Descriptions, and Names.

EmpGetCountryOfIssuanceList Retrieves a list of country codes for COI field.

CountryOfIssuanceResp Contains a list of country codes.

EmpCpsVerifyConnection Tests the Communications Path.

EmpCpsVerifyConnectionResp Response to Test the Communications Path.

EmpRetrieveFAN Retrieves a pre-filled SSA or DHS Further Action Notice

(FAN) or Referral Date Confirmation (RDC) PDF letter.

EmpRetrieveFANResp25 Response to return the appropriate FAN or RDC PDF letter.

EmpGetDuplicateCaseList Retrieves a list of duplicate cases associated with a case

number and an SSN.

EmpGetDuplicateCaseListResp Contains a list of of duplicate cases associated with a case

number and an SSN.

EmpDupCaseContinueWithChanges Performs a duplicate case check using the updated values. If

the duplicate case check is passed, then the case continues

with the normal verification process.

EmpDupCaseContinueWithoutChanges Provides employers the opportunity to acknowledge that a

case is a duplicate, and supply a reason for continuing.

EmpGetDupCaseContinueReasons Provides a list of valid reasons for continuing a duplicate case.

No input parameters are required.

EmpSaveSSATNCNotification Notifies CPS that the employee has received a notification of

the SSA TNC.

EmpSaveTNCNotificationResp Reports the status of a call to EmpSaveSSATNCNotification.

EmpSaveDHSTNCNotification Notifies CPS that the employee has received a notification of

the DHS TNC.

EmpSaveTNCNotificationResp Reports the status of a call to EmpSaveDHSTNCNotification.




Appendix F—E-Verify URLs

Access to the E-Verify Web Service production system URL will be provided after an employer

and/or E-Verify employer agent successfully completes integration testing with CSC in the E-

Verify test system.

The E-Verify Web Service test system can be accessed through the following URL:

https://stage.e-verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc

The WSDL file for the test system may be accessed using the following URL:


For non .NET (Java, etc)

The E-Verify Web Service test system can be accessed through the following URL: https://e-

verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc

The WSDL file for the test system may be accessed using the following URL:

WSDL (has both SOAP 1.1 and 1.2) - https://e-

verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc?wsdl

URL to which send requests from code (SOAP 1.1, cannot be opened from browser): https://e-

verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc/basic

The E-Verify Web Service administration test system can be accessed through the following

URL: https://stage.e-verify.uscis.gov/WcfWebService/Administration.svc

The WSDL file for the E-Verify Web Service administration test system may be accessed using

the following URL:


https://e-verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc/basic

https://e-verify.uscis.gov/WcfWebService/EmployerWebServiceV28.svc/basic

Appendix G—E-Verify WCF Bindings Incoming Messages Sample

WCF BasicHttpBinding (SOAP 1.1) and WsHttpBinding (uses SOAP 1.2) include a security

mode of "TransportWithMessageCredential", which means that a UserId and password is

expected with each request. The following is an example of an incoming message:

<MessageHeaders>

<a:Action s:mustUnderstand="1" xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">http://schemas.xmlsoap.org/ws/2005/02/trust/RST/SCT</a:Action> <a:MessageID xmlns:a="http://www.w3.org/2005/08/addressing">urn:uuid:4d0f6b38-e669-4c48-a6ea-9af6fecd67b7</a:MessageID> <ActivityId CorrelationId="4c0d7b78-021b-4f26-b753-693b9882b5e8" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">2b5ea86a-2835-4d76-b4b7-b9d810fd1ca9</ActivityId> <a:ReplyTo xmlns:a="http://www.w3.org/2005/08/addressing">

<a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address> </a:ReplyTo> <a:To s:mustUnderstand="1" xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">https://localhost/WcfWebService/AgencyWebServiceV34.svc</a:To> <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:s="http://www.w3.org/2003/05/soap-envelope">

<u:Timestamp u:Id="_0" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

<u:Created>2014-04-02T13:51:08.142Z</u:Created> <u:Expires>2014-04-02T13:56:08.142Z</u:Expires>

</u:Timestamp> <o:UsernameToken u:Id="uuid-52f1d126-c5e7-4431-83a6-48a2120ebd75-1" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

<o:Username> 

</o:Username> <o:Password>

 </o:Password>

</o:UsernameToken> </o:Security>

</MessageHeaders>

http://www.w3.org/2003/05/soap-envelope

http://www.w3.org/2005/08/addressing

http://schemas.xmlsoap.org/ws/2005/02/trust/RST/SCT

http://schemas.xmlsoap.org/ws/2005/02/trust/RST/SCT


http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics


http://www.w3.org/2005/08/addressing/anonymous



https://localhost/WcfWebService/AgencyWebServiceV34.svc

https://localhost/WcfWebService/AgencyWebServiceV34.svc

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd



http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd




Appendix H—System Availability Time

Although the production E-Verify system is generally available 24x7, there are several situations

where it will be unavailable due to scheduled activities. Some of these activities are more

frequent and usually follow a regular schedule, while others are less frequent and do not always

follow a regular schedule.

Regularly scheduled activities include:

Daily SSA maintenance (1:00 AM ET - 5:00 AM ET)

Weekly system maintenance (Sundays 6:00 PM ET - midnight ET)

Monthly system maintenance (5:00 AM ET - 3:00 PM ET on the 1st Sunday of the

month, except when in conflict with November/December holiday periods which are

rescheduled for an earlier Sunday in the month on a case-by-case basis)

Activities that occur less frequently and do not always follow a regular schedule include:

E-Verify software updates (approximately 3-5 per year, typically during an extended

outage window on a weekend when no other maintenance activities are planned)

External partner maintenance (frequency and outage window length varies by data

partner and activities planned)

When any of the above events occur, users may experience a variety of sporadic or persistent

issues including slow response times, processing errors, and application interface unavailability.




Appendix I—Date/Time Requirements

CPS returned date/time formats are compliant with the W3 requirements identified in the

specifications http://www.w3.org/TR/NOTE-datetime.

All CPS date/times are expressed in local time, with a time zone offset in hours and minutes. A

time zone offset of "+hh:mm" indicates that the date/time uses a local time zone which is "hh"

hours and "mm" minutes ahead of Coordinated Universal Time (UTC). A time zone offset of "-

hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm"

minutes behind UTC.

Many E-Verify Web Service methods accept dates as input parameters or return dates as output.

In SOAP messages, these dates are formatted as standard XML simple type “DateTime” (0001-

01-01T00:00:00.0000000-05:00). CPS uses the date with the value of “1/1/0001” to represent

NIL (no value). The Web service client should pass this value in for a DateTime parameter

when no actual date can be provided. Also, the E-Verify Web Service methods will return this

value when no actual date can be returned.

The Web service client should always pass a four-digit year into the CPS Web server. However,

if a two-digit year is passed into the Web server, then the server-side XML DateTime object will

convert the two-digit year into a four-digit year using a Y2K pivot rule algorithm. Any two-digit

year greater than 50 is interpreted as being in the 20th

century. Any two-digit year less than or

equal to 50 is interpreted as being in the 21st century. For example, if the year “04” was entered,

then it would be interpreted as 2004. To ensure that there is no misinterpretation of dates, the

Web service client should ALWAYS pass a four-digit year into the CPS Web server.

The E-Verify Web service access method requires that the client Web server have its system

clock in-synch with the CPS Web server within a 15-minute tolerance. This requirement is

imposed to ensure greater security by detecting and minimizing the possibility of a play-back

attempt. The CPS Web server has replay detection turned on. When replay detection is used, the

SOAP headers passed between the client Web server and the CPS Web server contain time

stamps. By verifying the time stamps in the SOAP headers are within the 15-minute tolerance,

the CPS Web server can prevent replay attacks.

The CPS Web server has been configured to be synchronized with the publicly operated and

available National of Institute of Standards and Technology (NIST) time servers. CPS is using

the following servers as its official time source:

PRIMARY: nist1-dc.glassey.com (216.200.93.8)

SECONDARY: nist1-ny.glassey.com (208.184.49.9)

It is recommended that all client Web servers also be configured to use these servers as their

official time source. This will ensure that the time on the client Web server is synchronized with

the CPS Web server.

For many computer systems, time is set by identifying the local time and time zone. The

operating system is able to compute the GMT time from this information. Therefore, it is

important to ensure the time and time zone are set correctly on the client Web server in order

for it to compute and pass the correct date/time in the SOAP headers.