The Confirmed API

GET /properties

List properties

#op-listproperties

Requires an API key carrying the scope read:properties.

Parameters

Responses

Response schema 200 application/json

• data array required

  An array of:

  • id integer required

    Stable Confirmed property identifier. Use it as the path parameter everywhere.

    Example: 1042

  • name string required

    The display name, with the "Portfolio Dashboard – " prefix removed and HTML entities decoded, matching what the customer sees in their portal. Falls back to "#<id>" if the record has no usable title.

    Example: 1600 Market Street

  • address string | null required

    One unstructured string, exactly as stored, or null. There are no city / state / postal-code fields on a property and none are derived — see the six-things section in the API description.

    Example: 1600 Market St, Philadelphia, PA 19103

  • square_footage integer | null required

    null rather than 0 when unrecorded or unparseable. A square footage of zero is a claim, and a false one.

    Example: 329350

  • company string | null required

    Example: XR Advisors

  • compliance object required

    A property's compliance headline.

    • score number | null required

      A 0–1 fraction, rounded to 4 decimal places. The Confirmed portal shows this same number as a percentage — 0.8571 here is 85.71% there. null when the property has no score; never a substituted number.

      Documents that are expiring soon earn no credit: the score is (green + repaired) / total, so a property whose only document is expiring soon scores 0. That is the portal's behaviour and is reproduced here on purpose so the two never disagree.

      Example: 0.8571

    • risk_band string | null required

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

      One of: low, moderate, elevated, severe, null

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

  • primary_contact object required

    The property's primary contact. Only an email address is exposed — there is no name or phone field on this object, because there is no reliable backing value for either.

    • email string | null required
  • updated_at string | null required

    When the property record last changed, UTC. Compare against updated_since.

    Example: 2026-08-17T14:02:11Z

  • building_addresses array

    Per-building addresses, for multi-building properties. The key is absent entirely when the property has no list — it is never an empty array, because an empty array would read as 'we checked and there are none'.

    An array of:

    • label string | null required

      Example: Tower A

    • address string | null required

      Example: 1600 Market St

• meta object required

  Present on collection responses only.

  • page integer required

    Example: 1

  • per_page integer required

    Example: 50

  • total integer required

    Total matching rows inside this key's scope. It is never the size of the whole estate, and it is computed after every filter has been applied, so it always agrees with the rows you can actually walk.

    Example: 26

  • total_pages integer required

    A ceiling, and at least 1 even when total is 0.

    Example: 1

Example response

