---
title: "Get all providers"
method: GET
path: "/providers"
---

# Get all providers

`GET /providers`

## Request

- Base URL: `https://api.open-finance.ai/v2`
- URL: `https://api.open-finance.ai/v2/providers`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `read:providers`

## Query parameters

- `includeFakeProviders` boolean

## Response `200`

Response

- Provider[]
  - `providerFriendlyId` string: A unique identifier for the provider
  - `name` string: The bank name
  - `nameNativeLanguage` string: The bank name in it's native language
  - `mode` string: PSD2
  - `site` string: The official website or login URL of the bank
  - `bankCode` integer: The code of the bank
  - `image` string: URL for the provider's logo or image
  - `loginFields` string[]
  - `isFake` boolean: If true, the provider is fake
  - `psd2Uris` object: URIs for various PSD2 services offered by the provider
    - `cardUri` string: The URI for accessing card data
    - `loanUri` string: The URI for accessing loan data
    - `savingsUri` string: The URI for accessing savings data
    - `securitiesUri` string: The URI for accessing securities data
    - `tokenUri` string: The URI for generating tokens
    - `baseUri` string: The base URI for accessing PSD2 services
    - `paymentsUri` string: The URI for accessing payment data
  - `psuIdTypes` object[]: Different types of PSU IDs supported by the provider
    - `name` string: The name of the PSU ID type
    - `nameNativeLanguage` string: The name of the PSU ID type in its native language
    - `id` string: The identifier for the PSU ID type
  - `psuIdDefaultType` string: The default PSU ID type for the provider
  - `psuCorporateIdDefaultType` string: The default PSU CORPORATE ID type for the provider
  - `type` string: The type of the provider, such as 'BANK', 'CARD', or 'INSURANCE'
  - `status` object: The status of different services (consents and payments) offered by the provider
    - `consents` object
      - `enabled` boolean: Indicates if consents are enabled for this provider
    - `payments` object
      - `enabled` boolean: Indicates if payments are enabled for this provider
  - `successRate` object: The success rates for the services provided by the provider
    - `consents` integer: The success rate percentage for consents
    - `payments` integer: The success rate percentage for payments
  - `allowPsuCorporateIdTypeChoice` boolean: Indicates if the provider allows the selection of different PSU corporate ID types
  - `providerForcePaymentService` 'zahav' | 'masav' | 'fp': Does this provider have a forced payment service
  - `psuCorporateIdTypes` object[]: Different types of PSU Corporate IDs supported by the provider
    - `name` string: The name of the PSU Corporate ID type
    - `nameNativeLanguage` string: The name of the PSU Corporate ID type in its native language
    - `id` string: The identifier for the PSU Corporate ID type
  - `sortIndex` number: A numeric value used to sort providers by their order of preference or importance

## Other responses

- `401`: Unauthorized access - Invalid access token
- `403`: Forbidden - Access token missing the required permissions to perform this action
- `404`: Not found - no providers were found or organization not found
- `500`: Internal server error

---

[API](https://skmtc.dev/open-finance/apis/data.md) - [All operations](https://skmtc.dev/open-finance/apis/data/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/data/revisions/c18eafb2a770?raw)