Look up individual civil partnership records using the systemNumber printed in the bottom-left of the civil partnership certificate. (UNSTABLE: This endpoint is subject to change.)

Request

GET https://api.uat.notprod.lev.homeoffice.gov.uk/v1/registration/partnership/{id}

Path parameters

Parameter name Value Description Additional
id integer

The system number printed in the bottom-left of the civil partnership certificate

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)
404 Not Found

Resource not found

Error
default

Bad request

Error

Explore this API

id

The system number printed in the bottom-left of the civil partnership certificate

Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!