{
    "data": [
        {
            "id": 1042,
            "name": "1600 Market Street",
            "address": "1600 Market St, Philadelphia, PA 19103",
            "square_footage": 329350,
            "company": "XR Advisors",
            "compliance": {
                "score": 0.8571,
                "risk_band": "low"
            },
            "primary_contact": {
                "email": "dana.reyes@example.com"
            },
            "updated_at": "2026-08-17T14:02:11Z",
            "building_addresses": [
                {
                    "label": "Tower A",
                    "address": "1600 Market St"
                },
                {
                    "label": "Tower B",
                    "address": "1620 Market St"
                }
            ]
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 50,
        "total": 26,
        "total_pages": 1
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties?page=1&per_page=50&updated_since=2026-08-17T14%3A02%3A11Z' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties?page=1&per_page=50&updated_since=2026-08-17T14%3A02%3A11Z';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties?page=1&per_page=50&updated_since=2026-08-17T14%3A02%3A11Z'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /properties/{id}

Get one property

#op-getproperty

Requires an API key carrying the scope read:properties.

Parameters

Responses

Response schema 200 application/json

• data required

  A property, plus the per-category document breakdown that only the detail route carries.

  • id integer required

    Stable Confirmed property identifier. Use it as the path parameter everywhere.

    Example: 1042

  • name string required

    The display name, with the "Portfolio Dashboard – " prefix removed and HTML entities decoded, matching what the customer sees in their portal. Falls back to "#<id>" if the record has no usable title.

    Example: 1600 Market Street

  • address string | null required

    One unstructured string, exactly as stored, or null. There are no city / state / postal-code fields on a property and none are derived — see the six-things section in the API description.

    Example: 1600 Market St, Philadelphia, PA 19103

  • square_footage integer | null required

    null rather than 0 when unrecorded or unparseable. A square footage of zero is a claim, and a false one.

    Example: 329350

  • company string | null required

    Example: XR Advisors

  • compliance object required

    A property's compliance headline.

    • score number | null required

      A 0–1 fraction, rounded to 4 decimal places. The Confirmed portal shows this same number as a percentage — 0.8571 here is 85.71% there. null when the property has no score; never a substituted number.

      Documents that are expiring soon earn no credit: the score is (green + repaired) / total, so a property whose only document is expiring soon scores 0. That is the portal's behaviour and is reproduced here on purpose so the two never disagree.

      Example: 0.8571

    • risk_band string | null required

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

      One of: low, moderate, elevated, severe, null

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

  • primary_contact object required

    The property's primary contact. Only an email address is exposed — there is no name or phone field on this object, because there is no reliable backing value for either.

    • email string | null required
  • updated_at string | null required

    When the property record last changed, UTC. Compare against updated_since.

    Example: 2026-08-17T14:02:11Z

  • building_addresses array

    Per-building addresses, for multi-building properties. The key is absent entirely when the property has no list — it is never an empty array, because an empty array would read as 'we checked and there are none'.

    An array of:

    • label string | null required

      Example: Tower A

    • address string | null required

      Example: 1600 Market St

  • compliance required
    • score number | null required

      A 0–1 fraction, rounded to 4 decimal places. The Confirmed portal shows this same number as a percentage — 0.8571 here is 85.71% there. null when the property has no score; never a substituted number.

      Documents that are expiring soon earn no credit: the score is (green + repaired) / total, so a property whose only document is expiring soon scores 0. That is the portal's behaviour and is reproduced here on purpose so the two never disagree.

      Example: 0.8571

    • risk_band string | null required

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

      One of: low, moderate, elevated, severe, null

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

    • categories array required

      Per-category document counts for this property, sorted by category name. Present on the property detail response only.

      category is the stored value verbatim, so the two production spellings of one category (Invoices and invoices) appear as two separate rows. They are not merged, because merging them would mean inventing a mapping, and a mapping that is wrong for one importer silently combines unrelated categories. Documents with no category at all are grouped under Uncategorized.

      An array of:

      • category string required

        The stored category value, verbatim, or Uncategorized.

      • total integer required
      • green integer required

        Current.

      • amber integer required

        Expiring soon.

      • red integer required

        Expired.

      • undated integer required

        No usable expiration date recorded. Counted separately rather than as expired, which would overstate every property holding one. total == green + amber + red + undated.

Example response

{
    "data": {
        "id": 1042,
        "name": "1600 Market Street",
        "address": "1600 Market St, Philadelphia, PA 19103",
        "square_footage": 329350,
        "company": "XR Advisors",
        "compliance": {
            "score": 0.8571,
            "risk_band": "low",
            "categories": [
                {
                    "category": "Certificate of Insurance",
                    "total": 3,
                    "green": 2,
                    "amber": 1,
                    "red": 0,
                    "undated": 0
                },
                {
                    "category": "Inspection Report/Certificates",
                    "total": 22,
                    "green": 18,
                    "amber": 1,
                    "red": 2,
                    "undated": 1
                }
            ]
        },
        "primary_contact": {
            "email": "dana.reyes@example.com"
        },
        "updated_at": "2026-08-17T14:02:11Z",
        "building_addresses": [
            {
                "label": "Tower A",
                "address": "1600 Market St"
            },
            {
                "label": "Tower B",
                "address": "1620 Market St"
            }
        ]
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /properties/{property_id}/documents

List a property's documents

#op-listdocuments

Requires an API key carrying the scope read:documents.

Parameters

Responses

Response schema 200 application/json

• data array required

  An array of:

  • id integer required

    Example: 9912

  • property_id integer required

    The property this document is filed against.

    Example: 1042

  • category string | null required

    The stored category verbatim, so it matches what the customer sees in their portal. Production holds two spellings of several categories (Inspection Report/Certificates and inspection_report_certificates) depending on which importer wrote the row; both are returned as stored.

    This is a document type, not a discipline. It does not tell you what was inspected.

    Example: Inspection Report/Certificates

  • category_key string | null required

    category normalised for switching on: lowercased, every run of non-alphanumeric characters collapsed to a single _, trimmed.

    Lossy and not reversible. Punctuation is erased rather than encoded, so Inspection Report/Certificates and Inspection Report - Certificates deliberately collide — as do the label and slug spellings of the same category, which is the point.

    Nullable for two indistinguishable reasons: the row has no category, or its category contains no alphanumeric characters at all. The API does not tell you which.

    Not a join key, and not a discipline. There is no discipline field in this API; Elevators / Sprinkler / Fire Panel live only in Life Safety Interval post meta, matched by filename, so a client reading category_key learns nothing about what was inspected.

    Example: inspection_report_certificates

  • file_name string | null required

    Example: FE_Annual_2026.pdf

  • uploaded_at string | null required

    When the document was uploaded, UTC. This is what updated_since filters on.

    Example: 2026-03-06T18:22:00Z

  • inspection_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2026-03-04

  • expiration_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2027-03-04

  • status string required

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.

    One of: current, expiring_soon, expired, scheduled, no_expiration

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.
  • days_until_expiration integer | null required

    Whole days from today, measured day-to-day. Negative when the document has already expired. null, never 0, when no expiration date is recorded — 0 would read as 'expires today'.

    Example: 198

  • vendor required

    AI-extracted from the document itself, and frequently null. There is no vendor column; this is whatever the document parse read off the page. It is not validated against Confirmed's vendor records and is not an identifier — treat it as a hint.

    Spelled as oneOf rather than as a nullable $ref: in OpenAPI 3.1 a type of ["object", "null"] alongside an allOf of the object schema is self-contradictory for the null case, because the allOf branch still demands an object.

• meta object required

  Present on collection responses only.

  • page integer required

    Example: 1

  • per_page integer required

    Example: 50

  • total integer required

    Total matching rows inside this key's scope. It is never the size of the whole estate, and it is computed after every filter has been applied, so it always agrees with the rows you can actually walk.

    Example: 26

  • total_pages integer required

    A ceiling, and at least 1 even when total is 0.

    Example: 1

Example response

{
    "data": [
        {
            "id": 9912,
            "property_id": 1042,
            "category": "Inspection Report/Certificates",
            "category_key": "inspection_report_certificates",
            "file_name": "FE_Annual_2026.pdf",
            "uploaded_at": "2026-03-06T18:22:00Z",
            "inspection_date": "2026-03-04",
            "expiration_date": "2027-03-04",
            "status": "current",
            "days_until_expiration": 198,
            "vendor": {
                "name": "Keystone Fire Protection"
            }
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 50,
        "total": 28,
        "total_pages": 1
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents?page=1&per_page=50&category=inspection_report_certificates&status=expiring_soon&expiring_within_days=60&updated_since=2026-08-01T00%3A00%3A00Z' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents?page=1&per_page=50&category=inspection_report_certificates&status=expiring_soon&expiring_within_days=60&updated_since=2026-08-01T00%3A00%3A00Z';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents?page=1&per_page=50&category=inspection_report_certificates&status=expiring_soon&expiring_within_days=60&updated_since=2026-08-01T00%3A00%3A00Z'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

POST /properties/{property_id}/documents

Upload a document

#op-uploaddocument

Requires an API key carrying the scope write:uploads.

Parameters

Request body

multipart/form-data

• file string required

  One JPEG, PNG, GIF or PDF, at most 35 MB (36700160 bytes).

Responses

Response schema 201 application/json

• data object required

  A document, plus the short-lived signed download URL that only this route mints.

  • id integer required

    Example: 9912

  • property_id integer required

    The property this document is filed against.

    Example: 1042

  • category string | null required

    The stored category verbatim, so it matches what the customer sees in their portal. Production holds two spellings of several categories (Inspection Report/Certificates and inspection_report_certificates) depending on which importer wrote the row; both are returned as stored.

    This is a document type, not a discipline. It does not tell you what was inspected.

    Example: Inspection Report/Certificates

  • category_key string | null required

    category normalised for switching on: lowercased, every run of non-alphanumeric characters collapsed to a single _, trimmed.

    Lossy and not reversible. Punctuation is erased rather than encoded, so Inspection Report/Certificates and Inspection Report - Certificates deliberately collide — as do the label and slug spellings of the same category, which is the point.

    Nullable for two indistinguishable reasons: the row has no category, or its category contains no alphanumeric characters at all. The API does not tell you which.

    Not a join key, and not a discipline. There is no discipline field in this API; Elevators / Sprinkler / Fire Panel live only in Life Safety Interval post meta, matched by filename, so a client reading category_key learns nothing about what was inspected.

    Example: inspection_report_certificates

  • file_name string | null required

    Example: FE_Annual_2026.pdf

  • uploaded_at string | null required

    When the document was uploaded, UTC. This is what updated_since filters on.

    Example: 2026-03-06T18:22:00Z

  • inspection_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2026-03-04

  • expiration_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2027-03-04

  • status string required

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.

    One of: current, expiring_soon, expired, scheduled, no_expiration

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.
  • days_until_expiration integer | null required

    Whole days from today, measured day-to-day. Negative when the document has already expired. null, never 0, when no expiration date is recorded — 0 would read as 'expires today'.

    Example: 198

  • vendor required

    AI-extracted from the document itself, and frequently null. There is no vendor column; this is whatever the document parse read off the page. It is not validated against Confirmed's vendor records and is not an identifier — treat it as a hint.

    Spelled as oneOf rather than as a nullable $ref: in OpenAPI 3.1 a type of ["object", "null"] alongside an allOf of the object schema is self-contradictory for the null case, because the allOf branch still demands an object.

  • download_url string | null required

    A signed URL for the file's bytes. Single use, with a TTL of 15 minutes, minted fresh on every request to this route.

    It appears only here. Document list responses never carry one, because a signed URL is a live credential and a page of 200 documents would put 200 spendable credentials into a single response body.

    Redeeming it consumes it: a second request to the same URL is a 404, identical to the 404 for expiry, tampering, or the key having lost access to the document since minting. Fetch this route again to mint a fresh one.

    null in the rare case the URL could not be minted; the document record itself is still valid.

  • download_url_expires_at string | null required

    When download_url stops working, UTC. Read from the token itself, so it cannot drift from it.

    Example: 2026-03-06T18:37:00Z

Example response

{
    "data": {
        "id": 9912,
        "property_id": 1042,
        "category": "Inspection Report/Certificates",
        "category_key": "inspection_report_certificates",
        "file_name": "FE_Annual_2026.pdf",
        "uploaded_at": "2026-03-06T18:22:00Z",
        "inspection_date": "2026-03-04",
        "expiration_date": "2027-03-04",
        "status": "current",
        "days_until_expiration": 198,
        "vendor": {
            "name": "Keystone Fire Protection"
        },
        "download_url": "https://confirmedlifesafety.com/wp-json/confirmed/v1/download/eyJkb2NfaWQiOjk5MTIsImtleV9pZCI6NywiZXhwIjoxNzk1MDE0NTIwLCJub25jZSI6ImE5ZjMifQ.Kx7pQ2mS1vHhTt0nJ8zY4bLdWc6RfAeUgN3iOxVpQlM",
        "download_url_expires_at": "2026-03-06T18:37:00Z"
    }
}

curl -X POST 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'file=@/path/to/FE_Annual_2026.pdf;type=application/pdf'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents';

const formData = new FormData();
formData.append('file', fileInput.files[0]); // FE_Annual_2026.pdf (application/pdf)

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: formData
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/properties/1042/documents'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

with open('FE_Annual_2026.pdf', 'rb') as fh:
    files = {'file': ('FE_Annual_2026.pdf', fh, 'application/pdf')}
    response = requests.post(url, headers=headers, files=files)

data = response.json()

GET /documents/{id}

Get one document, with a download URL

#op-getdocument

Requires an API key carrying the scope read:documents.

Parameters

Responses

Response schema 200 application/json

• data object required

  A document, plus the short-lived signed download URL that only this route mints.

  • id integer required

    Example: 9912

  • property_id integer required

    The property this document is filed against.

    Example: 1042

  • category string | null required

    The stored category verbatim, so it matches what the customer sees in their portal. Production holds two spellings of several categories (Inspection Report/Certificates and inspection_report_certificates) depending on which importer wrote the row; both are returned as stored.

    This is a document type, not a discipline. It does not tell you what was inspected.

    Example: Inspection Report/Certificates

  • category_key string | null required

    category normalised for switching on: lowercased, every run of non-alphanumeric characters collapsed to a single _, trimmed.

    Lossy and not reversible. Punctuation is erased rather than encoded, so Inspection Report/Certificates and Inspection Report - Certificates deliberately collide — as do the label and slug spellings of the same category, which is the point.

    Nullable for two indistinguishable reasons: the row has no category, or its category contains no alphanumeric characters at all. The API does not tell you which.

    Not a join key, and not a discipline. There is no discipline field in this API; Elevators / Sprinkler / Fire Panel live only in Life Safety Interval post meta, matched by filename, so a client reading category_key learns nothing about what was inspected.

    Example: inspection_report_certificates

  • file_name string | null required

    Example: FE_Annual_2026.pdf

  • uploaded_at string | null required

    When the document was uploaded, UTC. This is what updated_since filters on.

    Example: 2026-03-06T18:22:00Z

  • inspection_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2026-03-04

  • expiration_date string | null required

    Calendar day, no time. null when unrecorded.

    Example: 2027-03-04

  • status string required

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.

    One of: current, expiring_soon, expired, scheduled, no_expiration

    The document's compliance state, computed at request time from the shared compliance rules — the same rules and the same profile the portal uses, so the two always agree.

    • current — in date.
    • expiring_soon — inside the configurable amber window (30 days by default, editable by Confirmed, so do not hardcode it).
    • expired — past its expiration date.
    • scheduled — expired or expiring, but with a booked re-inspection within the last 14 days. After that grace it reverts to what its expiry says.
    • no_expiration — no usable expiration date recorded. days_until_expiration is null in this case, never 0.
  • days_until_expiration integer | null required

    Whole days from today, measured day-to-day. Negative when the document has already expired. null, never 0, when no expiration date is recorded — 0 would read as 'expires today'.

    Example: 198

  • vendor required

    AI-extracted from the document itself, and frequently null. There is no vendor column; this is whatever the document parse read off the page. It is not validated against Confirmed's vendor records and is not an identifier — treat it as a hint.

    Spelled as oneOf rather than as a nullable $ref: in OpenAPI 3.1 a type of ["object", "null"] alongside an allOf of the object schema is self-contradictory for the null case, because the allOf branch still demands an object.

  • download_url string | null required

    A signed URL for the file's bytes. Single use, with a TTL of 15 minutes, minted fresh on every request to this route.

    It appears only here. Document list responses never carry one, because a signed URL is a live credential and a page of 200 documents would put 200 spendable credentials into a single response body.

    Redeeming it consumes it: a second request to the same URL is a 404, identical to the 404 for expiry, tampering, or the key having lost access to the document since minting. Fetch this route again to mint a fresh one.

    null in the rare case the URL could not be minted; the document record itself is still valid.

  • download_url_expires_at string | null required

    When download_url stops working, UTC. Read from the token itself, so it cannot drift from it.

    Example: 2026-03-06T18:37:00Z

Example response

{
    "data": {
        "id": 9912,
        "property_id": 1042,
        "category": "Inspection Report/Certificates",
        "category_key": "inspection_report_certificates",
        "file_name": "FE_Annual_2026.pdf",
        "uploaded_at": "2026-03-06T18:22:00Z",
        "inspection_date": "2026-03-04",
        "expiration_date": "2027-03-04",
        "status": "current",
        "days_until_expiration": 198,
        "vendor": {
            "name": "Keystone Fire Protection"
        },
        "download_url": "https://confirmedlifesafety.com/wp-json/confirmed/v1/download/eyJkb2NfaWQiOjk5MTIsImtleV9pZCI6NywiZXhwIjoxNzk1MDE0NTIwLCJub25jZSI6ImE5ZjMifQ.Kx7pQ2mS1vHhTt0nJ8zY4bLdWc6RfAeUgN3iOxVpQlM",
        "download_url_expires_at": "2026-03-06T18:37:00Z"
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/documents/9912' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/documents/9912';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/documents/9912'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /download/{token}

Redeem a signed download URL

#op-downloaddocument

Public. No credential is required, and none should be sent.

Parameters

Responses

Response schema 200 application/pdf

Response schema 200 image/jpeg

Response schema 200 image/png

Response schema 200 application/octet-stream

Example response

"<binary>"

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/download/eyJkb2NfaWQiOjk5MTIsImtleV9pZCI6NyJ9.signature-goes-here'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/download/eyJkb2NfaWQiOjk5MTIsImtleV9pZCI6NyJ9.signature-goes-here';

const response = await fetch(url, {
  method: 'GET'
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/download/eyJkb2NfaWQiOjk5MTIsImtleV9pZCI6NyJ9.signature-goes-here'

response = requests.get(url)

data = response.json()

GET /compliance/summary

Portfolio compliance rollup

#op-getcompliancesummary

Requires an API key carrying the scope read:compliance.

No parameters.

Responses

Response schema 200 application/json

• data object required

  A portfolio rollup over everything this key can see — one call instead of paging every property.

  • properties integer required

    How many properties are in this key's scope.

    Example: 26

  • score number | null required

    The mean of the per-property scores, over scored properties only, as a 0–1 fraction. A property with nothing to score yet is 'no data', not 'zero', and is excluded from the mean rather than folded in as 0 — conflating those two is the most dangerous wrong answer this endpoint could give. null when no property in scope has a score at all.

    Example: 0.8412

  • risk_band string | null required

    The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

    One of: low, moderate, elevated, severe, null

    The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

  • documents object required

    total is always exactly current + expiring_soon + expired + no_expiration, so no row silently disappears from the count.

    current / expiring_soon / expired use the configurable amber window — the same one the portal uses.

    • total integer required

      Example: 742

    • current integer required

      Example: 601

    • expiring_soon integer required

      Example: 34

    • expired integer required

      Example: 52

    • no_expiration integer required

      No usable expiration date. Excluded from every expiry bucket, included in total.

      Example: 55

  • expiring object required

    Fixed, absolute calendar windows — not the configurable amber window, and deliberately cumulative: a document expiring in 10 days is counted in all three, so in_30_days can be read on its own as 'act this month'. Only future expirations count; an already-expired document is in documents.expired and in none of these.

    • in_30_days integer required

      Example: 34

    • in_60_days integer required

      Example: 58

    • in_90_days integer required

      Example: 91

  • by_property array required

    Per-property scores. Capped at 500 entries so an enormous portfolio cannot produce an unbounded body. There is no page 2 of this array — use GET /properties when you need to walk everything. The cap applies to this listing only: properties, score, documents and expiring always cover the full scope.

    An array of:

    • property_id integer required

      Example: 1042

    • score number | null required

      A 0–1 fraction, or null when the property has no score. See Compliance.score.

      Example: 0.8571

    • risk_band string | null required

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

      One of: low, moderate, elevated, severe, null

      The compliance risk band, as the lowercased band label. null whenever score is null — never a substituted band.

  • by_property_capped boolean required

    true when by_property was truncated. Truncation is never silent.

    Example: false

Example response

{
    "data": {
        "properties": 26,
        "score": 0.8412,
        "risk_band": "low",
        "documents": {
            "total": 742,
            "current": 601,
            "expiring_soon": 34,
            "expired": 52,
            "no_expiration": 55
        },
        "expiring": {
            "in_30_days": 34,
            "in_60_days": 58,
            "in_90_days": 91
        },
        "by_property": [
            {
                "property_id": 1042,
                "score": 0.8571,
                "risk_band": "low"
            },
            {
                "property_id": 1043,
                "score": null,
                "risk_band": null
            }
        ],
        "by_property_capped": false
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/compliance/summary' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/compliance/summary';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/compliance/summary'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /tasks

List open tasks

#op-listtasks

Requires an API key carrying the scope read:tasks.

Parameters

Responses

Response schema 200 application/json

• data array required

  An array of:

  • id integer required

    Example: 4471

  • property_id integer required

    Example: 1042

  • title string required

    Example: Fire extinguisher certificate expired

  • description string | null required

    Example: The most recent annual certificate expired on 2026-07-14 and no replacement has been received.

  • source_type string required

    Why the task exists, as Confirmed's task engine classified it.

    Example: expiring_document

  • status string required

    A stable four-value vocabulary, mapped from Confirmed's internal task state machine so that internal renames cannot break your integration. done is declared for completeness and is never returned — this endpoint only ever carries open items.

    One of: open, in_progress, blocked, done

    A stable four-value vocabulary, mapped from Confirmed's internal task state machine so that internal renames cannot break your integration. done is declared for completeness and is never returned — this endpoint only ever carries open items.

  • due_date string | null required

    Example: 2026-09-01T00:00:00Z

  • created_at string | null required

    Example: 2026-08-04T13:11:07Z

• meta object required

  Present on collection responses only.

  • page integer required

    Example: 1

  • per_page integer required

    Example: 50

  • total integer required

    Total matching rows inside this key's scope. It is never the size of the whole estate, and it is computed after every filter has been applied, so it always agrees with the rows you can actually walk.

    Example: 26

  • total_pages integer required

    A ceiling, and at least 1 even when total is 0.

    Example: 1

Example response

{
    "data": [
        {
            "id": 4471,
            "property_id": 1042,
            "title": "Fire extinguisher certificate expired",
            "description": "The most recent annual certificate expired on 2026-07-14 and no replacement has been received.",
            "source_type": "expiring_document",
            "status": "open",
            "due_date": "2026-09-01T00:00:00Z",
            "created_at": "2026-08-04T13:11:07Z"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 50,
        "total": 12,
        "total_pages": 1
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/tasks?page=1&per_page=50&property_id=1042&status=open' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/tasks?page=1&per_page=50&property_id=1042&status=open';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/tasks?page=1&per_page=50&property_id=1042&status=open'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /ping

Verify a key

#op-ping

Requires an API key carrying the scope read:properties.

No parameters.

Responses

Response schema 200 application/json

• data object required
  • ok boolean required

    Example: true

Example response

{
    "data": {
        "ok": true
    }
}

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/ping' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/ping';

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/ping'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)

data = response.json()

GET /openapi.json

This document

#op-getopenapispec

Public. No credential is required, and none should be sent.

No parameters.

Responses

Response schema 200 application/json

An OpenAPI 3.1.0 document.

curl -X GET 'https://confirmedlifesafety.com/wp-json/confirmed/v1/openapi.json'

const url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/openapi.json';

const response = await fetch(url, {
  method: 'GET'
});

const data = await response.json();

import requests

url = 'https://confirmedlifesafety.com/wp-json/confirmed/v1/openapi.json'

response = requests.get(url)

data = response.json()