Companies House Emergency Auth Code Web Service
The Companies House Web Service for requesting auth codes. This application is written using the Spring Boot Java framework.
- Retrieves company information after using company lookup service.
- Displays selectable officers that can be chosen to receive an emergency auth code.
Requirements
In order to run this Web app locally you will need to install:
Getting Started
- Configure your service if you want to override any of the defaults.
- Run
make
- Run
./start.sh
Configuration
Key | Description |
---|---|
EMERGENCY_AUTH_CODE_WEB_PORT |
The port of the emergency auth code web service |
HUMAN_LOG |
For human readable logs |
Web Pages
Page | Address |
---|---|
Request an authentication code to be sent to a home address | /auth-code-requests/start |
Confirm this is the correct company | /auth-code-requests/company/{companyNumber}/confirm |
Select an officer | /auth-code-requests/requests/{requestId}/officers |
Confirm this is the correct officer | /auth-code-requests/requests/{requestId}/confirm-officer |
Confirmation page | /auth-code-requests/requests/{requestId}/confirmation |