Skip to navigation
Engines

Show engine details

View as Markdown

Everything you need to build a request for one engine: what it asks for to log in, and what it can retrieve.

This is the endpoint that removes the guesswork, and the one worth calling before every integration change:

  • parameters — the credentials and inputs this engine needs, as an OpenAPI 3.0.3 Schema Object. It is a form description: field names, types, whether each one is required, and the labels to show. Build your input from it rather than hardcoding username + password, because institutions do change what they ask for.
  • features — every feature the engine offers, each with the configurations it accepts (a date range, a document type, a depth of history). What you send in features at execution time is chosen from here; Features is the guide to that vocabulary.
  • events — the events this engine raises, so you know which webhooks are worth subscribing to for it.
  • action_required_frequency — how often this engine stops mid-run to ask your customer something. always means every execution will need a person: starting one without customer_interaction_available is rejected outright.
  • engine_restrictions and engine_issues — known limits of the source in plain language, such as history that is only available for a certain period or data that cannot be read at certain hours.

A 503 means the engine exists but is not available right now; a 404 means the reference does not exist or is not enabled for your application.

Cache this too, and refresh it on a schedule rather than before every execution. An engine’s form changes when the institution changes it — rarely, and never in the seconds between two of your calls. What you must not do is hardcode the form and stop asking altogether: then the change arrives as a wave of failed logins instead of a new field.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

engine_referencestringRequiredformat: "engine-reference"

The engine, as the catalogue publishes it in reference.

Response

200 OK
What this engine is, what it needs to log in — the parameters, one by one, with their format and whether they are required — and which features it can retrieve, with the settings each one takes. It is the contract your request is validated against.

referencestringformat: "engine-reference"
engine_codestringformat: "engine-code"=24 characters
Engine Code
engine_alternativeenum

Engines can have multiple alternatives, each alternative is a different implementation for the same provider, but using a different platform or technology. For example there can be two alternatives for a financial institution, one for a website and another for the mobile app of the same institution. Note that two alternatives of the same engine can retrieve different information, based on the availability of the information in the platform or technology used by the alternative.

Allowed values are:

  • website: Alternative for website source
  • mobile: Alternative for mobile source
  • api: Alternative for official api source
  • other: Alternative for custom implementation
Allowed values:
engine_versionstringformat: "semantic-version"
environmentenum
Allowed values:
statusenum
Allowed values:
priorityinteger

Priority of the engine (For ordering purposes)

keywordslist of strings
Keywords that can be used to search
color_primaryobject
Primary theme color
main_categoryenum
Main Category of the engine normally related to the actions that the engine can performon the provider source or the kind of information that the engine can retrieve
Allowed values:
sub_categorieslist of enums
Sub Categories of the engine normally based on the kind of actions that the engine can perform on the provider source or the kind of information that the engine can retrieve
namestring
Formal name of the engine
descriptionstring
Brief description of the engine
marketslist of strings
Markets where the engine is oriented, can be used to filter the target audience of the engine
languageslist of strings
Languages supported by the provider
engine_restrictionslist of strings
Known engine restrictions
engine_issueslist of strings
Known engine issues
action_required_frequencyenum
liveobject
Information about the availability of the engine
eventslist of enums
Possible Events raised by the current engine. You can subscribe to the desired events to receive notifications and status updates about the execution of the engine.
Allowed values:
parametersobject
Description of the engine parameters in OpenAPI 3.0.3 Schema Object format
configurationsobject
Description of the engine configurations in OpenAPI 3.0.3 Schema Object format
is_onlinebooleanRead-only
Indicate if the engine is online
websitestring or nullOptionalformat: "uri"1-2083 characters
featureslist of objectsOptionalDefaults to []
Details for each feature allowed by the engine, and the configurations it accepts.
tokenized_accessbooleanOptionalDefaults to false

Whether this engine can keep your customer’s credentials for recurring access: launched with tokenized_access, it hands you a ticket to exchange for a token, and later runs use the token instead of the password. Typically offered by banks, telcos and utilities — sources worth reading again —, never assumed: check it per engine.

Errors

404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error