providers

Get all the providers

This endpoint provides a list of all the brands for which we are able to provide a connection and manage financial products. A provider is composed of a list of credentials to ensure the connection to the website of this provider. Some will have to be encrypted using an encryption key (see /keys), the expected value of a credential is defined by a regular expression. Providers can be filtered and paginated using different criteria

get/providers

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/providers
  • Auth: none declared

Query parameters

pagenumber

Page number in the pagination

limitnumber

Max number of providers to retrieve

paginationboolean

The pagination can be disabled by changing this parameter to "false". This makes it possible to retrieve all available providers

typestring

Filters providers by type. Separated by a comma (eg: BANKING,DOCUMENT), many of : BANKING, DOCUMENT

qstring

Filters by queried value in all text fields

interactiveboolean

Filters by provider asking for user input or not

country_codestring

Filters providers by country code (ISO 3166 alpha 3)

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Response

Providers successfully retrieved

namestring required

Name of the provider

branch_namestring

Name of the provider branch

type'BANKING' required

Type of services provided

base_urlstring required

Main page URL for the provider

interactiveboolean required

Whether this provider can ask for a user action

country_codestring

If the provider is specific to a country, will contain the ISO alpha3 country code

idstring required

The unique provider identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.