---
title: "Predict-match a Address record"
method: POST
path: "/resource/Address/PREDICT"
tags: ["Address"]
---

# Predict-match a Address record

`POST /resource/Address/PREDICT`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api/v1`
- URL: `https://your-subdomain.deputy.deputy.com/api/v1/resource/Address/PREDICT`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://once.deputy.com/my/oauth/login`
    - Token URL: `https://once.deputy.com/my/oauth/access_token`

Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.

## Request body

- Address
  - `Id` integer, required
  - `ContactName` string
  - `UnitNo` string
  - `StreetNo` string
  - `SuiteNo` string
  - `PoBox` string
  - `Street1` string
  - `Street2` string
  - `City` string
  - `State` string
  - `Postcode` string
  - `Country` integer
  - `Phone` string
  - `Notes` string
  - `Format` integer
  - `Saved` boolean
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `Verified` string

## Response `200`

Success

- Address
  - `Id` integer, required
  - `ContactName` string
  - `UnitNo` string
  - `StreetNo` string
  - `SuiteNo` string
  - `PoBox` string
  - `Street1` string
  - `Street2` string
  - `City` string
  - `State` string
  - `Postcode` string
  - `Country` integer
  - `Phone` string
  - `Notes` string
  - `Format` integer
  - `Saved` boolean
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `Verified` string

## Other responses

- `400`: Bad request
- `401`: Authentication required or invalid token
- `403`: Forbidden — token lacks access to this resource
- `404`: Resource not found

---

[API](https://skmtc.dev/deputy/apis/deputy-v1-resource-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/revisions/5d8e44000786?raw)