Skip to main content
Version: 1.7.3

Get Individual Details

Get Individual Details

Use this endpoint to retrieve detailed profile information (name, DOB, address) for one or more employees in a single batch call.

Key Points

  • Batch request — Request multiple individuals in one call by adding multiple objects to the requests array.
  • Depends onindividual_id values from GET /organization/directory.
POST organization/individual 

Header Parameters

FieldTypeDescription
AuthorizationstringRequired. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-VersionstringAPI version string. Use 1.0.0.

Query Parameters

FieldTypeDescription
entity_idsstringThe organization ID. Must be exactly one UUID.

Request Body

FieldTypeDescription
requestsobject[]Array of individuals to look up.
   individual_idstringThe employee UUID from the directory.

Response Body

FieldTypeDescription
statusstringSUCCESS or FAILURE.
status_codenumberHTTP-style status code (e.g. 200, 400).
messagestringHuman-readable status message.
responseobject[]One entry per requested individual.
   individual_idstringThe employee UUID (mirrors the value in body.id).
   bodyobjectProfile details.
     idstringEmployee UUID.
     first_namestringEmployee first name.
     middle_namestringEmployee middle name. null if not set.
     last_namestringEmployee last name.
     preferred_namestringPreferred first name. null if not set.
     dobstringDate of birth (YYYY-MM-DD).
     emailsobject[]Email addresses on file. Empty array if none.
       datastringEmail address.
       typestringEmail type (e.g. work).
     phone_numbersobject[]Phone numbers on file. Empty array if none.
       datastringPhone number.
       typestringPhone type (e.g. personal).
     residenceobjectEmployee home address.
       line1stringAddress line 1.
       line2stringAddress line 2. null if not set.
       citystringCity.
       statestringState code (e.g. TX).
       postal_codestringZIP code.
       countrystringAlways US.
     is_activebooleantrue if the employee is active; false if terminated.

Request Json

SampleDescriptionAction
Sample 1
Look up two individuals in a single batch call.
Sample 1
{
"requests": [
{
"individual_id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346"
},
{
"individual_id": "9b2e4d7f-22cc-5f7b-0d1e-994b68f23457"
}
]
}

Response Json

SampleDescriptionAction
200
Success Response - This is a sample response for successful API requests.
400
Bad Request Response - You'll get the below response when the request body fails validation.
{
"status": "SUCCESS",
"status_code": 200,
"message": "Request processed successfully",
"response": [
{
"individual_id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
"body": {
"id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
"first_name": "John",
"middle_name": null,
"last_name": "Doe",
"preferred_name": null,
"dob": "1985-04-15",
"emails": [
{
"data": "john.doe@example.com",
"type": "work"
}
],
"phone_numbers": [
{
"data": "512-555-0100",
"type": "personal"
}
],
"residence": {
"line1": "123 Main St",
"line2": null,
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "US"
},
"is_active": true
}
}
]
}