Owner Check

    Confirm whether a person or company is the current registered owner of a vehicle in the New Zealand Motor Vehicle Register.

    Notes and Prerequisites

    • All requests use GET parameters
    • We support XML format (default) and JSON formats
    • Each successful call is charged at the owner_check API product price

    API URL

    Production: https://www.carjam.co.nz/api/owner-check/

    Test: https://test.carjam.co.nz/api/owner-check/

    Input

    Common:

    • key — your API Key
    • f — response format (xml or json)
    • type — one of person_names, person_dl, company
    • plate — vehicle plate or VIN
    • charges — if 1, includes the charged amount in the response

    Per type:

    • type=person_names — check by person's name and optional date of birth
      • last_name — required
      • first_name — required if dob not supplied
      • dob — required if first_name not supplied (UNIX timestamp or anything strtotime() accepts; not older than 200 years)
    • type=person_dl — check by NZ driver licence number
      • driver_licence — required
    • type=company — check by company name
      • company_name — required

    Output

    <message>
        <owner_check>
            <ref>OC1A2B3C4D</ref>
            <type>person_names</type>
            <plate>NSN5OO</plate>
            <match>1</match>
        </owner_check>
    </message>

    match is 1 when the supplied details match the current registered person in the NZ Motor Vehicle Register, 0 otherwise.

    JSON example (f=json):

    {
        "owner_check": {
            "ref": "OC1A2B3C4D",
            "type": "person_names",
            "plate": "NSN5OO",
            "match": 1
        }
    }

    Errors

    • err-api-product-not-allowed — subscribe to the owner_check API product at /me/developer:api_products
    • err-owner-check-validation — one or more inputs failed validation (missing or unrecognised type, missing plate, missing per-type fields, invalid dob). The message field describes the specific issue(s).

    XML example (missing API product subscription):

    <error>
        <code>-1</code>
        <scode>err-api-product-not-allowed</scode>
        <message>Missing API product(s) - 'owner_check'. Add them at https://www.carjam.co.nz/me/developer:api_products or Please contact [email protected]</message>
        <class>apperror</class>
    </error>

    JSON example (f=json, validation error when type is missing):

    {
        "code": -1,
        "scode": "err-owner-check-validation",
        "message": "Please select the check type",
        "class": "apperror"
    }