List your engines | INFONITE

List the engines your application can run right now.

An engine is one source — a bank, a utility, a public administration — behind one access channel. Everything you can execute is in this list, and everything in this list is executable at the moment you asked: the response only contains engines of the environment you asked for that have a published release, are deployed, and are neither locked nor withdrawn.

Use reference from each entry wherever an engine_reference is asked for.

One environment per answer. environment chooses which engines to list — production, the real institutions, or sandbox, demo engines that answer with test data — and it defaults to your application’s. A production application lists its production engines, and may ask for the sandbox ones to rehearse with: a run against a sandbox engine is flagged sandbox. A sandbox application lists sandbox engines only; asking it for production answers 403 production_not_enabled_for_this_app. The two are never listed together.

Filtering. markets narrows by country, main_category by the kind of source, and features by what you need to retrieve — with features_mode=and (the default) an engine must offer all of them, with or any of them. is_online=true keeps the engines answering right now and false the ones that are not; left out, both are listed.

What to do with is_online: false. It means the engine is not answering right now, usually because the source itself is unavailable. It is a temporary condition: an execution against it is rejected with 503, and the engine comes back on its own.

Cache this response. It is a directory, not a live signal. It changes when an engine is added or retired, not from one minute to the next, so fetch it on a schedule — once or twice a day is plenty — and launch your executions against your own copy. Refreshing it periodically is still worth doing: that is how a new engine, or a changed login form, reaches you without a deploy. Rate limits here are not aggressive today and we would rather keep it that way, so we reserve the right to tighten them; the integrations that get tightened are the ones polling a directory in a loop.

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

Query parameters

marketslist of stringsOptional

Filter by markets, if multiple values are provided, the result will be the engines that match any of the markets. If no value is provided, all markets will be returned

featureslist of enumsOptional

Filter by features. use with features_mode to specify how to filter the features

features_modeenumOptionalDefaults to and

Mode to filter the features, or will return engines that match any of the features, and will return engines that match all the features

Allowed values:

main_categoryenumOptional

Filter by engine main category. If not informed, all categories will be returned

Allowed values:

is_onlinebooleanOptional

If specified, filter by online/offline. If not specified, all items will be returned

environmentenumOptional

The environment to list: production (real institutions) or sandbox (demo engines that answer with test data). Absent: your application’s. A production application may list the sandbox engines it can rehearse with; a sandbox application lists sandbox engines only

Allowed values:

Response

200 OK
Everything your application can execute right now in one environment, and nothing else. An engine appears here only if it is published, deployed, not locked, not archived and of the environment you asked for — the same rules that decide whether an execution is accepted, so a listed engine is a runnable engine. Production and sandbox engines are never listed together.

reference is the value to send as engine_reference when you start an execution. An empty list is an answer — your application has nothing enabled with those filters — not an error.

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

featureslist of enums

List of features that the engine allows. Each feature is a type of action that the engine can perform

liveobject

Information about the availability of the engine

is_onlinebooleanRead-only

Indicate if the engine is online

websitestring or nullOptionalformat: "uri"1-2083 characters

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

403

Forbidden Error

422

Unprocessable Entity Error