HATEOAS Link

HATEOAS (Hypermedia As The Engine Of Application State) link

Financial DataOpen BankingOpen FinanceFinancial Data ExchangeConsumer-PermissionedAccount DataTransactionInvestmentsInsuranceTax DataPayrollRESTAuthenticationFAPICFPB 1033

Properties

Name Type Description
href string The resource URL
action object The HTTP method to use for the request
rel string The relation of this link to its containing entity, as defined by the [IETF RFC5988](https://datatracker.ietf.org/doc/html/rfc5988)
types array The content-types that can be used in the Accept header. **Note:** Plaid currently only accepts the PDF (`application/pdf`) content type
View JSON Schema on GitHub

JSON Schema

fdx-hateoaslink.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "HATEOAS Link",
  "description": "HATEOAS (Hypermedia As The Engine Of Application State) link\n",
  "required": [
    "href"
  ],
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "format": "uri-reference",
      "description": "The resource URL\n",
      "example": "https://api.fi.com/fdx/v4/accounts/12345"
    },
    "action": {
      "description": "The HTTP method to use for the request\n",
      "$ref": "#/components/schemas/HttpAction"
    },
    "rel": {
      "description": "The relation of this link to its containing entity, as defined by the [IETF RFC5988](https://datatracker.ietf.org/doc/html/rfc5988)\n",
      "type": "string"
    },
    "types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ContentTypes"
      },
      "description": "The content-types that can be used in the Accept header. **Note:** Plaid currently only accepts the PDF (`application/pdf`) content type\n"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/fdx-hateoaslink"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.