Testing your in-person verification service with the GOV.UK Wallet Sandbox
The GOV.UK Wallet Sandbox lets you create a test digital driving licence and save it to your GOV.UK Wallet test app. You can then present the test digital driving licence to your in-person verification service and confirm it can receive credential information. You can complete this flow on Android and iOS devices.
The GOV.UK Wallet Sandbox contains:
- a document builder that lets you issue a credential offer for a test digital driving licence
- a GOV.UK Wallet test app that lets you store and share a test digital driving licence
- a mock Status List Service that lets you revoke or check the status of your test digital driving licence
- a certificate authority that provides a certificate that authenticates you when connecting to the GOV.UK Wallet test app
You must not use the GOV.UK Wallet Sandbox tools in your production environment or as part of your live deployment process. The tools are limited to validating the integration with your verification service, and can not be used to test all credential types and attributes. You must write and maintain your own test suite in addition to the GOV.UK Wallet Sandbox tools.
Before you use the GOV.UK Wallet Sandbox
To use the GOV.UK Wallet Sandbox, you must:
- complete the enrolment process to become a certified Digital Verification Services (DVS) provider on the register of digital identity and attribute services
- contact the GOV.UK Wallet team to request access to the GOV.UK Wallet Sandbox
- have access to our verifier test tools (for example, TestFlight or Google Play Console) and installed these on your device
- have an integration certificate from the GOV.UK Wallet team - there is guidance on how to send us a certificate signing request (CSR) to get your integration certificate
If you have not completed these steps, speak to your GOV.UK Wallet engagement manager or contact us.
Using the GOV.UK Wallet Sandbox document builder
You can use the document builder to:
You should use the test digital driving licence to validate the end-to-end journey of your verification service.
Issue a new test digital driving licence
Open the sandbox document builder in your web browser.
Select Start now.
Choose Issue a new test digital driving licence and select Continue - the document builder will issue a new credential offer for a test digital driving licence.
You should use this credential offer to add the test digital driving licence to your GOV.UK Wallet test app by:
- choosing Add document if the document builder is on the same smartphone as the GOV.UK Wallet test app
- scanning the QR code using the device with the GOV.UK Wallet test app if the document builder is on a different device
The test digital driving licence will have:
- a unique driving licence number in the format
TST-{TIMESTAMP}, where the timestamp is in epoch milliseconds - a credential issuer of “GDS”
When the test digital driving licence is added to your GOV.UK Wallet test app, you can begin using it to test your verification service.
Revoke a test digital driving licence
Credential issuers can revoke a credential they have issued. Your verification service must recognise when an issuer has revoked a credential and must cancel the verification flow.
The document builder allows you to revoke a test digital driving licence you have previously issued. This helps you test your verification service responds correctly when an issuer revokes a credential.
When you open the GOV.UK Wallet test app, the app will check the status of its credentials and will invalidate any revoked driving licences. This can prevent you from testing your in-person sharing flow with a revoked credential. Before you revoke a credential to test your sharing flow, you should set the device with the GOV.UK Wallet test app to airplane mode.
To revoke a test digital driving licence:
If you plan to test your in-person sharing flow with this revoked credential, set the device with your GOV.UK Wallet test app to airplane mode.
Make a note of the test digital driving licence number you want to revoke.
Access the sandbox document builder.
Choose Revoke an issued test digital driving licence and select Continue.
Enter the test digital driving licence number you want to revoke.
Using the GOV.UK Wallet Sandbox mock Status List Service
You can use the Status List Service to check the status of a real credential. When you are testing your verification service with the GOV.UK Wallet Sandbox, you must use the mock Status List Service to check the status of your test digital driving licence.
The mock Status List Service interacts with the GOV.UK Wallet test app in a similar way to the Status List Service. You should use the mock Status List Service to help you understand how to query the production Status List Service and get an expected result.
Check the status of a test digital driving licence
You can check the status of a test digital driving licence you have issued using the same process as the Status List Service. You must use the following URLs instead of the production Status List Service URLs:
https://status-list-mock.wallet-onboarding.integration.account.gov.uk/.well-known/jwks.jsonhttps://status-list-mock.wallet-onboarding.integration.account.gov.uk/t/{STATUS_LIST_IDENTIFIER}
The value of STATUS_LIST_IDENTIFIER is unique to your test credential.
You must not use the URLs for the production Status List Service, or use live credential status information in your testing environment.
Understand the capabilities of the mock Status List Service
The mock Status List Service has limited functionality compared to the Status List Service.
The mock Status List Service:
- can issue or revoke the status of a test digital driving licence
- issues statuses valid for no longer than 30 days
- covers only a small number of token indices, resulting in a much shorter encoded string than the Status List Service
- supports two statuses per token:
0x00(valid) and0x01(invalid)
The mock Status List Service does not:
- need you to onboard with the Status List Service before you can use it
- include all the security features of the Status List Service
- check if credentials are genuine or trusted - it only decodes them