The Plaid API OpenAPI spec score

Octri scored the public spec at https://raw.githubusercontent.com/plaid/plaid-openapi/master/2020-09-14.yml for what a code generator can do with it. This is a reading of the document, not a grade of the API.

7.8/ 10
Mixed

350 operations · 2476 models · 1 tag · OpenAPI 3.0.0

Scored 16 October 2026 · fingerprint ea443cd78f6f… · spec version 2020-09-14_1.778.0 · server production.plaid.com

Document last changed 16 October 2026.

Where the points went

Every rule, heaviest first, with what it cost this document, how much of the surface it touched, and where. The rule id links to what that rule checks.

RuleWeightResultSurfaceLocations
Successful responses declare a schemaresponse-schema2.00.4 lost1 of 350 operationsPOST /fdx/notifications
Shared models live in components and are $ref'dshared-schemas-referenced2.0Clean350 operations cleanNothing found
Generated public names do not collideoperation-id-unique2.0Clean350 operations cleanNothing found
Every path placeholder has a parameterpath-parameters-declared1.5Clean350 operations cleanNothing found
Every operation declares an operationIdoperation-id-present1.0Clean350 operations cleanNothing found
operationIds read as method namesoperation-id-naming1.01.0 lost347 of 350 operationsPOST /asset_report/createPOST /asset_report/getPOST /asset_report/pdf/getand 344 more
Operations carry a summary or descriptionoperation-documented1.0Clean350 operations cleanNothing found
Request bodies are documentedrequest-body-documented1.00.5 lost131 of 350 operationsPOST /asset_report/pdf/getPOST /asset_report/removePOST /cra/monitoring_insights/unsubscribeand 128 more
Failure responses are declarederror-responses1.00.3 lost49 of 350 operationsPOST /dashboard_user/getPOST /dashboard_user/listPOST /identity_verification/createand 46 more
Operations are taggedoperation-tagged1.0Clean350 operations cleanNothing found
No duplicate or equivalent pathsduplicate-paths1.0Clean359 paths cleanNothing found
Authentication is describedsecurity-declared1.0CleanDeclaredNothing found
Parameters explain their purposeparameters-documented0.75Clean350 operations cleanNothing found
A server URL is declaredserver-url0.5CleanDeclaredNothing found

Packaging, outside the score

This generates one package with 350 operations and 2476 models. Frontend consumers download all of it to call any of it, and low-spec machines pay for it in IDE and build time. The largest groups are `plaid` (350), and each is a candidate for its own project.

What 7.8 means for an SDK

A mixed reading, and the three rules that decide most of it.

The client compiles and works. Callers will feel the soft spots: a few methods that return an untyped value, arguments with no hint on them, a namespace or two named after a path segment rather than a resource.

Three rules carry six of the 10 points between them. On this document they took 0.4.

−0.4

Successful responses declare a schema

1 of 350 operations

Clean

Shared models live in components and are $ref'd

350 operations clean

Clean

Generated public names do not collide

350 operations clean

What to change first

Every rule that deducted, in the order they cost.

  1. 0.4 lost

    Successful responses declare a schema

    Give the success response a schema, or a $ref to one in components. A 204 needs nothing.

    Inside Octri this one has a one-click fix.

  2. 1.0 lost

    operationIds read as method names

    Name the id for the action, not the route. The audit suggests one per operation and can apply it.

    Inside Octri this one has a one-click fix.

  3. 0.5 lost

    Request bodies are documented

    Describe the body, or the fields inside it. Field-level prose is the one that reaches the SDK's arguments.

    Inside Octri this one has a one-click fix.

  4. 0.3 lost

    Failure responses are declared

    Declare the failures you actually return, or one `default` response carrying your error shape.

The spec at raw.githubusercontent.com is public. Octri keeps the `info` block, the score, and up to five sample finding locations per rule. The document itself is not stored and is not served from here. The audit predicts what an SDK generator can do with the description; it is not a security review, an uptime measurement or a critique of the API’s design. This page is not affiliated with The Plaid API or Plaid Developer Team.