Letting Agent Client Check

API reference

Authentication

All requests require an X-Stratum-Key header. Get a key by subscribing to a plan.

Base URL

https://api.stratumapis.com/v1/suites/letting-agent

Endpoints

posthttps://api.stratumapis.com/v1/suites/letting-agent/check

Run a Letting Agent Client Check

Example

curl -H "X-Stratum-Key: $KEY" \
  https://api.stratumapis.com/v1/suites/letting-agent/check

posthttps://api.stratumapis.com/v1/suites/letting-agent/outcome

Report a tenancy outcome for a prior checkId (T3.1.b)

Example

curl -H "X-Stratum-Key: $KEY" \
  https://api.stratumapis.com/v1/suites/letting-agent/outcome

gethttps://api.stratumapis.com/v1/suites/letting-agent/outcome/{checkId}

List outcomes recorded for a checkId

Parameters

Example

curl -H "X-Stratum-Key: $KEY" \
  https://api.stratumapis.com/v1/suites/letting-agent/outcome/:checkId