Skip to content
Verify API/
/
Check ownership

SERV Verify EAPI (v1)

SERV Verify Experience API

Exposes functionality relating to checking particular data elements against the Registries.

  • Check and verify ownership of an individual or organisation
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.servictoria.io/_mock/portal/rest/serv-verify-api/openapi
Production
https://api.servictoria.io/vicland/verify/v1
UAT
https://test.api.servictoria.io/vicland/verify/v1

Check ownership

Request

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

Security
oauth2ClientCredentials
Headers
x-correlation-idstring

A unique transaction id used to correlate api requests end to end.

x-source-systemstring

A unique identification string for the source system.

Bodyapplication/jsonrequired
identifierobjectrequired

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}}
identifier.​property name*anyadditional property
searchNamesArray of objectsrequired

The names to be checked against the proprietor name(s) against a Title.

Example: [{"searchNameId":1,"individual":{"surname":"Dawson","givenNames":"James"}}]
searchNames[].​property name*anyadditional property
curl -i -X POST \
  https://developer.servictoria.io/_mock/portal/rest/serv-verify-api/openapi/ownership-check \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-correlation-id: string' \
  -H 'x-source-system: string' \
  -d '{
    "identifier": {
      "propertyAddress": {
        "unitFlatNumber": "7273",
        "streetNumber": "788",
        "streetName": "Park Street",
        "streetType": "Avenue",
        "streetSuffix": "AV",
        "suburbTownLocality": "Pakenham",
        "postcode": 3810
      }
    },
    "searchNames": [
      {
        "searchNameId": 1,
        "individual": {
          "surname": "Dawson",
          "givenNames": "James"
        }
      }
    ]
  }'

Responses

Successful response

Bodyapplication/json
applicantsMatchResultsArray of objectsrequired

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"}}]
applicantsMatchResults[].​property name*anyadditional property
proprietorCompletenessstring

Supplied the completeness of proprietor

Enum"Y""N"
Example: "Y"
moreThanOneTitlestring

Are there more than one title for the given identifier?

Enum"Y""N"
Example: "N"
Response
application/json
{
  "applicantsMatchResults": [
    { … }
  ],
  "proprietorCompleteness": "Y",
  "moreThanOneTitle": "N"
}

Health Check

Request

Health check endpoint for the API

Security
oauth2ClientCredentials
Headers
x-correlation-idstring

A unique transaction id used to correlate api requests end to end.

x-source-systemstring

A unique identification string for the source system.

curl -i -X GET \
  https://developer.servictoria.io/_mock/portal/rest/serv-verify-api/openapi/health \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-correlation-id: string' \
  -H 'x-source-system: string'

Responses

OK

Bodyapplication/json
applicationNamestringrequired

Application Name

Example: "SERV Verify EAPI"
applicationVersionstringrequired

Application Version

Example: "1.0.0"
apiNamestringrequired

API Name

Example: "serv-verify-eapi"
environmentstringrequired

Environment

Example: "PROD"
statusstringrequired

Status

Example: "running"
Response
application/json
{
  "applicationName": "SERV Verify EAPI",
  "applicationVersion": "1.0.0",
  "apiName": "serv-verify-eapi",
  "environment": "PROD",
  "status": "running"
}