Create bank link

URL Expired

The URL for this request expired after 30 days.

Bank link creation request

• id
  Type: string
  Required: Yes
  Constraints: length between 1 and 256
  Pattern: ^[a-zA-Z0-9_-]+$
  Description: A client-provided identifier for the bank link. Must be alphanumeric with hyphens and underscores only.

• subaccountId
  Type: uuid
  Required: Yes
  Description: The subaccount identifier to associate with this bank link.

• filters
  Type: object
  Optional: Yes
  Description: Optional per-link narrowing of the account's bank-linking policy.

• filters object

  • bin6
    Type: string
    Pattern: ^\d{6}$
    Description: First 6 digits captured client-side before an institution pivot (e.g. an American Express BIN typed into the card form before the SDK pivots to bank linking).

• accept
  Type: string
  Enum: Defaults to application/json
  Allowed: application/json, application/problem+json

HTTP Status Codes

• 201 Bank link created
• 400 The server cannot or will not process the request due to something that is perceived to be a client error
• 401 Authentication credentials were either missing or incorrect
• 403 Authentication credentials used do not have permissions to perform the request
• 404 The requested resource was not found on the server
• 409 Request conflict with the current state of the target resource
• 500 The server encountered an unexpected condition that prevented it from fulfilling the request

Example Request

curl --request POST \
     --url https://api.astrada.co/bank-links \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "filters": {
    "accountTypes": [
      "checking"
    ]
  }
}
'```

### Example Response

```json
{
  "_links": {
    "self": {
      "href": "/bank-links/enrollment_abc123"
    }
  },
  "id": "enrollment_abc123",
  "accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "subaccountId": "50cced63-ee4e-4ff7-a469-aaa989f220f2",
  "state": "pending",
  "hostedLink": "https://hosted.plaid.com/link/abc123",
  "linkExpiresAt": "2025-10-03T14:25:27.000Z",
  "createdAt": "2025-10-03T10:25:27.069Z"
}