Marketplace Account Health API Documentation

Read supplied seller notices, performance figures, and hold records, and point at missing evidence without predicting an appeal. Payment is the exact USDC price on Base with x402.

{
  "text": "Notice: N-100 | Example Market | 2026-11-01 | 2026-11-15 | listing mismatch | provide invoices\nThe account will be closed tomorrow.\n"
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "extracted",
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices",
      "interpretation": "stated"
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "ignored",
      "code": "unlabeled_line",
      "subject": "",
      "detail": "Lines without a recognized label were not read and their text was not copied."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/account-notice-extract" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "text": "Notice: N-100 | Example Market | 2026-11-01 | 2026-11-15 | listing mismatch | provide invoices\nThe account will be closed tomorrow.\n"
}
JSON

{
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "target": 95,
      "direction": "above",
      "period": "2026-10",
      "unit": "percent"
    },
    {
      "name": "defect rate",
      "value": 2,
      "direction": "below",
      "period": "2026-10",
      "unit": "percent"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "checked",
  "suspensionPredicted": false,
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "valueSupplied": true,
      "target": 95,
      "targetSupplied": true,
      "direction": "above",
      "period": "2026-10",
      "unit": "percent",
      "comparison": "outside",
      "suspensionPredicted": false,
      "interpretation": "stated"
    },
    {
      "name": "defect rate",
      "value": 2,
      "valueSupplied": true,
      "target": 0,
      "targetSupplied": false,
      "direction": "below",
      "period": "2026-10",
      "unit": "percent",
      "comparison": "not_checked",
      "suspensionPredicted": false,
      "interpretation": "stated"
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "observation",
      "code": "outside_target",
      "subject": "on-time shipment",
      "detail": "The supplied value is on the wrong side of the supplied target. This is not a suspension finding."
    },
    {
      "kind": "observation",
      "code": "target_missing",
      "subject": "defect rate",
      "detail": "No target was supplied. A marketplace threshold was not invented."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/seller-performance-metric-analyze" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "target": 95,
      "direction": "above",
      "period": "2026-10",
      "unit": "percent"
    },
    {
      "name": "defect rate",
      "value": 2,
      "direction": "below",
      "period": "2026-10",
      "unit": "percent"
    }
  ]
}
JSON

{
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch"
    },
    {
      "id": "H-2",
      "amount": 20,
      "currency": "EUR",
      "since": "2026-11-02"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "checked",
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "amountSupplied": true,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch",
      "interpretation": "stated"
    },
    {
      "id": "H-2",
      "amount": 20,
      "amountSupplied": true,
      "currency": "EUR",
      "since": "2026-11-02",
      "reason": "",
      "interpretation": "stated"
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "observation",
      "code": "hold_unchanged",
      "subject": "H-1",
      "detail": "The supplied record says a hold exists. The hold was not removed."
    },
    {
      "kind": "missing",
      "code": "reason_missing",
      "subject": "H-2",
      "detail": "No hold reason was stated. One was not invented."
    },
    {
      "kind": "observation",
      "code": "hold_unchanged",
      "subject": "H-2",
      "detail": "The supplied record says a hold exists. The hold was not removed."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/payout-hold-diagnose" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch"
    },
    {
      "id": "H-2",
      "amount": 20,
      "currency": "EUR",
      "since": "2026-11-02"
    }
  ]
}
JSON

