OpenAPI
Test the Akoya API v2 and Token endpoints using the OpenAPI specs below. Refer to the Getting started page for instructions on obtaining an authorization code for the token endpoint.
Akoya provides secure (TLS v1.2) access to RESTful APIs that are based on the API/Data Structures as defined by the Financial Data Exchange. All data requests use standard GET and POST methods and must include authorization in the header. All responses are returned in JSON format.
OpenAPI tools
Tools such as Stoplight Studio, Swagger UI, or your choice of editors may be used.
If using Swagger UI through a browser without a proxy, the Akoya endpoints will return a CORS error such as: No Access-Control-Allow-Origin header is present on the requested resource
.
For more information, see CORS Requirements for "Try It Out" | SwaggerHub.
Tips for code generation
If using a code generator that strictly parses enums, please be aware that data retrieved through the Akoya network may have unknown enums and configure your generator appropriately.
For instance, if generating Java code with openapi-generator, consider setting enumUnknownDefaultCase = true
in your configuration. See: openapi-generator/java.md
The Akoya API specification uses anyOf
and oneOf
keywords to indicate data is valid against any of or one of the specified schemas. Some code generation tools have difficulty with these keywords. A workaround for code generation may be to replace oneOf
and anyOf
keywords with allOf
.
Note
If using this approach, data may not validate against an
allOf
schema.
Converting specs to 3.0
Among other new features, OpenAPI 3.1.0 introduced the ability to include more than one code example for a schema object:
content:
application/json:
example:
accountId: '753961248'
accountType: 'Savings'
content:
application/json:
examples:
Example 1:
accountId: '468172593'
accountType: 'Checking'
Example 2:
accountId: '372491586'
accountType: 'Brokerage'
Akoya has adopted OpenAPI v3.1.0 to leverage the ability to use more than one example. If you need to down-convert to 3.0.0, update the examples with one of the following methods:
- Remove ALL examples from the spec’s yaml file.
- Modify the schema object to include one example using the 3.0.0 syntax.
Process
- Change the version (first line of the file) from
openapi: 3.1.0
toopenapi: 3.0.0
:
openapi: 3.0.0
info:
title: Akoya APIs v2
version: '2.0'
summary: Akoya API v2
- Search the yaml file for instances of the
examples:
property. - Delete all instances of
examples:
and their child properties.
OR:
- To keep one example in a schema object, select the example you want to keep and delete the others in the object. Then, change
examples:
toexample:
and remove thetitle
property.
content:
application/json:
example:
accountId: '468172593'
accountType: 'Checking'
Change log
Date | Update |
---|---|
2024-Sept-11 | Moved Akoya API v2 spec to its own page. |
2024-Sept-09 | Added Akoya API v2.2.2 specification |
2024-Aug-06 | Added dev help resources. |
2024-Mar-08 | Added tip on down-converting OpenAPI version 3.1.0 to 3.0.0. |
2023-Dec-13 | Added codegen tip for anyOf and oneOf |
2023-Nov-03 | Updated Token specification to clarify refresh endpoint path and include the revoke endpoint with it rather than having two separate specifications. |
2023-Oct-02 | Added Akoya API v2.2 specification |
2023-Aug-25 | Added Akoya API v2.1 specification |
2022‑Dec‑21 | The specification had set recommended data elements as required in the response schemas, which caused code generation issues. This has been resolved. A tip was added to suggest allowing unknown enums during code generation. |
2022‑Dec‑05 | The specification had an error in the schema for returning multiple accounts with account data calls. This has been resolved. Updated examples. |
2022‑Nov‑18 | The specification did not indicate that the Investments endpoint supports all account types. This has been resolved with an update to the investments model, the addition of an investmentDetails model, and clarifications made in descriptions for Account Info, Balances, and Investments endpoints. |
2022‑Oct‑12 | Original version of Akoya OpenAPI spec 2.0 |
Need help?
Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.
Looking for provider nuance documentation?
All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.
Still stuck?
For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.
Updated about 1 month ago