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
requestsarray. - Depends on —
individual_idvalues from GET /organization/directory.
POST organization/individual Header Parameters
| Field | Type | Description |
|---|---|---|
| Authorization | string | Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>. |
| X-TaxBandits-Version | string | API version string. Use 1.0.0. |
Query Parameters
| Field | Type | Description |
|---|---|---|
| entity_ids | string | The organization ID. Must be exactly one UUID. |
Request Body
| Field | Type | Description |
|---|---|---|
| requests | object[] | Array of individuals to look up. |
| individual_id | string | The employee UUID from the directory. |
Response Body
| Field | Type | Description |
|---|---|---|
| status | string | SUCCESS or FAILURE. |
| status_code | number | HTTP-style status code (e.g. 200, 400). |
| message | string | Human-readable status message. |
| response | object[] | One entry per requested individual. |
| individual_id | string | The employee UUID (mirrors the value in body.id). |
| body | object | Profile details. |
| id | string | Employee UUID. |
| first_name | string | Employee first name. |
| middle_name | string | Employee middle name. null if not set. |
| last_name | string | Employee last name. |
| preferred_name | string | Preferred first name. null if not set. |
| dob | string | Date of birth (YYYY-MM-DD). |
| emails | object[] | Email addresses on file. Empty array if none. |
| data | string | Email address. |
| type | string | Email type (e.g. work). |
| phone_numbers | object[] | Phone numbers on file. Empty array if none. |
| data | string | Phone number. |
| type | string | Phone type (e.g. personal). |
| residence | object | Employee home address. |
| line1 | string | Address line 1. |
| line2 | string | Address line 2. null if not set. |
| city | string | City. |
| state | string | State code (e.g. TX). |
| postal_code | string | ZIP code. |
| country | string | Always US. |
| is_active | boolean | true if the employee is active; false if terminated. |
Payload
Request Json
| Sample | Description | Action |
|---|---|---|
| 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
| Sample | Description | Action |
|---|---|---|
| 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
}
}
]
}