Akoya Apps Management API 2.0.0
Paste the following code into your favorite text editor and save it as a YAML file.
Paste the following code into your favorite text editor and save it as a YAML file.
openapi: 3.1.0
x-stoplight:
id: b272hwx7qrem8
info:
title: Akoya Apps Management API v2.5.1
description: |-
Updated 11/12/2026
The Akoya Apps Management API helps you create and update your applications on the Akoya network.
Apps Management API updates:
- v2.1
March 10, 2026
- Refactored spec
February 25, 2026
- ABA Integration
- v2.0
April 28, 2025
- Updated response schema with the "logo" and "icon" properties.
February 20, 2025
- Made minor corrections regarding how to reset client secret.
- Set `status` query param to "optional."
- January 15, 2025
- Added clarifications regarding the use of the `products` query param.
- October 4, 2024
- Create App endpoint: Specify that the scope must include at least one product in addition to Account Information.
- Get Subscriptions for App endpoint: Mention that if an app is created with only Account Information, no subscriptions will be returned for that app.
- API updated to support DCR standards.
- v1.3.1
- Updated description for the Akoya providers by product endpoint:
- Corrected query examples.
- v1.3
- `put-subscriptions` now supports adding products to subscriptions. When products are added, the app must send end-users back through authorization to consent to the added product.
- `get-subscriptions-appId` is updated with a new response to support ability to add products (above).
- `get-apps` now returns Akoya products used by apps.
- The service token now requires the scope parameter to indicate the Akoya service used (Management API).
- Additional special characters added to `name` in app creation. `#$&'()*+,-./|–é`
- v1.2
- When searching providers for supported Akoya products, you're now able to indicate if you'd like providers who match ALL of your requested products or ANY (some).
- v1.1
- You may now GET a list of your apps and their details.
contact:
name: Akoya Support
url: 'https://www.akoya.com'
email: support@akoya.com
license:
name: Apache License Version 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
version: 2.1.0
servers:
- url: 'https://sandbox-api.akoya.com'
description: Sandbox API server
- url: 'https://api.akoya.com'
description: Production API server
security:
- bearerAuth: []
paths:
'/manage/{version}/apps/register':
post:
tags:
- Apps
summary: Create App
description: |-
Creates an application. This endpoint will automatically subscribe the created app to all valid providers.
>
> ⚠️ `scope` must include at least one product in addition to Account Information.
>
- `client_name` should be alphanumeric and may include special characters: `#$&'()\*+,-./|-é.`. `client_name` needs to be unique. You cannot create two applications with the same `client_name`.
- `logo_uri` must be a URL to a file (Required).
- Minimum height: 200px
- Minimum width: 200px
- Maximum height: 1080px
- Maximum width: 1080px
- File types: transparent PNG or JPG
- Maximum file size: 2 MB
- `icon_uri` must be a URL to a file (Optional).
- Must be square.
- Height = width.
- Minimum height: 40px
- Minimum width: 40px
- Maximum height: 200px
- Maximum width: 200px
- File types: transparent PNG or JPG
- Maximum file size: 2 MB
- `scope`: Products this app will use. This product list needs to be provided as a string where the products are space-seperated. You should include at least one product in addition to Account Information.
operationId: post-register
requestBody:
content:
application/json:
schema:
type: object
x-examples:
Example 1:
client_name: app_name
description: this is app description
redirect_uris:
- 'https://akoya.com'
logo_uri: 'https://dummyimage.com/240x240/000/ffffff.png'
icon_url: 'https://dummyimage.com/240x240/000/ffffff.png'
contacts:
- test@gmail.com
client_uri: 'http://localhost:8888'
scope: account_info payments
required:
- client_name
- description
- redirect_uris
- logo_uri
- contacts
- client_uri
- scope
properties:
client_name:
type: string
description:
type: string
redirect_uris:
type: array
items:
type: string
logo_uri:
type: string
icon_url:
type: string
contacts:
type: array
items:
type: string
client_uri:
type: string
scope:
type: string
examples:
Request Body:
value:
client_name: app_name
description: this is app description
redirect_uris:
- 'https://example.com/callback'
logo_uri: 'https://dummyimage.com/240x240/000/ffffff.png'
icon_url: 'https://dummyimage.com/240x240/000/ffffff.png'
contacts:
- test@example.com
client_uri: 'http://localhost:8888'
scope: account_info payments
responses:
'200':
$ref: '#/components/responses/CreateApp200'
'400':
description: Invalid Argument
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid Argument:
value:
code: InvalidArgument
message: unable to validate image
'409':
description: Already Exists
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
App already exists:
value:
code: AlreadyExists
message: This app name already exists for this recipientId.
x-stoplight:
id: c9cgyf0548shx
parameters:
- $ref: '#/components/parameters/VersionPath'
'/manage/{version}/recipients/{recipientId}/apps/{appId}':
patch:
tags:
- Apps
summary: Update App
description: |-
Update your application. The request format follows the JSON Patch specification ([<u>RFC 6902</u>](https://datatracker.ietf.org/doc/html/rfc6902/)<u>).</u>
- Only the add, replace, and remove (for lists only) operations are supported.
- `client_name` and the Akoya products your app uses (scope) cannot be updated with this endpoint.
- You cannot change an application's name after it's created.
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
op:
type: string
path:
type: string
value:
type: string
x-examples:
Example 1:
- op: replace
path: /description
value: this is a modified description
examples:
Replace description:
value:
- op: replace
path: /description
value: this is a modified description
Replace description and add redirect URI:
value:
- op: replace
path: /description
value: this is a modified description
- op: add
path: /redirect_uris/1
value: 'https://random2.com'
Reset client secret:
value:
- op: replace
path: /client_secret
value: ''
Add a new redirect URI:
value:
- op: add
path: /redirect_uris/0
value: 'https://example.com/callback'
description: "The request body will vary depending on what attributes of your application you're looking to update or replace.\r\n\r\n`\"op\"` (operation) accepted values: \r\n- `\"add\"`\r\n- `\"replace\"`\r\n - Use the `\"replace\"` operation when resetting your client secret.\r\n- `\"remove\"`\r\n\r\n`\"path\"` (app attribute) accepted values:\r\n- `\"/description\"` (app description)\r\n- `\"/redirect_uris/{number}`\" `{number}` is the redirect URI you want to alter (e.g. the first, the second). The redirect URI order is as shown in the Data Recipient Hub. Example: `\"/redirect_uris/1\"` refers to the second listed redirect URI.\r\n- `\"/client_secret\"`To reset, send an empty value. The new secret will return in the response. \r\n- `\"/client_uri\"`\r\n- `\"/contacts\"`\r\n- `\"/logo_uri\"`\r\n- `\"/icon_url\"`\r\n\r\n\r\n`\"value\"` (the value of the updated attribute) accepted values:\r\n- `\"\"` (blank string - resetting client secret ONLY)\r\n- Free text for other operation\r\n\r\n**Note**: You can enter more than one operation in the same request.\r\n"
operationId: patch-app
parameters:
- $ref: '#/components/parameters/RecipientId'
- $ref: '#/components/parameters/AppId'
responses:
'200':
$ref: '#/components/responses/UpdateApp200'
'400':
description: Invalid Argument
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid Argument:
value:
code: InvalidArgument
message: /client_name may not be modified
x-stoplight:
id: 7ve8hq0v5vsoq
parameters:
- $ref: '#/components/parameters/RecipientId'
- $ref: '#/components/parameters/AppId'
- $ref: '#/components/parameters/VersionPath'
delete:
description: ''
x-stoplight:
id: 9e1ucthjtwhtd
'/manage/{version}/recipients/{recipientId}/apps':
get:
tags:
- Apps
summary: Get All Apps
operationId: get-apps
description: |-
Get a paginated list of all your applications.
You can use the `next` and the `prev` links to page through the response. You can also pass a `offset` and a `limit` parameter to get a specific page. The default page size is 50, and the maximum allowed page size is 500.
parameters:
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/RecipientId'
responses:
'200':
$ref: '#/components/responses/GetAllApps200'
x-stoplight:
id: 6kdffio2cxf34
parameters:
- $ref: '#/components/parameters/VersionPath'
- $ref: '#/components/parameters/RecipientId'
'/manage/{version}/recipients/{recipientId}/products':
get:
tags:
- Products
summary: Get Purchased Products
operationId: get-purchased-products
description: Get a list of all your purchased Akoya products.
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/RecipientId'
responses:
'200':
$ref: '#/components/responses/GetPurchasedProducts200'
'401':
description: Invalid or Missing Authentication Token
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid or Missing Authentication Token:
value:
code: UnauthorizedAccess
message: Unauthorized
x-stoplight:
id: mgg4gndk65wjc
parameters:
- $ref: '#/components/parameters/VersionPath'
- $ref: '#/components/parameters/RecipientId'
'/manage/{version}/recipients/{recipientId}/providers':
get:
tags:
- Providers
summary: Get Valid Providers For Products
operationId: get-providers
description: ">\n> \U0001F4D8 While you can only specify one product in the \"Try it now\" component below, this endpoint allows you to use `&` to separate two or more products or two or more routing_transit_numbers. The format should be `products=val1&products=val2&products=val3` or `routing_transit_numbers=021000021&routing_transit_numbers=031100209`. \n> \n> The result will be a list of providers that support ALL the products listed.\n\nGet a paginated list of all providers connected to Akoya that support any of the products passed in as a query parameter (`products`).\n\nOptionally filters by one or more ABA routing transit numbers. The recipient must have purchased the requested products.\n\nWhen `routing_transit_numbers` is supplied, the result set is narrowed to providers matching any of the given RTNs. Each matching provider returns all of its associated RTNs, not just the ones in the query.\n\n>\n> \U0001F4D8 For optimal performance, call this endpoint once and cache the logo and icon URLs for future use rather than requesting them each time you display your account selector.\n\nThe payload now includes the following fields:\n- `provider_id` - `providerId`\n- `display_name` - The provider's display name\n- `logo` - The provider's full logo\n- `icon` - The provider's icon (often a submark logo)\n- `provider_url` - The provider's website\n\n**Logo and icon details**\n\n`logo` and `icon` are URLs to image files hosted on Akoya’s CDN (cdn.akoya.com). They are not image data. All images are checked when a provider is set up on the network:\n\n• Logo: PNG or JPEG, between 200 and 1080 pixels in width and height, up to 2 MB. Logos are not always square.\n• Icon: square PNG or JPEG, between 40 and 200 pixels, up to 2 MB.\n\nSizes vary by provider, and backgrounds may not be transparent, so scale images to fit your interface rather than assuming a fixed size.\nlogo and icon are omitted from the response when a provider hasn’t shared a logo.\n\nYou can use the `next` and the `prev` links to page through the response. You can also pass a `offset` and a `limit` parameter to get a specific page. The default page size is 50, and the maximum allowed page size is 500."
parameters:
- $ref: '#/components/parameters/Products'
- $ref: '#/components/parameters/RecipientId'
- $ref: '#/components/parameters/RoutingTransitNumbers'
- $ref: '#/components/parameters/Register'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
$ref: '#/components/responses/GetValidProvidersForProducts200'
'400':
description: Invalid Request Parameters
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
type: string
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
type: string
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Malformed Routing Transit Number:
value:
code: InvalidArgument
message: Invalid routing transit number format. Each value must be exactly 9 numeric digits.
No Products Provided:
value:
code: InvalidArgument
message: At least one of 'products' is required.
'401':
description: Invalid or Missing Authentication Token
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
400 Invalid or Missing Authentication Token:
value:
code: UnauthorizedAccess
message: Unauthorized
'503':
description: Upstream Service Unavailable
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
503 Upstream Service Unavailable:
value:
code: ServiceUnavailable
message: Unable to retrieve provider data at this time. Please retry later.
'504':
description: Upstream Service Timed Out
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
type: string
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Upstream Service Timed Out:
value:
code: GatewayTimeout
message: gateway timed out
x-stoplight:
id: pyhggiq2zl2jd
parameters:
- $ref: '#/components/parameters/VersionPath'
- $ref: '#/components/parameters/RecipientId'
'/manage/{version}/subscriptions/{appId}':
get:
tags:
- Subscriptions
summary: Get Subscriptions For App
description: |-
Returns the providers an app is actively subscribed to, including subscription status, account categories, products, and (when available) ABA routing transit numbers, legal entity name, and state of incorporation for each provider.
Results are inherently scoped to the app's active subscriptions so ABA data is only returned for providers the app is entitled to access.
>
> ⚠️ If you created an app with only the Account Information product, no subscriptions will be returned for that app.
>
You can use the `next` and the `prev` links to page through the response. You can also pass a `offset` and a `limit` parameter to get a specific page. The default page size is 50, and the maximum allowed page size is 500.
operationId: get-subscriptions
parameters:
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/AppId'
- $ref: '#/components/parameters/Status'
responses:
'200':
$ref: '#/components/responses/GetSubscriptionsForApp200'
'400':
description: Invalid Request Parameters
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
type: string
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
type: string
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid Request Parameters:
value:
code: InvalidArgument
message: Invalid routing transit number format. Each value must be exactly 9 numeric digits.
'401':
description: Invalid or Missing Authentication Token
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid or Missing Authentication Token:
value:
code: UnauthorizedAccess
message: Unauthorized
'404':
description: App or Subscription Not Found
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
App or Subscription Not Found:
value:
code: InvalidArgument
message: The appId or subscription cannot be found.
'503':
description: Upstream Service Unavailable
headers:
Retry-After:
schema:
$ref: '#/components/headers/Retry-After'
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Upstream Service Unavailable:
value:
code: ServiceUnavailable
message: Unable to retrieve provider data at this time. Please retry later.
'504':
description: Upstream Service Timed Out
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Upstream Service Timed Out:
value:
code: GatewayTimeout
message: gateway timed out
x-stoplight:
id: lzpzwfk4r73bo
parameters:
- schema: null
$ref: '#/components/parameters/VersionPath'
- $ref: '#/components/parameters/AppId'
'/manage/{version}/subscriptions/{appId}/status':
get:
tags:
- Subscriptions
summary: Get Subscriptions For App - Filter By Status
description: |-
Get a paginated list of all subscriptions filtered by the `status` query parameter for this application. Includes ABA routing transit numbers, legal entity name, and state of incorporation when available.
Valid values for the `status` parameter are:
- `ACTIVE`
- `PENDING`
- `PROCESSING`
- `TERMINATED`
- `DENIED`
Omitting the `status` parameter will return ALL subscriptions across all statuses.
You can use the `next` and the `prev` links to page through the response. You can also pass a `offset` and a `limit` parameter to get a specific page. The default page size is 50 and the maximum allowed page size is 500.
operationId: get-subscriptions-filter
parameters:
- $ref: '#/components/parameters/Status'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/AppId'
responses:
'200':
$ref: '#/components/responses/GetSubscriptionsForAppFilterByStatus200'
'400':
description: Invalid Request Parameters
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid Request Parameters:
value:
code: InvalidArgument
message: Invalid routing transit number format. Each value must be exactly 9 numeric digits.
'401':
description: Invalid or Missing Authentication Token
headers:
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
type: string
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
type: string
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid or Missing Authentication Token:
value:
code: UnauthorizedAccess
message: Unauthorized
'503':
description: Upstream Service Unavailable
headers:
Retry-After:
schema:
$ref: '#/components/headers/Retry-After'
Content-Type:
schema:
$ref: '#/components/headers/Content-Type'
description: Indicates the media type (MIME type) of the resource being sent in the response.
x-akoya-interaction-id:
schema:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Akoya supplied interaction id used for logging and error tracking.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Upstream Service Unavailable:
value:
code: ServiceUnavailable
message: Unable to retrieve provider data at this time. Please retry later.
x-stoplight:
id: i1u9qfuyqhcun
parameters:
- $ref: '#/components/parameters/VersionPath'
- $ref: '#/components/parameters/AppId'
components:
headers:
Content-Type:
schema:
type: string
description: Indicates the media type (MIME type) of the resource being sent in the response.
example: application/json; charset=utf-8
Retry-After:
schema:
type: integer
description: Suggested wait time in seconds before retrying.
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking.
example: Root=1-66981abd-3baf2692467140e0aeffcb57d6997db9
parameters:
AppId:
name: appId
in: path
description: The ID of your application.
required: true
schema:
type: string
example: '{{appId}}'
appIdPath:
name: appId
in: path
required: true
description: Application identifier (UUID).
schema:
type: string
example: c8a14d90-7843-4b4f-995f-e081ac99fa96
Limit:
name: limit
in: query
description: 'Number of items per page (default = 50, must be <=500).'
schema:
type: integer
example: 2
Offset:
name: offset
in: query
description: Number of skipped items (Zero-based; default = 0).
schema:
type: integer
example: 10
Products:
name: products
in: query
description: Akoya product (e.g. Balances).
required: true
schema:
type: string
example: Balances
providerIdPath:
name: providerId
in: path
required: true
description: 'Provider identifier (`^[a-zA-Z0-9-_:]+$`).'
schema:
type: string
pattern: '^[a-zA-Z0-9\-_:]+$'
example: mikomo
RecipientId:
name: recipientId
in: path
description: Your recipient id. You may find your recipientId in the Data Recipient Hub under Team Management/Company Id.
required: true
schema:
type: string
example: '{{recipient_id}}'
recipientIdPath:
name: recipientId
in: path
required: true
description: 'Data recipient identifier (`^[a-zA-Z0-9-_:]+$`).'
schema:
type: string
pattern: '^[a-zA-Z0-9\-_:]+$'
example: acme-corp
Register:
name: register
in: query
description: 'Default value : ALL. Cluster registration mode. `ALL` requires the provider to support every requested product; `ANY` requires at least one. Available values : `ALL`, `ANY`.'
schema:
type: integer
RoutingTransitNumbers:
name: routing_transit_numbers
in: query
description: '9‑digit ABA routing transit numbers to filter by. Repeat the parameter for multiple values. When omitted, no RTN filter is applied. Example : routing_transit_numbers=021000021&routing_transit_numbers=031100209'
schema:
type: string
Status:
name: status
in: query
description: 'Your subscription status. Available values : ACTIVE, TERMINATED, PENDING, DENIED, MODIFIED, PROCESSING'
schema:
type: string
enum:
- ACTIVE
- PENDING
- PROCESSING
- TERMINATED
- DENIED
example: ACTIVE
VersionPath:
name: version
in: path
description: Management API major version (e.g. v2).
required: true
schema:
type: string
responses:
BadRequest:
description: Invalid request parameters or body
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: InvalidArgument
message: Invalid request parameter.
examples:
Bad Request:
value:
code: InvalidArgument
message: Invalid request parameter.
CreateApp200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
client_id:
type: string
client_secret:
type: string
client_name:
type: string
redirect_uris:
type: array
items:
type: string
client_uri:
type: string
contacts:
type: array
items:
type: string
description:
type: string
logo_uri:
type: string
icon_url:
type: string
scope:
type: string
grant_types:
type: array
items:
type: string
status:
type: string
examples:
Successful Response:
value:
client_id: client_id
client_secret: client_secret
client_name: app_name
redirect_uris:
- 'https://akoya.com'
client_uri: 'https://akoya.com'
contacts:
- test@gmail.com
description: this is app description
logo_uri: 'https://dummyimage.com/240x240/000/ffffff.png'
icon_url: 'https://dummyimage.com/240x240/000/ffffff.png'
scope: account_info payments
grant_types:
- authorization_code
- refresh_token
status: Approved
GatewayTimeout:
description: Upstream service timed out
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: GatewayTimeout
message: gateway timed out
examples:
Gateway Timeout:
value:
code: GatewayTimeout
message: gateway timed out
GetAllApps200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
page:
type: object
properties:
total_elements:
type: integer
links:
type: object
properties:
next:
type: object
properties:
href:
type: string
prev:
type: object
properties:
href:
type: string
apps:
type: array
items:
type: object
properties:
client_id:
type: string
client_name:
type: string
description:
type: string
redirect_uris:
type: array
items:
type: string
client_uri:
type: string
logo_uri:
type: string
contacts:
type: array
items:
type: string
scope:
type: string
owner:
type: string
examples:
Successful Response:
value:
page:
total_elements: 221
links:
next:
href: /manage/v2/recipients/paprika_rec/apps?limit=2&offset=12
prev:
href: /manage/v2/recipients/paprika_rec/apps?limit=2&offset=8
apps:
- client_id: a24fd6b6-fa38-482e-9c91-26ca4bc1a490
client_name: paprika_testNew_4
description: this is app description
redirect_uris:
- 'https://example.com/callback1'
client_uri: 'http://localhost:8888'
logo_uri: 'https://picsum.photos/1024/1024.jpg'
contacts:
- test@example.com
scope: balances account_info payments investments customers
owner: paprika_rec
- client_id: dbc84f1b-e6f1-4d09-a928-16411a7f87ea
client_name: paprika_testNew_5
description: this is app description
redirect_uris:
- 'https://example.com/callback2'
client_uri: 'http://localhost:8888'
logo_uri: 'https://picsum.photos/1024/1024.jpg'
contacts:
- test@example.com
scope: payments investments customers balances account_info
owner: paprika_rec
GetPurchasedProducts200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
products:
type: array
items:
type: object
properties:
name:
type: string
display_name:
type: string
description:
type: string
required:
type: boolean
examples:
Successful Response:
value:
products:
- name: account_info
display_name: Account Info
description: 'Account display name, masked account number, type, description.'
required: true
- name: payments
display_name: Payments
description: Identifiers necessary to make ACH and RTP payments.
required: false
- name: investments
display_name: Accounts & Investments
description: Detailed information on underlying holdings and positions of investment accounts.
required: false
- name: customers
display_name: Customers
description: 'Verified contact information on file, including name, email, address, and phone number.'
required: false
- name: balances
display_name: Balances
description: 'Balances and rates of bank accounts, credit cards, loans, investments, and more.'
required: false
- name: transactions
display_name: Transactions
description: 'Up to two years of transaction data across account types, including amounts, dates, and descriptions.'
required: false
GetSubscriptionsForApp200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
page:
type: object
properties:
total_elements:
type: integer
links:
type: object
properties:
next:
type: object
properties:
href:
type: string
subscriptions:
type: array
items:
type: object
properties:
provider_id:
type: string
display_name:
type: string
routing_transit_numbers:
type: array
items:
type: string
legal_entity_name:
type: string
state_of_incorporation:
type: string
subscription_status:
type: string
account_categories:
type: array
items:
type: string
products:
type: array
items:
type: string
logo_uri:
type: string
icon_uri:
type: string
examples:
Subscriptions with ABA Data:
value:
page:
total_elements: 2
links:
next:
href: /manage/v2/subscriptions/c8a14d90-7843-4b4f-995f-e081ac99fa96?limit=50&offset=50
subscriptions:
- provider_id: mikomo
display_name: Mikomo
routing_transit_numbers:
- '021000021'
- '021200339'
legal_entity_name: 'Mikomo National Bank, National Association'
state_of_incorporation: NY
subscription_status: ACTIVE
account_categories:
- depositAccount
- loanAccount
- investmentAccount
products:
- account_info
- transactions
logo_uri: 'https://cdn.akoya.com/assets/providers/mikomo/logo.png'
icon_uri: 'https://cdn.akoya.com/assets/providers/mikomo/icon.png'
- provider_id: mainst
display_name: Main St. Bank
routing_transit_numbers:
- '031100209'
legal_entity_name: Main Street Bank
state_of_incorporation: VA
subscription_status: ACTIVE
account_categories:
- depositAccount
products:
- account_info
logo_uri: 'https://cdn.akoya.com/assets/providers/mainst/logo.png'
'One Subscription with ABA, One Without':
value:
page:
total_elements: 2
links: {}
subscriptions:
- provider_id: mikomo
display_name: Mikomo
routing_transit_numbers:
- '021000021'
legal_entity_name: 'Mikomo National Bank, National Association'
state_of_incorporation: NY
subscription_status: ACTIVE
account_categories:
- depositAccount
products:
- account_info
- provider_id: newbank
display_name: New Bank
subscription_status: ACTIVE
account_categories:
- depositAccount
products:
- account_info
GetSubscriptionsForAppFilterByStatus200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
page:
type: object
properties:
total_elements:
type: integer
links:
type: object
properties:
next:
type: object
properties:
href:
type: string
prev:
type: object
properties:
href:
type: string
subscription_status:
type: array
items:
type: object
properties:
provider_id:
type: string
display_name:
type: string
status:
type: string
products:
type: array
items:
type: string
routing_transit_numbers:
type: array
items:
type: string
legal_entity_name:
type: string
state_of_incorporation:
type: string
examples:
Subscription Statuses:
summary: 200 OK
value:
page:
total_elements: 342
links:
next:
href: /manage/v2/subscriptions/c8a14d90?limit=50&offset=50
prev:
href: /manage/v2/subscriptions/c8a14d90?limit=50&offset=50
subscription_status:
- provider_id: mikomo
display_name: Mikomo
status: ACTIVE
products:
- account_info
routing_transit_numbers:
- '021000021'
- '021200339'
legal_entity_name: 'Mikomo National Bank, National Association'
state_of_incorporation: NY
GetValidProvidersForProducts200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
page:
type: object
properties:
total_elements:
type: integer
links:
type: object
properties:
next:
type: object
properties:
href:
type: string
providers:
type: array
items:
type: object
properties:
provider_id:
type: string
display_name:
type: string
routing_transit_numbers:
type: array
items:
type: string
legal_entity_name:
type: string
state_of_incorporation:
type: string
logo:
type: string
icon:
type: string
provider_url:
type: string
examples:
Two Providers with ABA data:
value:
page:
total_elements: 2
links:
next:
href: /manage/v2/recipients/acme-corp/providers?products=account_info&limit=50&offset=50
providers:
- provider_id: mikomo
display_name: Mikomo Bank
routing_transit_numbers:
- '021000021'
- '021200339'
legal_entity_name: 'Mikomo National Bank, National Association'
state_of_incorporation: NY
logo: 'https://cdn.akoya.com/assets/providers/mikomo/logo.png'
icon: 'https://cdn.akoya.com/assets/providers/mikomo/icon.png'
provider_url: 'https://www.mikomo.com'
- provider_id: mainst
display_name: Main St. Bank
routing_transit_numbers:
- '031100209'
legal_entity_name: Main Street Bank
state_of_incorporation: VA
logo: 'https://cdn.akoya.com/assets/providers/mainst/logo.png'
provider_url: 'https://www.mainstreetbank.com'
Provider without ABA Data (fields omitted):
value:
page:
total_elements: 1
links: {}
providers:
- provider_id: newbank
display_name: New Bank
logo: 'https://cdn.akoya.com/assets/providers/newbank/logo.png'
provider_url: 'https://www.newbank.com'
RTN Search with No Matching Providers:
value:
page:
total_elements: 0
links: {}
providers: []
ServiceUnavailable:
description: Upstream service unavailable
headers:
Retry-After:
description: Suggested wait time in seconds before retrying.
schema:
type: integer
example: 30
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: ServiceUnavailable
message: Unable to retrieve data at this time. Please retry later.
examples:
Service Unavailable:
value:
code: ServiceUnavailable
message: Unable to retrieve data at this time. Please retry later.
Unauthorized:
description: Missing or invalid authentication token
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: UnauthorizedAccess
message: Unauthorized
examples:
Unauthorized Access:
value:
code: UnauthorizedAccess
message: Unauthorized
UpdateApp200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
type: object
properties:
client_id:
type: string
client_name:
type: string
owner:
type: string
redirect_uris:
type: array
items:
type: string
client_uri:
type: string
contacts:
type: array
items:
type: string
description:
type: string
logo_uri:
type: string
scope:
type: array
items:
type: string
examples:
Replaced Description:
summary: 200 OK
value:
client_id: c8a14d90-7843-4b4f-995f-e081ac99fa96
client_name: app_name_2
owner: paprika_rec
redirect_uris:
- 'https://example.com/callback'
client_uri: 'http://localhost:8888'
contacts:
- test@example.com
description: this is a modified description
logo_uri: 'https://dummyimage.com/240x240/000/ffffff.png'
scope:
- account_info
- payments
Added Redirect URI and Replaced Description:
summary: 200 OK - Add a new Redirect URI
value:
client_id: c8a14d90-7843-4b4f-995f-e081ac99fa96
client_name: app_name_2
owner: paprika_rec
redirect_uris:
- 'https://example.com/callback1'
- 'https://example.com/callback2'
client_uri: 'http://localhost:8888'
contacts:
- test@example.com
description: this is a modified description
logo_uri: 'https://dummyimage.com/240x240/000/ffffff.png'
scope:
- account_info
- balances
schemas:
AccountTypeInventoryCoverage:
type: object
description: Account types supported by a provider for a given account category.
properties:
accountCategory:
type: string
description: 'The account category (e.g. `depositAccount`, `loanAccount`).'
example: depositAccount
accountTypes:
type: array
items:
$ref: '#/components/schemas/AccountTypePolicyCoverage'
x-stoplight:
id: 3iba7yxqix0nn
AccountTypePolicyCoverage:
type: object
description: Coverage details for a single account type.
properties:
accountTypeId:
type: string
accountType:
type: string
accountTypeDisplayName:
type: string
accountSubCategory:
type: string
accountCategory:
type: string
state:
type: string
clusters:
type: array
items:
type: string
clusterCount:
type: integer
description: Number of clusters that support this account type for this provider.
totalClusters:
type: integer
description: Total number of clusters that could support this account type.
x-stoplight:
id: 6q77zao38gczn
AppInfo:
type: object
description: FDX-compliant OAuth application details.
properties:
client_id:
type: string
example: c8a14d90-7843-4b4f-995f-e081ac99fa96
client_name:
type: string
example: My Fintech App
description:
type: string
redirect_uris:
type: array
items:
type: string
format: uri
client_uri:
type: string
format: uri
logo_uri:
type: string
format: uri
icon_url:
type: string
format: uri
contacts:
type: array
items:
type: string
format: email
scope:
type: string
description: Space-separated Akoya product names the app is authorised for.
owner:
type: string
description: Recipient ID that owns this application.
example: acme-corp
x-stoplight:
id: p0qt5q9nnc5sy
EnvironmentStatus:
type: object
properties:
default:
type: string
enum:
- LIVE
- UPCOMING
- DISABLED
description: Production environment status.
example: LIVE
sandbox:
type: boolean
description: Whether the provider is available in the sandbox environment.
x-stoplight:
id: vjdpvrwoc5q69
Error:
title: error
description: 'An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. See the error codes and descriptions defined in the latest FDX API Specification document, section 6.2 Errors'
type: object
properties:
code:
type: string
description: Error code defined by FDX API specification or data provider indicating the error situation which has occurred.
message:
type: string
description: End user displayable information which might help the customer diagnose an error.
x-stoplight:
id: 6pjobcxop0tfd
ImageData:
type: object
description: Provider image with optional CDN URL.
properties:
url:
type: string
format: uri
description: Origin image URL.
cdnUrl:
type: string
format: uri
description: CDN-cached image URL (preferred when available).
x-stoplight:
id: s46knvkuqtt2p
RecipientProduct:
type: object
description: An Akoya product (cluster).
properties:
name:
type: string
description: Unique product name used as an identifier.
example: account_info
display_name:
type: string
description: Human-readable product name.
example: Account Information
description:
type: string
required:
type: boolean
description: |
When `true`, this product is automatically included for all recipients
and must be present in every app's scope.
x-stoplight:
id: 9t5wnxzcnat51
StatusMessage:
type: object
properties:
code:
type: string
example: success
message:
type: string
example: Successfully deleted app c8a14d90-7843-4b4f-995f-e081ac99fa96
x-stoplight:
id: diehwd4hee86k
V2ProviderDetails:
type: object
description: Full provider details returned by the provider-by-ID endpoint.
allOf:
- type: object
required:
- id
- displayName
- subscriptionType
- environmentStatus
properties:
id:
type: string
example: mikomo
displayName:
type: string
example: Mikomo Bank
createdDate:
type: string
format: date
example: '2023-01-15'
activeTermsVersion:
type: string
description: Version string of the currently active terms of service.
description:
type: string
contacts:
type: array
items:
type: string
format: email
contactUsUri:
type: string
format: uri
subscriptionType:
type: string
enum:
- AUTO_APPROVE
- MANUAL_APPROVE
- AUTO_REGISTRATION
- MANUAL_REGISTRATION
example: AUTO_APPROVE
environmentStatus:
$ref: '#/components/schemas/EnvironmentStatus'
skipPolicyEnforcement:
type: boolean
expectedClusters:
type: array
items:
type: string
supportedClusters:
type: array
items:
type: string
example:
- account_info
- transactions
enrichment:
type: boolean
capture:
type: boolean
providerUrl:
type: string
format: uri
logo:
$ref: '#/components/schemas/ImageData'
icon:
$ref: '#/components/schemas/ImageData'
metadata:
type: object
description: Arbitrary provider-level metadata.
additionalProperties: true
- type: object
description: |
ABA fields on the provider detail endpoint. These use camelCase to
match the surrounding provider object convention.
properties:
routingTransitNumbers:
type: array
description: ABA routing transit numbers associated with this provider.
items:
type: string
pattern: '^\d{9}$'
example:
- '021000021'
- '021200339'
legalEntityName:
type: string
description: Full legal name of the institution.
example: 'Mikomo National Bank, National Association'
stateOfIncorporation:
type: string
description: Two-letter US state abbreviation of the institution's legal domicile.
minLength: 2
maxLength: 2
example: NY
x-stoplight:
id: leosar48p9exz
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
x-internal: true
tags:
- name: Apps
- name: Products
- name: Providers
- name: Subscriptions
- name: Health
x-readme:
explorer-enabled: true
proxy-enabled: true