/credit/bank_employment/get returns the employment report(s) derived from bank transaction data for a specified 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 information from the bank accounts used for employment verification
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": "CreditBankEmploymentGetRequest defines the request schema for `/beta/credit/v1/bank_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
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
{
"type": "object",
"description": "CreditBankEmploymentGetResponse defines the response schema for `/beta/credit/v1/bank_employment/get`.",
"required": [
"bank_employment_reports",
"request_id"
],
"properties": {
"bank_employment_reports": {
"type": "array",
"description": "Bank Employment data. Each entry in the array will be a distinct bank employment report.",
"items": {
"type": "object",
"description": "The report of the Bank Employment data for an end user.",
"required": [
"bank_employment_report_id",
"generated_time",
"days_requested",
"items",
"warnings"
],
"properties": {
"bank_employment_report_id": {
"type": "string",
"description": "The unique identifier associated with the Bank Employment Report."
},
"days_requested": {
"type": "integer",
"description": "The number of days requested by the customer for the Bank Employment Report."
},
"generated_time": {
"type": "string",
"format": "date-time",
"description": "The time when the Bank Employment Report was generated, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. \"2018-04-12T03:32:11Z\")."
},
"items": {
"type": "array",
"description": "The list of Items in the report along with the associated metadata about the Item.",
"items": {
"type": "object",
"description": "The details and metadata for an end user's Item.",
"required": [
"item_id",
"last_updated_time",
"institution_id",
"institution_name",
"bank_employments",
"bank_employment_accounts"
],
"properties": {
"bank_employment_accounts": {
"type": "array",
"description": "The Item's accounts that have Bank Employment data.",
"items": {
"type": "object",
"description": "The Item's bank accounts that have the selected data.",
"required": [
"account_id",
"mask",
"name",
"official_name",
"subtype",
"type",
"owners"
],
"properties": {
"account_id": {
"type": "string",
"description": "Plaid's unique identifier for the account."
},
"mask": {
"type": "string",
"description": "The last 2-4 alphanumeric characters of an account's official account number.\nNote that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user."
},
"name": {
"type": "string",
"description": "The name of the bank account."
},
"official_name": {
"type": "string",
"description": "The official name of the bank account."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"subtype": {
"type": "string",
"description": "Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/#StandaloneAccountType-depository).",
"enum": [
"checking",
"savings",
"hsa",
"cd",
"money market",
"paypal",
"prepaid",
"cash management",
"ebt",
"all"
]
},
"type": {
"type": "string",
"description": "The account type. This will always be `depository`.",
"enum": [
"depository"
]
}
}
}
},
"bank_employments": {
"type": "array",
"description": "The bank employment information for this Item. Each entry in the array is a different employer found.",
"items": {
"type": "object",
"description": "Detailed information for the bank employment.",
"required": [
"bank_employment_id",
"account_id",
"employer",
"latest_deposit_date",
"earliest_deposit_date"
],
"properties": {
"account_id": {
"type": "string",
"description": "Plaid's unique identifier for the account."
},
"bank_employment_id": {
"type": "string",
"description": "A unique identifier for the bank employment."
},
"earliest_deposit_date": {
"type": "string",
"format": "date",
"description": "The date of the earliest deposit from this employer from within the period of the days requested."
},
"employer": {
"type": "object",
"description": "Object containing employer data.",
"required": [
"name"
],
"properties": {
"name": {
"type": "object",
"additionalProperties": true
}
}
},
"latest_deposit_date": {
"type": "string",
"format": "date",
"description": "The date of the most recent deposit from this employer."
}
}
}
},
"institution_id": {
"type": "string",
"description": "The unique identifier of the institution associated with the Item."
},
"institution_name": {
"type": "string",
"description": "The name of the institution associated with the Item."
},
"item_id": {
"type": "string",
"description": "The unique identifier for the Item."
},
"last_updated_time": {
"type": "string",
"format": "date-time",
"description": "The time when this Item's data was last retrieved from the financial institution, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. \"2018-04-12T03:32:11Z\")."
}
}
}
},
"warnings": {
"type": "array",
"description": "If data from the Bank Employment report was unable to be retrieved, the warnings will contain information about the error that caused the data to be incomplete.",
"items": {
"type": "object",
"description": "The warning associated with the data that was unavailable for the Bank Employment Report.",
"required": [
"warning_type",
"warning_code",
"cause"
],
"properties": {
"cause": {
"type": "object",
"description": "An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.",
"required": [
"error_type",
"error_code",
"error_message",
"display_message",
"item_id"
],
"properties": {
"display_message": {
"type": "string",
"description": "A user-friendly representation of the error code. null if the error is not related to user action.\nThis may change over time and is not safe for programmatic use."
},
"error_code": {
"type": "string",
"description": "We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred."
},
"error_message": {
"type": "string",
"description": "A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use."
},
"error_type": {
"type": "string",
"description": "A broad categorization of the error. Safe for programmatic use.",
"enum": [
"INTERNAL_SERVER_ERROR",
"INSUFFICIENT_CREDENTIALS",
"ITEM_LOCKED",
"USER_SETUP_REQUIRED",
"COUNTRY_NOT_SUPPORTED",
"INSTITUTION_DOWN",
"INSTITUTION_NO_LONGER_SUPPORTED",
"INSTITUTION_NOT_RESPONDING",
"INVALID_CREDENTIALS",
"INVALID_MFA",
"INVALID_SEND_METHOD",
"ITEM_LOGIN_REQUIRED",
"MFA_NOT_SUPPORTED",
"NO_ACCOUNTS",
"ITEM_NOT_SUPPORTED",
"ACCESS_NOT_GRANTED"
]
},
"item_id": {
"type": "string",
"description": "The `item_id` of the Item associated with this warning."
}
}
},
"warning_code": {
"type": "string",
"description": "The warning code identifies a specific kind of warning.\n`IDENTITY_UNAVAILABLE`: Unable to extract identity for the Item\n`TRANSACTIONS_UNAVAILABLE`: Unable to extract transactions for the Item\n`ITEM_UNAPPROVED`: User did not grant permission to share data for the Item\n`REPORT_DELETED`: Report deleted due to customer or consumer request\n`DATA_UNAVAILABLE`: No relevant data was found for the Item",
"enum": [
"IDENTITY_UNAVAILABLE",
"TRANSACTIONS_UNAVAILABLE",
"ITEM_UNAPPROVED",
"REPORT_DELETED",
"DATA_UNAVAILABLE"
]
},
"warning_type": {
"type": "string",
"description": "The warning type which will always be `BANK_EMPLOYMENT_WARNING`.",
"enum": [
"BANK_EMPLOYMENT_WARNING"
]
}
}
}
}
}
}
},
"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."
}
}
}