The Plaid API allows you to build robust fintech applications that can securely connect with user's banks, credit cards, and other financial data.
\nWith our API, you can perform a variety of financial transactions like fund transfers, get real-time account balance, transaction history, and many more.
\nThe Plaid API uses JSON over HTTP requests. All requests are POST requests, and responses come in as standard JSON with a small subset that returns binary data where necessary.
\nAll requests must include a Content-Type : json/application header and must include a valid JSON body. Errors in the response body are identified by error_code and categorized by error-type.
Every Plaid response includes a request-id in the body or in the response header in cases where an endpoint returns binary data.
For faster support, when you contact the support team about a specific API call, you can include the request-id.
The Plaid API is served over HTTPS TLS v1.2 to ensure data privacy. Any HTTP or HTTPS with TLS versions below 1.2 are not supported. Clients must use an up-to-date root certificate bundle as the only TLS verification path; certificate pinning should never be used.
\nAll endpoints in the documenation use the following base URL.
\nhttps://sandbox.plaid.com\n\nPlaid API has two environments: Sandbox and Production.
\nYou need to get your Sandbox API Keys before you can use the Sandbox Production environment.
\nFollow these steps to get your Sandbox API Keys:
\nStep 1: Navigate to your dashboard.
\nStep 2: Look for 'Sandbox' in the Home section.
\nStep 3: Click 'Sandbox' and get your credentials.
\nFor more information on Sandbox, check this page.
\n2. Production: The production environment is used for production code . It uses real data and should only be used when you are ready to go live.
\nYou need to get your Production API access before you can use the Production environment.
\nFollow these steps to get your Production API access:
\nStep 1: Navigate to your dashboard.
\nStep 2: Provide the neccessary information to make a Production API request
\nStep 3: Once your request has been reviewed, your Production API access will be provided.
\n\n\nNote: Items cannot be moved between both environments.
\n
API status provides information about the status of the Plaid system, while Incident provides historical incidents in the Plaid system, such as the downtime period, partial outage, and major outage.
\nYou can get the available API status at status.plaid.com.
\nAPI status and incident are also available programmatically via these endpoints.
\nhttps://status.plaid.com/api/v2/status.json : This is used to get the current status of the Plaid API system.
\nhttps://status.plaid.com/api/v2/incidents.json : This is used to get the current and historical incidents in the Plaid API system.
\nTo get a complete list of API status information available programmatically and more information on how to use these endpoints, see the Atlassian Status API documentation.
\nFor information about the status of an institution supported by Plaid, see Troubleshooting institution status.
\nAny token the API returns is sensitive and must be stored securely. All Plaid tokens except public-token`and link-token are long-lasting and must never be exposed on the client side.
Consumer data obtained from the Plaid API is sensitive and should be managed accordingly.
\nFor guidance on how to store and manage sensitive data, see the Open Finance Security Data Standard.
\nIdentifiers used by the Plaid API that do not contain consumer data and are not keys or tokens are designed to be used in less sensitive contexts. They are commonly used for logging and debugging purposes. The most common types of these identifiers are the account_id, item_id, link_session_id, and request_id.
These are the following types of field formats the Plaid API returns.
\nPlaid API uses the standard HTTP status codes for broad classification of errors.
\nThis section contains a list of possible errors you might encounter when using the Plaid API and solution to resolve the errors.
\nThe Plaid API sets the default rate limit in a way such that, using the API the way it is designed to be, the rate limit should not be encountered. If your use case requires a higher rate limit, contact your Account Manager or file a Support request.
\nThe following table provide information on different rate limits for endpoints when using Sandbox environment.
\n","_postman_id":"90961d66-4a45-4c75-b0f9-796ae0443d9a","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"API Versioning","item":[{"name":"Backward compatible changes","item":[],"id":"c00030c3-6a95-4f1c-91b4-4c4e8c4fdc53","description":"This section contains a list of changes that are considered to be backward compatible. That is, the API will continue to work with older versions without causing breakage.
\nAdding new API endpoints
\nAdding new optional parameters to existing endpoints
\nAdding new data elements to existing response schemas or webhooks
\nAdding new enum values, including error_types and error_codes
Subdividing existing error_codes into more precise errors and changing the http response code as necessary, as long as the error cannot be resolved via developer action (such as retries) during runtime.
Changing the behavior for use cases or platforms is explicitly not supported.
\nAdding new webhook_types and webhook_codes
Changing the length or content of any API identifier.
\nThe default version of the API will be used for any request you make, except you specify the version information. You can get the configured default version in your dashboard.
\nYou can also manually set the Plaid-Version header to use a specific version for a given API request.
If you're using one of the Plaid client libraries, they should all be pinned to the latest version of the API at the time when they were released. This means that you can change the API version you're using by updating to a newer version of the client library.
\nfrom plaid.api import plaid_api\nconfiguration = plaid.Configuration(\n host=plaid.Environment.Sandbox,\n api_key={\n 'clientId': PLAID_CLIENT_ID,\n 'secret': PLAID_SECRET,\n 'plaidVersion': '2020-09-14'\n }\n)\napi_client = plaid.ApiClient(configuration)\nclient = plaid_api.PlaidApi(api_client)\n\nThis version includes several changes to improve authentication, streamline and simplify the API, and improve international support.
\nTo improve authentication, the public_key has been fully removed from the API. Endpoints that previously accepted a public_key for authentication, namely /institutions/get_by_id and /institutions/search, now require a client_id and secret for authentication instead.
/item/remove no longer returns a removed boolean. This field created developer confusion because it was never possible for it to return false. A failed /item/remove call will result in an error being returned instead.
Several undocumented and unused fields have been removed from the institution object returned by the institutions endpoints /institutions/get, /institutions/get_by_id, and /institutions/search.The removed fields are: input_spec, credentials, include_display_data, has_mfa, mfa, and mfa_code_type.
The institutions endpoints /institutions/get, /institutions/get_by_id, and /institutions/search now require the use of a country_codes parameter. This parameter is now a top-level parameter. The use of 'US' for country_code value has also been disabled as it caused confusion for non-US developers.
To support international payments, the response schema for the partner-only /processor/auth/get endpoint has changed. This release brings the response for /processor/auth/get in line with the /auth/get response, allowing Plaid partners to extend support for using non-ACH payment methods such as EFT(Canada). Note: Accommodating this change does not require any code changes from Plaid developers who use partnership integrations, only from the Plaid partners themselves.
previous /procesor/auth/get response
\"numbers\": [{\n \"account\": \"9900009606\",\n \"account_id\": \"vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D\",\n \"routing\": \"011401533\",\n \"wire_routing\": \"021000021\"\n}]\n\n2020-09-14 /processor/auth/get response
\"numbers\": {\n \"ach\": [{\n \"account\": \"9900009606\",\n \"account_id\": \"vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D\",\n \"routing\": \"011401533\",\n \"wire_routing\": \"021000021\"\n }],\n \"eft\":[{\n \"account\": \"111122223333\",\n \"account_id\": \"vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D\",\n \"institution\": \"021\",\n \"branch\": \"01140\"\n }],\n \"international\":[{\n \"account_id\": \"vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D\",\n \"bic\": \"NWBKGB21\"\n \"iban\": \"GB29NWBK60161331926819\",\n }],\n \"bacs\":[{\n \"account\": \"31926819\",\n \"account_id\": \"vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D\",\n \"sort_code\": \"601613\"\n }]\n}\n\nThis section covers information about backward incompatible, versioned API changes. For a list of all API updates, including non-versioned ones, see the changelog.
\nWhenever backward incompatible change is made to general availability, non-beta product, we release a new API version to avoid causing breakages for existing developers. You can then continue to use the API version or update your application to upgrade to the new Plaid API version.
\n\n\n","_postman_id":"f5531972-ec3d-487d-9ef7-c8ffdd66a43d","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}}],"id":"9d7ec9eb-f7c8-4e6e-9d64-c85a974a0000","description":"Note: APIs for beta products are subject to breaking changes without versioning, with 30 days notice
\n
This section provides information on how to keep track of changes and updates made to the Plaid API.
\n","_postman_id":"9d7ec9eb-f7c8-4e6e-9d64-c85a974a0000","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Getting Started","item":[],"id":"ca17eaf6-154e-4b95-98fb-85bdb33c11f6","description":"To get started with the Plaid API, you need to follow the following steps:
\nStep 1: Create an account on the Plaid dashboard.
\nStep 2: Provide the necessary information to complete the sign-up process.
\nStep 3: Once you have created an account, navigate to the 'Developer' section on the left sidebar.
\nStep 4: Click the 'Keys' section and set up two-factor authentication to access the page.
\nStep 6: You can use either the 'Authentication App' or 'Text messages' to enable factor authentication.
\n\n\nNote: You need an authenticator app like Google Authenticator to enable factor authentication when using 'Authentication App'.
\n
Step 7: Get your client-id` and Secret.
Do not share your secret keys with anyone, including Plaid employees. It must be kept secured.
\nIn case your secret key gets compromised, please rotate it.
\n","_postman_id":"ca17eaf6-154e-4b95-98fb-85bdb33c11f6","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Authentication","item":[],"id":"dab97cea-ef43-4434-9dd3-060deb15582b","description":"Plaid uses OAUTH2.0 to securely authenticate requests.
\nTo begin, get your client_id and secret. Then, you create a public_token, which will be exchanged for an access token. The access token will be passed in the authorization header or in the body parameter to make your request.
The basic steps to follow include:
\nStep 1: Get your client_id and secrets`in your Developer dashboard.
Step 2: Make a request to CreatePublicToken endpoint to get your public-token.
Step 4: Make a request to TokenExchange endpoint to convert your public_token to access token.
Step 5: Use your access token to make your request.
\nYour access token contains sensitive information; it must be securely stored. In case it gets compromised, rotate it here.
\n","_postman_id":"dab97cea-ef43-4434-9dd3-060deb15582b","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Tokens","item":[{"name":"Create link token","id":"3004759d-9e32-4b48-9c73-ccae26c3cdcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"client_id\": \"6731fa55fda72b001a353b39\",\r\n\t\"secret\": \"deee0d759408b02d32bd0838ed40c5\",\r\n \"client_name\": \"Insert Client name here\",\r\n \"country_codes\": [\"US\"],\r\n \"language\": \"en\",\r\n \"user\": {\r\n \"client_user_id\": \"7069af\"\r\n },\r\n \"products\": [\"auth\", \"transfer\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.plaid.com/link/token/create","description":"This endpoint allows you to create a link-token.
\nThis endpoint allows you to create a public-token.
This endpoint allows you to exchange your public-token for an access token.
This endpoint allows you to invalidate a compromised access token and get a new access token associated with an item.
\nThis endpoint allows you to retrieve account information. It returns the bank account and identification number associated with an item's checking and savings account. It also returns high-level account data and balances when available.
\nThis endpoint allows you to retrieve a list of Plaid-initiated ACH or bank transfer events based on a specified filter criteria.
\nThis endpoint allows you to retrieve a list of Plaid-initiated bank transfer events that happened after a specific event_id.
This section retrieves bank account information to set up electronic funds transfers, such as ACH payments in the US, EFT payments in Canada, and IBAN / SIC payments in the EU.
\n","_postman_id":"d594ad8b-10f6-46a7-a5c1-65fb87537040","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Balance","item":[{"name":"Get real-time balance","id":"7781f97b-9ec8-41b6-a068-5359cf00261a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"6731fa55fda72b001a353b39\",\r\n \"secret\": \"deee0d759408b02d32bd0838ed40c5\",\r\n \"access_token\": \"access-sandbox-b15286f0-c39e-435d-8186-beb2a7c4c726\",\r\n \"options\": {\r\n \"account_ids\": [\"B8ZW8kGAlWcMp5lL6eGgHKn8wGVzLQf4vpb9b\"]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.plaid.com/accounts/balance/get","description":"This endpoint allows you to retrieve the real-time balance of an item's account.
\nThis endpoint allows you to retrieve various account holder information available on the financial institution file.
\nThis endpoint allows you to retrieve the match score of the provided identity data against the information on the financial institution file.
\nThis endpoint allows you to retrieve the identity of uploaded documents.
\nThis section allows you to get user's information and verify it against the bank account information on file.
\n","_postman_id":"69f4b89e-9bbd-47f4-8050-c98c03a80d33","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Signal","item":[{"name":"Evaluate planned ACH transaction","id":"036a9b23-a365-4832-85c2-eb3e8efe450c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"6731fa55fda72b001a353b39\",\r\n \"secret\": \"deee0d759408b02d32bd0838ed40c5\",\r\n \"access_token\": \"access-sandbox-b15286f0-c39e-435d-8186-beb2a7c4c726\",\r\n \"account_id\": \"B8ZW8kGAlWcMp5lL6eGgHKn8wGVzLQf4vpb9b\",\r\n \"client_transaction_id\": \"txn12345\",\r\n \"amount\": 123.45,\r\n \"client_user_id\": \"user1234\",\r\n \"user\": {\r\n \"name\": {\r\n \"prefix\": \"Ms.\",\r\n \"given_name\": \"Jane\",\r\n \"middle_name\": \"Leah\",\r\n \"family_name\": \"Doe\",\r\n \"suffix\": \"Jr.\"\r\n },\r\n \"phone_number\": \"+14152223333\",\r\n \"email_address\": \"jane.doe@example.com\",\r\n \"address\": {\r\n \"street\": \"2493 Leisure Lane\",\r\n \"city\": \"San Matias\",\r\n \"region\": \"CA\",\r\n \"postal_code\": \"93405-2255\",\r\n \"country\": \"US\"\r\n }\r\n },\r\n \"device\": {\r\n \"ip_address\": \"198.30.2.2\",\r\n \"user_agent\": \"Mozilla/5.0 (iPhone; CPU iPhone OS 13_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1\"\r\n },\r\n \"user_present\": true\r\n }","options":{"raw":{"language":"json"}}},"url":"https://sandbox.plaid.com/signal/evaluate","description":"This endpoint allows you to evaluate a planned ACH transaction. It returns a risk assessment (such as risk score and risk tier) and additional risk signal.
\nTo get a valid score for an ACH transaction, Plaid must have an access token for the account, and the item must be healthy (receiving product updates) or have recently been in a healthy state.
\n\n\nNote: This request may take some time to complete if Signal is being added to an existing item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
\n
This endpoint allows you to check if the planned ACH transaction was initiated.
\nThis endpoint allows you to report a returned transaction that was previously sent to the Evaluate planned ACH transaction endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
\nThis endpoint allows you to opt in an item to the Signal data collection process and to get a Signal score.
\nThis should be done on items where Signal was added in the additional_consented_products array but not in the products, optional_products, or required_if_supported_products array.
\n\nNote: If you run this on an Item that has already been initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
\n
This section provides information about Plaid Signal Products.
\nPlaid Signal allows you to evaluate the likelihood of a specific ACH transaction. It provides an overall risk assessment and risk tiers that you can incorporate in your own risk assessment models.
\nFor more information on Plaid Signals check the Signal Page.
\n","_postman_id":"1ce4b8ad-d7ac-44cf-b180-af94d2b31a99","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Transfer","item":[{"name":"Initiate Transfers","item":[{"name":"Authorize Transfer","id":"0ef68e8f-0e6c-4ca2-a975-bb7e91f70fa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"6731fa55fda72b001a353b39\",\r\n \"secret\": \"deee0d759408b02d32bd0838ed40c5\",\r\n \"access_token\": \"access-sandbox-b15286f0-c39e-435d-8186-beb2a7c4c726\",\r\n \"account_id\": \"B8ZW8kGAlWcMp5lL6eGgHKn8wGVzLQf4vpb9b\",\r\n \"type\": \"debit\",\r\n \"network\": \"ach\",\r\n \"amount\": \"12.34\",\r\n \"ach_class\": \"ppd\",\r\n \"user\": {\r\n \"legal_name\": \"Gloria Tejuosho\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://sandbox.plaid.com/transfer/authorization/create","description":"This endpoint allows you to authorize a transfer.
\n\n\nNote: You need to authorize a transfer before you can create a transfer.
\n
The transfer authorization will expire if not used after one hour. You can contact your manager to change the default authorization lifetime.
This endpoint allows you to cancel a transfer authorization.
\nNote: A transfer authorization is eligible for cancellation if it has not yet been used to create a transfer.
\nThis endpoint allows you to initiate a new transfer.
\nNotes:
\nThis endpoint is idempotent and retryable.
\nIf you provide a transfer ID that has already been used to create a transfer, it will return the details of the previous transfer without creating a new transfer.
\nA transfer may still be created if an error 500 is returned.
\nThis endpoint allows you to cancel a transfer.
\n\n\nNote: A transfer is eligible for cancellation if the
\ncancellableproperty returned by Retrieve Transfers endpoint istrue.
This section contains information on how to initiate transfers.
\n","_postman_id":"aed79166-b5e3-4a0d-9964-a7a4a8141479","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}},{"name":"Read Transfers","item":[{"name":"Retrieve Transfer","id":"2a7f21a9-d9a7-48ab-b3b5-1d96e09bd53f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"6731fa55fda72b001a353b39\",\r\n \"secret\": \"deee0d759408b02d32bd0838ed40c5\",\r\n \"transfer_id\": \"c9af39a1-2789-435e-d376-d1507563bdd2\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://sandbox.plaid.com/transfer/get","description":"This endpoint allows you to retrieve information about a transfer. You can either use a transfer_id or authorization_id to retrieve this information.
Note: You can't use both transfer_id and authorization_id.
This endpoint allows you to retrieve a list of all transfers and their statuses.
\n\n\nNote: Results are paginated; use the
\ncountandoffsetquery parameters to retrieve the desired transfers.
This endpoint allows you to retrieve a list of transfer events based on specified filter criteria.
\nThis endpoint allows you to retrieve a list of transfer events that happened after a specific event_id.
\n\nNote: Use this endpoint to guarantee you have seen all transfer events.
\n
This endpoint retrieves a list of sweeps that match the specified filter criteria.
\nThis section provides the meaning of technical terminology you're likely to come across while using our API
\n","_postman_id":"ad6e4028-2b45-49f4-b8c1-54b2a83a0281","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","id":"b73dbc12-7b96-48ae-9ea7-1fd4cb948dbc","name":"Plaid API Documentation","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"3f49837e-18a4-4d52-8903-a21d39f1d8d3","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ce244118-e430-485d-8e5f-4625f02e04d9","type":"text/javascript","packages":{},"exec":[""]}}]}