PHPackages cyborgfinance/fcaregisterlaravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. cyborgfinance/fcaregisterlaravel ActiveLibrary[API Development](/categories/api) cyborgfinance/fcaregisterlaravel ================================ Financial Conduct Authority (FCA) API Client Library for Laravel. 1.0.4(9mo ago)63.4k2MITPHP Since Apr 10Pushed 9mo ago1 watchersCompare [ Source](https://github.com/CyborgFinance/FCARegisterLaravel)[ Packagist](https://packagist.org/packages/cyborgfinance/fcaregisterlaravel)[ Docs](https://github.com/cyborgfinance/fcaregisterlaravel)[ GitHub Sponsors](https://github.com/CyborgFinance)[ RSS](/packages/cyborgfinance-fcaregisterlaravel/feed)WikiDiscussions main Synced yesterday READMEChangelog (3)Dependencies (9)Versions (4)Used By (0) Financial Conduct Authority (FCA) API Client Library wrapper for Laravel. ========================================================================= [](#financial-conduct-authority-fca-api-client-library-wrapper-for-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/bb61df3809e06e5071e6dfa7332e3b2d253552ce176c3ddb1388a360a51d6eb3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6379626f726766696e616e63652f66636172656769737465726c61726176656c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/cyborgfinance/fcaregisterlaravel)[![Total Downloads](https://camo.githubusercontent.com/dfa031a114c133f56631aad6cff6a003a82f542d8313bc5354e8fea385257768/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6379626f726766696e616e63652f66636172656769737465726c61726176656c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/cyborgfinance/fcaregisterlaravel) Financial Conduct Authority (FCA) API Client Library wrapper for Laravel. The Financial Services Register ------------------------------- [](#the-financial-services-register) The online Financial Services Register (FS Register) is a public record of financial services firms, individuals and other bodies regulated by the FCA. The online FS Register provides an online search for firms that are or have been regulated by the FCA. It also allows users to search for businesses that are or have been registered with the FCA under the FSMA, the Money Laundering Regulations 2007, the Payment Services Regulations 2009, and the Electronic Money Regulations 2011. Access to the online FS Register is free; it is suitable for ad-hoc searches for authorised and registered firms and individuals. ### The Financial Services Register API Service [](#the-financial-services-register-api-service) The FCA API is a new service offered by the Financial Conduct Authority, its in early stages with limited data points. You will first need to [Register an Account](https://register.fca.org.uk/Developer/s/) to get an API Key. It is a RESTful API based on HTTPS requests and JSON responses, requiring an API username and key for authentication. The FS Register API currently sets a maximum limit of 10 requests per 10 seconds, which is periodically subject to change. The FCA offers support for use of the API at `RegisterAPISupport@fca.org.uk` they will not provide support for use of this 3rd party package. Installation ------------ [](#installation) This a a Laravel wrapper for the FCA API, you will need a Laravel application to use this package. ### 1 - Install the Package [](#1---install-the-package) You can install the package via composer: ``` composer require cyborgfinance/fcaregisterlaravel ``` Add the following to your Environment File: ### 2 - Add FCA API Credentials to your .env file [](#2---add-fca-api-credentials-to-your-env-file) ``` FCA_EMAIL="your@email.com" FCA_KEY="YOUR_FCA_API_KEY" ``` ### 3 - (optional) Publish the config file [](#3---optional-publish-the-config-file) ``` php artisan fcaapi:install ``` This is the contents of the published config file: ``` return [ 'email' => env('FCA_EMAIL', 'your@email.com'), // FCA API Email Address 'key' => env('FCA_KEY', 'YOUR_FCA_API_KEY'), // FCA API KEY 'api_version' => '0.1', // FCA API VERSION 'api_url' => 'https://register.fca.org.uk/services/', // FCA API URL 'api_timeout' => 5, // FCA API TIMEOUT in seconds ]; ``` Usage ----- [](#usage) ``` namespace App\Http\Controllers; use Cyborgfinance\Fcaregisterlaravel\Fcaapi; class Testing extends Controller { public function __invoke(Request $request){ $fcaFrnNumber = 919921; //FCA Firm Reference Number (FRN) $fcaApi = new Fcaapi(); $result = $fcaApi->firmDetails($fcaFrnNumber)->json(); //Queries FCA Register dd($result); // Outputs Array } } ``` or ``` namespace App\Http\Controllers; use Cyborgfinance\Fcaregisterlaravel\Fcaapi; class Testing extends Controller { public function __invoke(Request $request){ $fcaFrnNumber = 919921; //FCA Firm Reference Number (FRN) $result = Fcaapi::firmDetails($fcaFrnNumber)->json(); //Queries FCA Register dd($result); // Outputs Array } } ``` Both of these examples will output: ``` array:4 [▼ "Status" => "FSR-API-02-01-00" "ResultInfo" => array:3 [▼ "page" => "1" "per_page" => "1" "total_count" => "1" ] "Message" => "Ok. Firm Found" "Data" => array:1 [▼ 0 => array:21 [▼ "Name" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Names" "Individuals" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Individuals" "Requirements" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Requirements" "Permission" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Permissions" "Passport" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Passports" "Regulators" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Regulators" "Appointed Representative" => "https://register.fca.org.uk/services/V0.1/Firm/919921/AR" "Address" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Address" "Waivers" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Waivers" "Exclusions" => "https://register.fca.org.uk/services/V0.1/Firm/919921/Exclusions" "DisciplinaryHistory" => "https://register.fca.org.uk/services/V0.1/Firm/919921/DisciplinaryHistory" "System Timestamp" => "10/04/2021 15:49" "Exceptional Info Title" => "" "Exceptional Info Body" => "" "Status Effective Date" => "24/04/2020" "PSD Agent Status" => "" "PSD / EMD Status" => "" "Status" => "Authorised" "Business Type" => "Regulated" "Organisation Name" => "CYBORG FINANCE LIMITED" "FRN" => "919921" ] ] ] ``` FCA Register Lookup Methods --------------------------- [](#fca-register-lookup-methods) ### Company Records [](#company-records) ``` //Get information about a specific firm using its Firm Reference Number $request = Fcaapi::firmDetails($fcaFrnNumber); ``` ``` //Get information about the Individuals associated with a firm using its Firm Reference Number $request = Fcaapi::firmIndividuals($fcaFrnNumber); ``` ``` //Get information about the other names used by the firms using its Firm Reference Number $request = Fcaapi::firmName($fcaFrnNumber); ``` ``` //Get information about the requirements associated with a specific firm using its Firm Reference Number $request = Fcaapi::firmRequirements($fcaFrnNumber); ``` ``` //Get information about the activities and permissions associated with a specific firm using its Firm Reference Number $request = Fcaapi::firmPermissions($fcaFrnNumber); ``` ``` //Get information about a passport details by using its Firm Reference Number $request = Fcaapi::firmPassports($fcaFrnNumber); ``` ``` //Get information about a passport permission by using its Firm Reference Number and Country $request = Fcaapi::firmPassportCountry($fcaFrnNumber, $country); ``` ``` //Get information about a regulator on a firm using its Firm Reference Number $request = Fcaapi::firmRegulators($fcaFrnNumber); ``` ``` //Get information about the Appointed Representatives associated with a firm using its Firm Reference Number $request = Fcaapi::firmAppointedRepresentatives($fcaFrnNumber); ``` ``` //Get information about a specific firm using its Firm Reference Number $request = Fcaapi::firmAddress($fcaFrnNumber); ``` ``` //Get information about a Waiver on a firm using it's Firm Reference Number $request = Fcaapi::firmWaivers($fcaFrnNumber); ``` ``` //Get information about an Exclusion on a firm using it's Firm Reference Number $request = Fcaapi::firmExclusions($fcaFrnNumber); ``` ``` //Get information about a DisciplinaryHistory on a firm using it's Firm Reference Number $request = Fcaapi::firmDisciplinaryHistory($fcaFrnNumber); ``` Individual Records ------------------ [](#individual-records) ``` //Get information about the Individuals associated with its Individual Reference Number $request = Fcaapi::individualDetails($fcaIrnNumber); ``` ``` //Get information about all the firms, the Individual has a control function using their Individual Reference Number $request = Fcaapi::individualFunctions($fcaIrnNumber); ``` ### Search Records [](#search-records) ``` //Search the FS register using this API $request = Fcaapi::search($search); ``` ``` //Search the FS register using this API $request = Fcaapi::searchRm(); ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - Cyborg Finance [GitHub](https://github.com/CyborgFinance), [Website](https://cyborg.finance) & [Twitter](https://twitter.com/cyborgfinance) - Adam Hosker [GitHub](https://github.com/ahosker), [Website](https://hosker.info) & [Twitter](https://twitter.com/adam_hosker) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. Testing ------- [](#testing) ### Unit Tests [](#unit-tests) ``` composer test ``` ### Live Tests [](#live-tests) The package includes a comprehensive live test suite to verify real API integration: **Setup:** 1. Get FCA API credentials from 2. Add to your `.env` file: ``` FCA_EMAIL=your-email@example.com FCA_KEY=your-fca-api-key ``` **Run live tests:** ``` # Using Pest with groups ./vendor/bin/pest --group=live # Run specific live test file ./vendor/bin/pest tests/Feature/Live/FcaApiLiveTest.php ``` TODO ---- [](#todo) Name - Service provider uses 'fcaapi' but package name is 'fcaregisterlaravel' ------------------------------------------------------------------------------ [](#name----service-provider-uses-fcaapi-but-package-name-is-fcaregisterlaravel) 1. Full Test Coverage 2. Update package name in service provider to match composer.json 3. Rename config file from fcaapi.php to fcaregisterlaravel.php 4. Update all config references throughout codebase 5. Add tests for package discovery and installation 6. Test config file publishing 7. Verify all Laravel package tool features work correctly ### Health Score 40 — FairBetter than 86% of packages Maintenance57 Moderate activity, may be stable Popularity27 Limited adoption so far Community9 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~812 days Total 3 Last Release 287d ago PHP version history (2 changes)1.0.2PHP ^7.0 1.0.3PHP ^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/f7eaa8bd833253eb1afa55e0874940f101f70e30bcfb0ce1c51c31dbcd425e94?d=identicon)[ahosker](/maintainers/ahosker) --- Top Contributors [![ahosker](https://avatars.githubusercontent.com/u/346166?v=4)](https://github.com/ahosker "ahosker (33 commits)") --- Tags api-serviceapi-wrapperfcalaravellaravel-packagelaravellaravel-packageCyborgFinancefcaregisterlaravelFCAFCA REGISTERCyborg Finance ### Code Quality TestsPest Static AnalysisPHPStan, Rector Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/cyborgfinance-fcaregisterlaravel/health.svg) ``` [![Health](https://phpackages.com/badges/cyborgfinance-fcaregisterlaravel/health.svg)](https://phpackages.com/packages/cyborgfinance-fcaregisterlaravel) ``` ### Alternatives [dedoc/scramble Automatic generation of API documentation for Laravel applications. 2.1k11.2M102](/packages/dedoc-scramble)[defstudio/telegraph A laravel facade to interact with Telegram Bots 816333.9k3](/packages/defstudio-telegraph)[simplestats-io/laravel-client Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof. 5022.0k](/packages/simplestats-io-laravel-client)[lettermint/lettermint-laravel Official Lettermint driver for Laravel 1190.2k1](/packages/lettermint-lettermint-laravel)[rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3914.6k](/packages/rawilk-profile-filament-plugin)[codebar-ag/laravel-docuware DocuWare integration with Laravel 1123.7k](/packages/codebar-ag-laravel-docuware) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)