A ReSTful API for verifying 'life events' such as births, deaths and marriages.
To get started using the API we recommend first experimenting with the mock API. All the methods described here can be called without the need to first be on-boarded.
In order for you to use the LEV API your department will need to have an agreement with us (HMPO). Provided you have that you will be able to follow the technical steps to on-board and authenticate with the service.
Look up and search for birth records. Individual birth records can be looked up using the systemNumber
printed in the bottom-left of the birth certificate. Alternatively, it is possible to search for birth records by supplying the date of birth, surname and at least the first forename of the child.
Operation | HTTP Request | Description |
---|---|---|
get |
GET /api/v0/events/birth |
Search for birth records |
get |
GET /v1/registration/birth/{id} |
Look up a specific birth record |
get |
GET /v1/registration/birth |
Search for birth records |
get |
GET /api/v0/events/birth/{systemNumber} |
Look up a specific birth record |
Operation | HTTP Request | Description |
---|---|---|
get |
GET /v1/registration/death |
Search for death records |
get |
GET /v1/registration/death/{id} |
Look up a specific death record |
Operation | HTTP Request | Description |
---|---|---|
get |
GET /v1/registration/marriage/{id} |
Look up a specific marriage record |
get |
GET /v1/registration/marriage |
Search for marriage records |