Skip to main content
GET
/
readiness
/
compliance
Get storefront compliance status
curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/readiness/compliance \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.interchange.io/api/v2/storefront/readiness/compliance"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/storefront/readiness/compliance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "category": "<string>",
  "isBlocker": true,
  "method": "<string>",
  "details": "<string>",
  "actionLabel": "<string>",
  "compliance": [
    {
      "agentId": "<string>",
      "agentUrl": "<string>",
      "passed": true,
      "tracks": [
        {
          "track": "<string>",
          "label": "<string>",
          "durationMs": 123,
          "failureReason": "<string>"
        }
      ],
      "summary": "<string>",
      "observations": [
        {
          "category": "<string>",
          "message": "<string>"
        }
      ],
      "durationMs": 123,
      "error": "<string>"
    }
  ]
}
{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}
{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}
{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}
{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}

Authorizations

Authorization
string
header
required

API key or access token

Response

object | null

Get storefront compliance status

Individual readiness check result

id
string
required
name
string
required
description
string
required
category
string
required
status
enum<string>
required

Status of a readiness check. optional is reserved for checks that are explicitly skipped (e.g. billing in non-production environments) — they are not required before the storefront can start transacting.

Available options:
complete,
partial,
missing,
optional
isBlocker
boolean
required
method
string
details
string
action
enum<string>

Where this step resolves. Absent → the widget falls back to its own routing for the check id.

Available options:
inline_currency,
policy,
open,
chat,
recheck
actionLabel
string

Outcome-named action label for this step (e.g. "Connect ad server", "Set currency") — names the task, not the tool. Absent → the widget derives a label from the check name.

compliance
object[]

Per-agent compliance results (present on agent_connectivity checks)