Methods

  • get - Look up a specific civil partnership record
  • get - Search for civil partnership records

Resource

{
    "dateOfPartnership": "date",
    "id": "int32",
    "partner1": {
        "address": "string",
        "condition": "string",
        "dateOfBirth": "date",
        "forenames": "string",
        "occupation": "string",
        "retired": "boolean",
        "sex": "string",
        "signature": "string",
        "surname": "string"
    },
    "partner2": {
        "address": "string",
        "condition": "string",
        "dateOfBirth": "date",
        "forenames": "string",
        "occupation": "string",
        "retired": "boolean",
        "sex": "string",
        "signature": "string",
        "surname": "string"
    },
    "status": {
        "blocked": "boolean"
    }
}

Properties

Name Type Description Additional
dateOfPartnership date

Date of the civil partnership

id int32

System number for this event

partner1 object

The first partner

partner1.address string

The person's address

Optional
partner1.condition string

Whether the person was single, divorced, widowed etc.

partner1.dateOfBirth date

Date the person was born

Optional
partner1.forenames string

Forenames of the person

partner1.occupation string

The occupation of the person

Optional
partner1.retired boolean

Whether the person was retired

Optional
partner1.sex string

Sex of the person

Possible values are:

  • Male
  • Female
  • Indeterminate
Optional
partner1.signature string

A digital representation of the person's signature

Optional
partner1.surname string

Surname of the person

partner2 object

The second partner

partner2.address string

The person's address

Optional
partner2.condition string

Whether the person was single, divorced, widowed etc.

partner2.dateOfBirth date

Date the person was born

Optional
partner2.forenames string

Forenames of the person

partner2.occupation string

The occupation of the person

Optional
partner2.retired boolean

Whether the person was retired

Optional
partner2.sex string

Sex of the person

Possible values are:

  • Male
  • Female
  • Indeterminate
Optional
partner2.signature string

A digital representation of the person's signature

Optional
partner2.surname string

Surname of the person

status object

Status flags associated with this record

status.blocked boolean

Indicates if data for this record has been blocked