- How do I install jamesforsyth/laravel-uk-kyb-edge in a Laravel app?
- Install the package via Composer, configure your UK Companies House credentials and base URL, then register the UKBusiness Facade alias. The package follows standard Laravel service-container and Guzzle patterns, so it fits existing Laravel applications already using Guzzle. Before production, confirm the supported Laravel, PHP, and Guzzle versions and whether config publishing is required.
- Which Laravel and PHP versions does laravel-uk-kyb-edge support?
- The provided evaluation does not confirm the exact Laravel, PHP, or Guzzle version constraints for v1.1.0. Check the package composer.json, release notes, and Facade method signatures before upgrading an existing application. Run contract tests against pinned dependency versions to confirm compatibility in your environment.
- How do I configure UK Companies House credentials for laravel-uk-kyb-edge?
- Configure credentials and the base URL through the package configuration, then register the Facade in your Laravel application. Use environment-specific values and keep secrets out of source control. Confirm whether configuration publishing is supported and whether document streaming or CORS defaults need to be overridden.
- What can I use laravel-uk-kyb-edge for in a KYB workflow?
- The package supports UK business registry access, address sanitization, geocoding, director KYB, document retrieval, and financial document intelligence. It is suitable for internal tools, admin dashboards, onboarding and KYB workflows, and due-diligence prototypes. Treat financial extraction as an accelerator rather than an authoritative financial-data source until accuracy and auditability are proven.
- How does UKBusiness::financials() work and what are its limitations?
- financials($documentId) converts balance-sheet PDFs into structured JSON, likely through an external vision or OCR provider. It depends on document availability, PDF quality, provider behavior, and schema stability. Ask whether confidence and error details are returned, and document and version the JSON schema before downstream workflows depend on it.
- What does UKBusiness::document() return and how should I handle streamed PDFs?
- document($documentId) is a streaming proxy for official registry PDFs, useful for controlled document access and browser-based preview. Ensure the implementation avoids loading large PDFs into memory and protects registry access with authentication and rate limits. Confirm whether it returns a streamed response or a PSR-7 response before integrating it into your application.
- Are CORS headers configurable in laravel-uk-kyb-edge, and is wildcard CORS safe?
- The evaluation flags full CORS headers as a risk unless they are configurable and scoped, because wildcard CORS on streamed official documents can expose documents to unintended browser origins. Check whether CORS can be disabled globally or per route and whether it defaults to *. Prefer server-side authorization and rate limits over CORS for controlling document access.
- How should I test laravel-uk-kyb-edge for malformed PDFs, timeouts, and schema drift?
- Start with a bounded proof of concept using known registry documents and a small set of manually verified balance sheets. Add tests for malformed PDFs, upstream timeouts, retry behavior, and JSON schema changes. Compare extracted JSON to source PDFs and define an internal schema adapter before any UI or downstream workflow depends on package output.
- What are the production risks of using laravel-uk-kyb-edge for financial data?
- The main risks include extraction accuracy, undocumented JSON schema changes, upstream rate limits and costs, PDF streaming behavior, and potential PII or financial data leakage to third-party vision providers. Confirm the OCR provider data-retention and residency terms, confidence scoring, error types, and timeout defaults. Position the package as an internal-workflow accelerator until extraction accuracy and auditability are proven.
- Is jamesforsyth/laravel-uk-kyb-edge maintained, and what alternatives should I consider?
- The assessment provides no long-term maintenance history, so review release notes, issue activity, and SemVer discipline for v1.1.0. Consider wrapping the Facade in an application-owned adapter so you can swap providers or direct Companies House integration later. Alternatives may include direct registry API clients, dedicated KYB vendors, or internal document-extraction services, depending on compliance and audit requirements.