{
  "restrictions": [
    {
      "id": "X-1",
      "noticeId": "N-100",
      "kind": "listing",
      "since": "2026-11-01",
      "detail": "listing mismatch"
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "checked",
  "restrictionLifted": false,
  "items": [
    {
      "name": "invoices",
      "state": "missing",
      "interpretation": "none"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "interpretation": "stated"
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "missing",
      "code": "evidence_missing",
      "subject": "invoices",
      "detail": "This caller-required evidence kind was not supplied. A document was not invented."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/account-restriction-evidence-check" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "restrictions": [
    {
      "id": "X-1",
      "noticeId": "N-100",
      "kind": "listing",
      "since": "2026-11-01",
      "detail": "listing mismatch"
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}
JSON

{
  "policies": [
    {
      "id": "P-1",
      "name": "listing mismatch",
      "text": "Listings must match the product shown."
    }
  ],
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    },
    {
      "id": "N-200",
      "reason": "erase"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "classified",
  "notices": [
    {
      "id": "N-100",
      "reason": "listing mismatch",
      "policyId": "P-1",
      "policyName": "listing mismatch",
      "quote": "Listings must match the product shown.",
      "matched": true,
      "interpretation": "stated"
    },
    {
      "id": "N-200",
      "reason": "erase",
      "policyId": "",
      "policyName": "",
      "quote": "",
      "matched": false,
      "interpretation": "none"
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "observation",
      "code": "policy_unmatched",
      "subject": "N-200",
      "detail": "The reason does not match a supplied policy name or id. The closest policy was not chosen."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/policy-issue-classify" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "policies": [
    {
      "id": "P-1",
      "name": "listing mismatch",
      "text": "Listings must match the product shown."
    }
  ],
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    },
    {
      "id": "N-200",
      "reason": "erase"
    }
  ]
}
JSON

{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "checked",
  "checklists": [
    {
      "noticeId": "N-100",
      "action": "provide invoices",
      "appealGranted": false,
      "items": [
        {
          "name": "invoices",
          "state": "missing"
        }
      ],
      "evidence": [
        {
          "id": "E-1",
          "kind": "photos",
          "date": "2026-11-02"
        }
      ]
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "missing",
      "code": "evidence_missing",
      "subject": "N-100",
      "detail": "The caller-required evidence \"invoices\" was not supplied. It was not invented."
    },
    {
      "kind": "observation",
      "code": "appeal_not_predicted",
      "subject": "",
      "detail": "This checklist does not predict an appeal result."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/seller-appeal-evidence-build" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}
JSON

{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "target": 95,
      "direction": "above",
      "period": "2026-10"
    }
  ],
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch"
    }
  ],
  "policies": [
    {
      "id": "P-1",
      "name": "listing mismatch",
      "text": "Listings must match the product shown."
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "checked",
  "suspensionPredicted": false,
  "sent": false,
  "restrictionLifted": false,
  "noticeCount": 1,
  "metricCount": 1,
  "holdCount": 1,
  "outsideCount": 1,
  "missingCount": 1,
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices",
      "interpretation": "stated"
    }
  ],
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "valueSupplied": true,
      "target": 95,
      "targetSupplied": true,
      "direction": "above",
      "period": "2026-10",
      "unit": "",
      "comparison": "outside",
      "suspensionPredicted": false,
      "interpretation": "stated"
    }
  ],
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "amountSupplied": true,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch",
      "interpretation": "stated"
    }
  ],
  "policies": [
    {
      "id": "N-100",
      "reason": "listing mismatch",
      "policyId": "P-1",
      "policyName": "listing mismatch",
      "quote": "Listings must match the product shown.",
      "matched": true,
      "interpretation": "stated"
    }
  ],
  "items": [
    {
      "name": "invoices",
      "state": "missing",
      "interpretation": "none"
    }
  ],
  "checklists": [
    {
      "noticeId": "N-100",
      "action": "provide invoices",
      "appealGranted": false,
      "items": [
        {
          "name": "invoices",
          "state": "missing"
        }
      ],
      "evidence": [
        {
          "id": "E-1",
          "kind": "photos",
          "date": "2026-11-02"
        }
      ]
    }
  ],
  "drafts": [
    {
      "noticeId": "N-100",
      "sent": false,
      "text": "Hello, This note is about notice N-100 from Example Market. The supplied received date is 2026-11-01. The notice states: \"listing mismatch\". The requested action is: \"provide invoices\". The stated deadline is 2026-11-15. The supplied records are: photos (2026-11-02). This draft does not predict an appeal result. It also does not say a payout is being released."
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [
    {
      "kind": "observation",
      "code": "outside_target",
      "subject": "on-time shipment",
      "detail": "The supplied value is on the wrong side of the supplied target. This is not a suspension finding."
    },
    {
      "kind": "observation",
      "code": "hold_unchanged",
      "subject": "H-1",
      "detail": "The supplied record says a hold exists. The hold was not removed."
    },
    {
      "kind": "missing",
      "code": "evidence_missing",
      "subject": "invoices",
      "detail": "This caller-required evidence kind was not supplied. A document was not invented."
    },
    {
      "kind": "missing",
      "code": "evidence_missing",
      "subject": "N-100",
      "detail": "The caller-required evidence \"invoices\" was not supplied. It was not invented."
    },
    {
      "kind": "observation",
      "code": "appeal_not_predicted",
      "subject": "",
      "detail": "This checklist does not predict an appeal result."
    }
  ],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/account-risk-report" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "metrics": [
    {
      "name": "on-time shipment",
      "value": 92,
      "target": 95,
      "direction": "above",
      "period": "2026-10"
    }
  ],
  "holds": [
    {
      "id": "H-1",
      "amount": 150,
      "currency": "USD",
      "since": "2026-11-01",
      "reason": "listing mismatch"
    }
  ],
  "policies": [
    {
      "id": "P-1",
      "name": "listing mismatch",
      "text": "Listings must match the product shown."
    }
  ],
  "requirements": [
    {
      "name": "invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}
JSON

{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}

{
  "checkedAt": "2026-11-04T10:00:00.000Z",
  "status": "drafted",
  "sent": false,
  "drafts": [
    {
      "noticeId": "N-100",
      "sent": false,
      "text": "Hello, This note is about notice N-100 from Example Market. The supplied received date is 2026-11-01. The notice states: \"listing mismatch\". The requested action is: \"provide invoices\". The stated deadline is 2026-11-15. The supplied records are: photos (2026-11-02). This draft does not predict an appeal result. It also does not say a payout is being released."
    }
  ],
  "accountAccessed": false,
  "marketplaceContacted": false,
  "appealGranted": false,
  "holdRemoved": false,
  "policyFetched": false,
  "findings": [],
  "limitations": [
    "Notices, metrics, holds, and evidence are copied only from labeled fields supplied by the caller.",
    "A notice is matched only to policy text supplied in the request. No marketplace site is contacted.",
    "A draft does not predict an appeal result or say that a payout is being released.",
    "No seller account is accessed.",
    "A missing field means it was not in the supplied documents."
  ]
}

curl -i -X POST "https://brainiac.software/api/v1/marketplace-health/notice-response-draft" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "notices": [
    {
      "id": "N-100",
      "marketplace": "Example Market",
      "received": "2026-11-01",
      "deadline": "2026-11-15",
      "reason": "listing mismatch",
      "action": "provide invoices"
    }
  ],
  "evidence": [
    {
      "id": "E-1",
      "noticeId": "N-100",
      "kind": "photos",
      "date": "2026-11-02",
      "text": "product photos"
    }
  ]
}
JSON