version-identity-company-employeeId-biographical-details-get

GET

Personal Identification

Retrieve employee identification and personal status information.

 

{
  "employeeId":"string",
  "uniqueId":"string",
  "effectiveDate":"datetime",
  "gender":"M#F",
  "marriageStatus":"string",
  "birthDate":"datetime",
  "country":"string",
  "militaryStatus":"string",
  "ethnicity":"string",
  "names":[
    {
      "effectiveDate":"datetime",
      "formOfAddress":"string",
      "lastName":"string",
      "firstName":"string",
      "middleName":"string",
      "nameFormat":"string",
      "suffix":"string",
      "nameType":"primary#preferred",
      "personTitle":"string",
      "reasonChangeCode":"string",
      "uniqueId":"string"
    }
  ]
}
Field Description

employeeId

TriNet employee ID

uniqueId

TriNet only – please ignore

effectiveDate

Date the information became effective

Gender

Male or female

marriageStatus

Marital status

birthdate

Birthdate

Country

Country

militaryStatus

Military status

Ethnicity

Ethnicity for EEOC reporting

Names

 

effectiveDate

Date the information became effective

formOfAddress

Title or form of address

lastName

Last name

firstName

First name

middleName

Middle name

nameFormat

Not currently used

suffix

Name suffix

nameType

Name type

Values: primary, preferred

personTitle

Not currently used

reasonChangeCode

Not currently used

uniqueId

TriNet only – please ignore

Resource URL

https://api.trinet.com /{version}/identity/{company}/{employeeId}/biographical-details

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...