version-profile-company-employeeId-citizenship-get

GET

Citizenship

Retrieve employee citizenship information.

 

{
  "employeeId":"string",
  "alternateId":"string",
  "workEligibility":{
    "citizenshipStatus":"string",
    "USWorkEligibility":"string",
    "effectiveDate":"datetime",
    "visa":{
      "visaId":"string",
      "visaType":"string",
      "visaExpirationDate":"datetime"
    }
  }
}

 

Field Description

employeeId

TriNet employee ID

alternateId

Alternate employee ID, if your company uses its own employee IDs

workEligibility

 

citizenshipStatus

Citizenship status such as Naturalized or Permanent Resident

USWorkEligibility

Whether or not the employee is eligible to work in the U.S.  

effectiveDate

Date the information became effective

visa

 

visaId

Visa Id

visaType

Type of the visa

visaExpirationDate

Expiration date of the visa

Resource URL

https://api.trinet.com /{version}/profile/{company}/{employeeId}/citizenship

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

  • 401

  • 403

  • 404

Resource Summary

Security:

Scope:

hr-personal-read

Working...