Search for civil partnership records
Search for civil partnership records by supplying the date of the civil partnership as well as the surname and at least the first forename of one of the partners. (UNSTABLE: This endpoint is subject to change.)
Request
GET https://api.qa.notprod.lev.homeoffice.gov.uk/v1/registration/partnership
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| forenames | string | The person's forenames. The first name must be provided but middlenames are optional. |
Required |
| surname | string | The person's surname. |
Required |
| dateOfPartnership | date | The date of the civil partnership in international format. |
Required |
Authorisation
This request requires the use of one of following authorisation methods:
OAuth2.
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK successful operation |
Civil partnership record (v1) |
| default | Bad request |
Error |