API keys
There are three different types of API keys:
test
team and guest list
live
When you set up a new service it will start in trial mode. A service in trial mode can create test and team and guest list keys. You must have a live service to create a live key.
To create an API key:
Go to the API integration page.
Select API keys.
Select Create an API key.
Test
Use a test key to test the performance of your service and its integration with GOV.UK Notify.
Messages sent using a test key:
generate realistic responses
result in a delivered status
are not actually delivered to a recipient
do not appear on your dashboard
do not count against your text message and email allowances
To test failure responses with a test key, use the following numbers and addresses:
07700900003
temporary-failure
07700900002
permanent-failure
temporary-failure
permanent-failure
any other valid number or address
delivered
You do not have to revoke test keys.
Team and guest list
A team and guest list key lets you send real messages to your team members and 5 other email addresses or phone numbers while you’re still in trial mode.
You will get an error if you use these keys to send messages to anyone who is not on your team or your guest list.
Messages sent with a team and guest list key appear on your dashboard and count against your text message and email allowances.
You do not have to revoke team and guest list keys.
Live
You can only create live keys once your service is live. You can use live keys to send messages to anyone.
Messages sent with a live key appear on your dashboard and count against your text message and email allowances.
You should revoke and re-create these keys on a regular basis. To revoke a key:
Go to the API integration page.
Select API keys.
Select Revoke for the API key you want to revoke.
You can have more than one active key at a time.
You should never send test messages to invalid numbers or addresses using a live key.
Last updated