--- title: "Retrieve Provider" method: GET path: "/plug/providers/{providerId}" tags: ["Providers"] --- # Retrieve Provider `GET /plug/providers/{providerId}` Retrieve a single Provider. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). ## Path parameters - `providerId` string, required ## Headers - `Arcadia-Version` string, required ## Response `200` OK - PublicPlugProviderResource — An array of unique identifiers of the utility service provider - `country` 'AFG' | 'ALA' | 'ALB' | 'DZA' | 'ASM' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BMU' | 'BTN' | 'BOL' | 'BES' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'VGB' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COG' | 'COD' | 'COK' | 'CRI' | 'CIV' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'ETH' | 'FLK' | 'FRO' | 'FSM' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'VAT' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRN' | 'IRQ' | 'IRL' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MAC' | 'MKD' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'PRK' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'KOR' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWZ' | 'SWE' | 'CHE' | 'SYR' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TCA' | 'TUV' | 'VIR' | 'UGA' | 'UKR' | 'ARE' | 'GBR' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VUT' | 'VEN' | 'VNM' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE', required — The country associated with the billing address. - `id` string, required — A unique identifier for the entity. - `intervals` PlugIntervalProviderSupportResource, required — Detailed information about the provider's interval support. - `isHistorySupported` boolean, required — Indicates whether the provider supports historical interval data extraction. - `isInstantIntervalsSupported` boolean, required — Indicates whether the provider supports instant interval extraction. - `isSupported` boolean, required — Indicates whether the provider supports interval data extraction. - `serviceTypes` string[], required — An array of service types from the provider that are supported. - `isHistorySupported` boolean, required — Indicates whether the provider supports historical data at the account level. - `isInstantIntervalsSupported` boolean, required — Indicates whether the provider supports Instant Intervals. - `isIntervalsThirdPartyPortalSupported` boolean, required — Indicates whether the provider supports integration with third-party portals or platforms for interval data. - `isMultiFactorAuthenticationSupported` boolean, required — This field indicates whether Arcadia is able to support MFA for the provider. It does not indicate whether the provider requires MFA. This field is deprecated in favor of multiFactorAuthentication.isSupported. - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports Real-Time Credential Validation. - `isThirdPartyPortalSupported` boolean, required — Indicates whether the provider supports integration with third-party portals or platforms. - `multiFactorAuthentication` PlugMultiFactorAuthenticationSupportResource, required — Detailed information about the provider's MFA support. - `isGuestAccessSupported` boolean, required — Indicates whether the provider supports guest access configuration. This field is currently in beta. - `isOptOutSupported` boolean, required — Indicates whether Arcadia is able to support opting out of MFA for the provider. This field is currently in beta. - `isSupported` boolean, required — This field indicates whether Arcadia is able to support MFA for the provider. It does not indicate whether the provider requires MFA. - `request` 'ONE_TIME' | 'RECURRING', nullable, required — The type of MFA request this provider supports. - `type` 'MANDATORY' | 'OPTIONAL', nullable, required — The type of MFA this provider supports. - `name` string, required — The name of the utility service provider. - `region` 'AFRICA' | 'ASIA' | 'EUROPE' | 'CARIBBEAN' | 'CENTRAL_AMERICA' | 'NORTH_AMERICA' | 'OCEANIA' | 'SOUTH_AMERICA', required — The region associated with the provider. - `requiredFieldMetadata` PlugTemplateInputMetadata[], required — Detailed information about the required input fields for this provider. - `fieldLabel` string — This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the label you should use for the input field. - `fieldLength` integer — This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the length of the input field. You can use this to build input validations. - `fieldName` string — This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the name that corresponds to the field you would use when submitting a credential to the API (e.g. username, username2, etc.). - `fieldNumber` integer — This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for indicating the order that login inputs appear on the page. - `fieldPart` integer — This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for handling input fields when they are are split by dashes or other symbols, indicating with part this input corresponds to. - `requiredFields` string[], required — The inputs needed to submit a request for this provider. - `serviceTypes` string[], required — An array of all type of service supported, such as electricity, water, or gas. - `statements` PlugStatementProviderSupportResource, required — Detailed information about the provider's statements support. - `isHistorySupported` boolean, required — Indicates whether the provider supports historical statement data extraction. - `isSupported` boolean, required — Indicates whether the provider supports statement data extraction. - `isWebNavigationSupported` boolean, required — Indicates whether the provider supports web navigation. - `serviceTypes` string[], required — An array of service types from the Provider that are supported. - `website` string, required — The website for the provider. --- [API](https://skmtc.net/arcadia/apis/plug-api.md) · [All operations](https://skmtc.net/arcadia/apis/plug-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arcadia/plug-api/revisions/d00587742116/schema)