/credit/employment/get returns a list of items with employment information from a user's payroll provider that was verified by an end user.
643 matches
46 actions
Plaid
46 actions
- Create a deposit switchPOSTv1.0.0
- Create a deposit switch without using Plaid ExchangePOSTv1.0.0
- Create a new identity verificationPOSTv1.0.0
- Create an Asset ReportPOSTv1.0.0
- Create Asset Report Audit CopyPOSTv1.0.0
- Create Link Delivery sessionPOSTv1.0.0
- Create payment consentPOSTv1.0.0
- Create payment profilePOSTv1.0.0
- Create payment recipientPOSTv1.0.0
- Creates a new end customer for a Plaid reseller.POSTv1.0.0
- Get balance of your Bank Transfer accountPOSTv1.0.0
- Get CategoriesPOSTv1.0.0
- Get details of all supported institutionsPOSTv1.0.0
- Get details of an institutionPOSTv1.0.0
- Get Link Delivery sessionPOSTv1.0.0
- Get payment consentPOSTv1.0.0
- Get payment detailsPOSTv1.0.0
- Get payment profilePOSTv1.0.0
- Get payment recipientPOSTv1.0.0
- List a historical log of user consent eventsPOSTv1.0.0
- List a user’s connected applicationsPOSTv1.0.0
- List dashboard usersPOSTv1.0.0
- List Identity VerificationsPOSTv1.0.0
- List payment recipientsPOSTv1.0.0
- List sweepsPOSTv1.0.0
- Retrieve a dashboard userPOSTv1.0.0
- Retrieve a PDF Asset ReportPOSTv1.0.0
- Retrieve a summary of an individual's employment informationPOSTv1.0.0
- Retrieve a sweepPOSTv1.0.0
- Retrieve a user's payroll informationPOSTv1.0.0
- Retrieve an Asset ReportPOSTv1.0.0
- Retrieve an Asset Report Audit CopyPOSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an ItemPOSTv1.0.0
- Retrieve identity dataPOSTv1.0.0
- Retrieve identity match scorePOSTv1.0.0
- Retrieve Identity VerificationPOSTv1.0.0
- Retrieve information about a Plaid applicationPOSTv1.0.0
- Retrieve information from the bank accounts used for employment verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verification in PDF formatPOSTv1.0.0
- Retrieve Link sessions for your userPOSTv1.0.0
- Search employer databasePOSTv1.0.0
- Search institutionsPOSTv1.0.0
- Update the scopes of access for a particular applicationPOSTv1.0.0
Finance/Plaid
Retrieve a summary of an individual's employment information
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
{
"type": "object",
"description": "CreditEmploymentGetRequest defines the request schema for `/credit/employment/get`.",
"required": [
"user_token"
],
"properties": {
"client_id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user token associated with the User data is being requested for."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
{
"type": "object",
"description": "CreditEmploymentGetResponse defines the response schema for `/credit/employment/get`.",
"required": [
"items",
"request_id"
],
"properties": {
"items": {
"type": "array",
"description": "Array of employment items.",
"items": {
"type": "object",
"description": "The object containing employment items.",
"required": [
"item_id",
"employments"
],
"properties": {
"employment_report_token": {
"type": "string",
"description": "Token to represent the underlying Employment data"
},
"employments": {
"type": "array",
"items": {
"type": "object",
"description": "The object containing proof of employment data for an individual.",
"required": [
"account_id",
"status",
"start_date",
"end_date",
"employer",
"title",
"platform_ids",
"employee_type",
"last_paystub_date"
],
"properties": {
"account_id": {
"type": "string",
"description": "ID of the payroll provider account."
},
"employee_type": {
"type": "string",
"description": "The type of employment for the individual.\n`\"FULL_TIME\"`: A full-time employee.\n`\"PART_TIME\"`: A part-time employee.\n`\"CONTRACTOR\"`: An employee typically hired externally through a contracting group.\n`\"TEMPORARY\"`: A temporary employee.\n`\"OTHER\"`: The employee type is not one of the above defined types."
},
"employer": {
"type": "object",
"description": "An object containing employer data.",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of employer."
}
}
},
"end_date": {
"type": "string",
"format": "date",
"description": "End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD)."
},
"last_paystub_date": {
"type": "string",
"format": "date",
"description": "The date of the employee's most recent paystub in ISO 8601 format (YYYY-MM-DD)."
},
"platform_ids": {
"type": "object",
"description": "The object containing a set of ids related to an employee.",
"required": [
"employee_id",
"payroll_id",
"position_id"
],
"properties": {
"employee_id": {
"type": "string",
"description": "The ID of an employee as given by their employer."
},
"payroll_id": {
"type": "string",
"description": "The ID of an employee as given by their payroll."
},
"position_id": {
"type": "string",
"description": "The ID of the position of the employee."
}
}
},
"start_date": {
"type": "string",
"format": "date",
"description": "Start of employment in ISO 8601 format (YYYY-MM-DD)."
},
"status": {
"type": "string",
"description": "Current employment status."
},
"title": {
"type": "string",
"description": "Current title of employee."
}
}
}
},
"item_id": {
"type": "string",
"description": "The `item_id` of the Item associated with this webhook, warning, or error"
}
}
}
},
"request_id": {
"type": "string",
"description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
}
}
}