Skip to main content
GET
/
brokerage-firms
/
{brokerageFirmId}
/
documents
/
compliance
List document compliance results for a brokerage firm
curl --request GET \
  --url https://api.example.com/brokerage-firms/{brokerageFirmId}/documents/compliance
{
  "compliances": [
    {
      "documentId": "<string>",
      "status": "PENDING",
      "results": [
        {
          "ruleType": "READABLE",
          "passed": true,
          "message": "<string>",
          "metadata": {}
        }
      ],
      "aiMetadata": {},
      "checkedAt": "<string>",
      "override": {
        "overriddenBy": "<string>",
        "overriddenAt": "<string>",
        "previousStatus": "<string>",
        "originalStatus": "<string>"
      }
    }
  ]
}

Path Parameters

brokerageFirmId
string
required

Response

200 - application/json
compliances
object[]
required

List of document compliance results for the brokerage firm