Skip to main content
POST
/
external-accounts
/
processor-token
Create or refresh external account
curl --request POST \
  --url https://api.natural.co/external-accounts/processor-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "data": {
    "attributes": {
      "partyId": "pty_7c9e6679e29b41d4a716446655440001",
      "processorToken": "processor-sandbox-abc123",
      "institutionName": "Chase"
    }
  }
}
'
{
  "data": [
    {
      "type": "externalAccount",
      "id": "eac_550e8400e29b41d4a716446655440000",
      "attributes": {
        "bankName": "Chase",
        "accountName": "Plaid Checking",
        "accountType": "checking",
        "lastFour": "0000",
        "status": "active",
        "connectionStatus": "active",
        "createdAt": "2026-01-04T15:30:00Z"
      },
      "relationships": {
        "party": {
          "data": {
            "type": "party",
            "id": "pty_7c9e6679e29b41d4a716446655440001"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    },
    "rejectedAccounts": []
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Body

application/json
data
object
required

Response

Successful Response

data
ExternalAccountResource · object[]
required

External accounts linked or refreshed by the request.

meta
object
required