# Check ownership

Check and verify ownership of an individual or organisation against property records

Endpoint: POST /ownership-check
Version: v1
Security: oauth2ClientCredentials

## Header parameters:

  - `x-correlation-id` (string)
    A unique transaction id used to correlate api requests end to end.

  - `x-source-system` (string)
    A unique identification string for the source system.

## Request fields (application/json):

  - `identifier` (object, required)
    The distinguishing marker for various request types. Must be only 1 from the list.
    Example: {"propertyAddress":{"unitFlatNumber":"7273","streetNumber":"788","streetName":"Park Street","streetType":"Avenue","streetSuffix":"AV","suburbTownLocality":"Pakenham","postcode":3810}}

  - `searchNames` (array, required)
    The names to be checked against the proprietor name(s) against a Title.
    Example: [{"searchNameId":1,"individual":{"surname":"Dawson","givenNames":"James"}}]

## Response 200 fields (application/json):

  - `applicantsMatchResults` (array, required)
    Container for all supplied Applicants' matching results.
    Example: [{"searchNameId":1,"individual":{"surname":"Dawson","givenNames":"James","individualMatchType":"FullName","individualMatchResult":"Exact"},"organisation":{"orgName":"ABC Pty","organisationMatchResult":"Exact"}}]

  - `proprietorCompleteness` (string)
    Supplied the completeness of proprietor
    Enum: "Y", "N"

  - `moreThanOneTitle` (string)
    Are there more than one title for the given identifier?
    Enum: "Y", "N"

## Response 400 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"

## Response 401 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"

## Response 403 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"

## Response 404 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"

## Response 500 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"