Deliver a scan captured with the Partner SDK

For partners integrating the Roomio Partner SDK. bundle_url must point at a bundle the SDK produced — no other capture produces a bundle we can read, and the SDK encrypts every partner bundle, which we decrypt on the way in.

You host the bundle; we download it in the background, so the response is 202 and the scan starts initiated. Subscribe to scan.uploaded to learn the bundle landed, scan.processed to learn the scan is ready to order, and scan.failed if it could not be ingested. The URL must be https and resolve to a public address; a signed URL is the usual way.

If you are not using the Partner SDK, this endpoint is not for you — scans reach us from the Roomio app and appear under GET /scans.

Headers

Idempotency-Key
Type: string
max length:
200

Retry-safe request key. Retries with the same key and payload replay the original response; the same key with a different payload returns 409.

Body

required

application/json

bundle_url
Type: string
required

HTTPS URL we will download the scan bundle from. Must be reachable without credentials in a header; a signed URL is the usual way. Public addresses only.
property
Type: object
required
Properties: 8
reference
Type: string | null

Your own reference for this scan, such as a job ID. Up to 255 characters, and need not be unique. For your convenience only.

Responses

application/json
application/json
application/json
application/json

post/partner_sdk/scans

curl https://api.roomio.io/partner_sdk/scans \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "bundle_url": "",
  "property": {
    "street_address": null,
    "suburb": null,
    "state": null,
    "postcode": null,
    "country": null,
    "latitude": 12.34,
    "longitude": 12.34,
    "title": null
  },
  "reference": null
}'

Show Schema

{
  "uuid": "string",
  "status": "initiated",
  "estimated_scan_area": 12.34,
  "scan_start_time": "2019-12-15T09:32:45Z",
  "scan_completed_time": "2019-12-15T09:32:45Z",
  "preview_thumbnail_url": null,
  "latest_order_uuid": null,
  "reference": null,
  "property": {
    "uuid": "string",
    "street_address": null,
    "suburb": null,
    "state": null,
    "postcode": null,
    "country": null,
    "full_address": null,
    "address_inferred": true,
    "latitude": 12.34,
    "longitude": 12.34
  },
  "created_at": "2019-12-15T09:32:45Z"
}

Success

Partner SDK

Scans