Plaid | Operate As Docs

Connect your client's Plaid with a key they paste, and call its API through Operate As.

Website: plaid.com
Connects by: Pasting a Secret
Category: Payments
Services: 1
Tools: 302

Service	Key	Base URL
Plaid	`plaid`	`https://{environment}.plaid.com`

Your client also types their client id (On the same page as the secret) and environment (production, or sandbox for testing).

Connecting

Your client makes a Secret in their Plaid settings and pastes it on their link. Operate As tries it with Plaid before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "plaid"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "plaid"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the Plaid key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install Plaid's typed package for your language:

pip install operate-as-plaid

pip install operate-as-plaid

Run plaid.accounts_balance_get

curl -X POST https://api.operate.as/v1/actions/plaid.accounts_balance_get \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {}
  }'

curl -X POST https://api.operate.as/v1/actions/plaid.accounts_balance_get \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {}  }'

Every input, with its JSON Schema: GET /v1/actions/plaid.accounts_balance_get

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://{environment}.plaid.com, with the parts in braces filled in from your client's account. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../plaidPOST /institutions/get" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../plaidPOST /institutions/get" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Plaid. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}