Connect a platform

POST/compliance

Creates a sandbox connection fixture for evaluation. Credential-shaped input exercises the workflow but does not establish a live production adapter; provisioned design-partner integrations are handled separately.

Auth:Bearer

Request body

family_id

uuidrequired

platform_id

stringrequired

credentials

stringrequired

Response

id

Unique identifier for this resource.

uuid

family_id

Identifier of the family this resource belongs to.

uuid

platform_id

Identifier of the associated platform.

string

status

Current lifecycle state of the resource.

verified | unverified | error

external_id

Identifier of the associated external.

string

last_enforcement_at

RFC 3339 timestamp.

datetime

last_enforcement_status

Outcome of the most recent enforcement run against this link (e.g. `success`, `partial`, `error`).

string

verified_at

RFC 3339 timestamp.

datetime

Request

bash

curl -sS -X POST "https://phosra-api-sandbox-production.up.railway.app/api/v1/compliance" \
  -H "Authorization: Bearer $PHOSRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "family_id": "f0000000-0000-4000-8000-0000000000f1",
  "platform_id": "fire_tablet",
  "credentials": "oauth_or_manual_token_here"
}'

Response

json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "family_id": "550e8400-e29b-41d4-a716-446655440000",
  "platform_id": "string",
  "status": "verified",
  "external_id": "string",
  "last_enforcement_at": null,
  "last_enforcement_status": "string",
  "verified_at": "2025-01-15T09:30:00Z"
}