Skip to content

Create property

Request

Create a new property record from a mailing address. Properties created directly via this endpoint can later be referenced by property_id when creating an order, instead of supplying the address inline again.

Address-based deduplication

Properties are deduplicated by address within your organization. If you submit an address that already matches an existing property, that existing property is returned and no new record is created — making this endpoint safely idempotent for repeated submissions of the same address.

Address matching is case- and whitespace-insensitive across street, unit, city, and state. A unit value matches with or without a leading # ("4B" and "#4B" are equivalent). A 5-digit zipcode matches its ZIP+4 form (94111 is equivalent to 94111-1234).

Abbreviations are treated literally — "123 Main St" and "123 Main Street" are different addresses.

The response status indicates which path was taken:

  • 201 Created — a new property was created
  • 200 OK — the address matched an existing property; that record is returned

The Location response header always points to the canonical property URL.

Security
bearer-token
Headers
Checkr-Tenant-Versionstring

CalVer-dated API version to pin behavior to (e.g. 2026-04-29). When omitted, the request is served by the newest supported version. Unknown values return 422.

Value:"2026-04-29"
Bodyapplication/jsonrequired

The request body for creating a new property.

propertyobject(property-address)required

Address of the rental property.

POST
/properties
curl -i -X POST \
  https://tenant.checkr.com/api/properties \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Checkr-Tenant-Version: 2026-04-29' \
  -H 'Content-Type: application/json' \
  -d '{
    "property": {
      "name": "Sunset Apartments",
      "street": "1234 Market St",
      "unit": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94103"
    }
  }'

Responses

OK — the address matched an existing property in your organization; the existing record is returned and no new property was created.

Headers
Locationstring

URL of the existing property.

Bodyapplication/json
idstring

Unique identifier for the property record. Use this value in subsequent API calls; it is stable for the lifetime of the property. Test-mode IDs carry a _test_ infix (e.g. pr_test_K9dM2pXqR4vN8tLZbWyHJa); live-mode IDs have no infix.

Example:"pr_K9dM2pXqR4vN8tLZbWyHJa"
namestring or null

Optional human-readable label for the property (e.g. a building or unit nickname). When set, it is shown to applicants and used in email/SMS communications in addition to the property address.

Example:"Sunset Apartments"
streetstring

Street line of the property address (number and street name).

Example:"1234 Market St"
unitstring or null

Optional unit, suite, or apartment designator within the building.

Example:"Apt 4B"
citystring

City the property is located in.

Example:"San Francisco"
statestring

Two-letter USPS state or territory code (uppercase).

Example:"CA"
zipcodestring

5-digit US ZIP code or ZIP+4.

Example:"94103"
created_atstring, (date-time)

Timestamp the property record was created.

Response
{
  "id": "pr_K9dM2pXqR4vN8tLZbWyHJa",
  "name": "Sunset Apartments",
  "street": "1234 Market St",
  "unit": "Apt 4B",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94103",
  "created_at": "2019-08-24T14:15:22Z"
}