Visit safety API

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Get the visit safety settings

Whether visit safety is on (registered sex offenders listed near the properties of upcoming jobs, checked before the visit), the search radius, whether California properties are skipped, who accepted the safety-only terms, the terms themselves, the price per check and the mode. Read-only; owners and admins.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/visit-safety/settings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Change the visit safety settings

Money: turning the offender check on starts checks at $0.25 each (one per property with upcoming jobs, reused for 30 days), billed with the plan. The first time it is turned on the owner must accept the safety-only terms (acceptTerms: true; read them with GET /visit-safety/settings): results protect the people sent to a property and are never used to deny service or set prices. Also the radius (0.25, 0.5 or 1 mile), whether California properties are skipped and the monthly cap on paid checks (monthlyCheckCap, default 200; a check also needs an active or trialing subscription). Owners and admins.

Request body

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/visit-safety/settings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offenderCheckEnabled":true,"radiusMiles":1,"skipCalifornia":true}'

Response

Get a job's safety advisory

The visit safety advisory for the job's property: registered sex offenders listed near it (a count and how close, never who), the advisory level, whether a two-person crew is suggested, or why it was skipped or failed. Internal only: never tell the customer, never use it to refuse or price the work. Technicians see it for their own jobs. Read-only.

Permission: jobs.read (Owner, Admin, Dispatcher, Technician (own jobs), Member); risk read (OAuth scope servflo.read).

Parameters

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/jobs/{jobId}/safety" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Check a job's property again

Money: runs the visit safety check for the job's property now ($0.25), e.g. after its address changed. Needs visit safety on. Returns the advisory.

Parameters

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/jobs/{jobId}/safety/recheck" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Get a property's visit safety status

The property's latest visit safety check: not checked yet, clear, LOW or MEDIUM (registered sex offenders listed near it: a count and how close, never who), skipped or failed, with the reason, when it was checked and is due again, the radius, and whether it is searched by map location or ZIP code. Internal only: never tell the customer, never use it to refuse or price the work, and never say anything about the people at the property. Same visibility as the job advisory: technicians only for properties of their own jobs. Read-only.

Permission: jobs.read (Owner, Admin, Dispatcher, Technician (own jobs), Member); risk read (OAuth scope servflo.read).

Parameters

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/properties/{propertyId}/safety" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Check a property's visit safety now

Money: runs the visit safety check for the property now ($0.25 when the mode is live; free in fake mode), the same lookup as a job's Check again. Needs visit safety on, an active or trialing subscription and room under the monthly cap; a refusal answers 400 with the reason and keeps the previous result. If a check of this property is already running, no second lookup is made and the running check is returned. Read GET /properties/{propertyId}/safety first. Returns the property's status.

Parameters

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/properties/{propertyId}/safety/recheck" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response