employersSearch
/employers/search allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.
The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
EmployersSearchRequest defines the request schema for /employers/search.
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.
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.
The employer name to be searched for.
The Plaid products the returned employers should support. Currently, this field must be set to "deposit_switch".
Response Body
application/json
curl -X POST "https://example.com/employers/search" \ -H "Content-Type: application/json" \ -d '{ "query": "string", "products": [ "string" ] }'{ "employers": [ { "name": "Plaid Inc.", "address": { "city": "San Francisco", "country": "US", "postal_code": "94103", "region": "CA", "street": "1098 Harrison St" }, "confidence_score": 1, "employer_id": "emp_1" } ], "request_id": "ixTBLZGvhD4NnmB"}bankTransferBalanceGet POST
Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
incomeVerificationTaxformsGet POST
`/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.