Retrieve a summary of an individual's employment information

POST /credit/employment/get

/credit/employment/get returns a list of items with employment information from a user's payroll provider that was verified by an end user.

Request Body

Required

CreditEmploymentGetRequest defines the request schema for /credit/employment/get.

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
user_token
required, string
The user token associated with the User data is being requested for.

Response

CreditEmploymentGetResponse defines the response schema for /credit/employment/get.

Response Properties

items
required, array[object]
Array of employment items.
item_id
required, string
The item_id of the Item associated with this webhook, warning, or error
employments
required, array[object]
account_id
required, string
ID of the payroll provider account.
status
required, string
Current employment status.
start_date
required, string
Start of employment in ISO 8601 format (YYYY-MM-DD).
end_date
required, string
End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD).
employer
required, object
An object containing employer data.
name
required, string
Name of employer.
title
required, string
Current title of employee.
platform_ids
required, object
The object containing a set of ids related to an employee.
employee_id
required, string
The ID of an employee as given by their employer.
payroll_id
required, string
The ID of an employee as given by their payroll.
position_id
required, string
The ID of the position of the employee.
employee_type
required, string
The type of employment for the individual. "FULL_TIME": A full-time employee. "PART_TIME": A part-time employee. "CONTRACTOR": An employee typically hired externally through a contracting group. "TEMPORARY": A temporary employee. "OTHER": The employee type is not one of the above defined types.
last_paystub_date
required, string
The date of the employee’s most recent paystub in ISO 8601 format (YYYY-MM-DD).
employment_report_token
string
Token to represent the underlying Employment data
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.