Skip to content
Vendorica Developer Docs

Get compliance posture

GET
/compliance/posture
curl --request GET \
  --url https://api.vendorica.com/v1/compliance/posture \
  --header 'Authorization: Bearer <token>'

The organization’s overall readiness score plus one score per ADOPTED framework. Only active adoptions contribute — a framework the organization has paused or stepped away from is excluded rather than counted as failing, because a score that punishes a deliberate de-adoption reports a decision as a problem.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
success
required
boolean
data
required
object
overallScore
required
number
byFramework
required
Array<object>
object
frameworkId
required
string format: uuid
code
required
string
name
required
string
controlsTotal
required
integer
controlsOk
required
integer
controlsNeedsEvidence
required
integer
controlsExpiringSoon
required
integer
controlsExpired
required
integer
controlsDeactivated
required
integer
readinessPct
required
number | null
timestamp
required
string format: date-time
requestId
string
message
string
Example
{
  "success": true,
  "data": {
    "overallScore": 1,
    "byFramework": [
      {
        "frameworkId": "2f2d0a0e-4fe6-40e4-8f5a-dba5ad07be73",
        "code": "string",
        "name": "string",
        "controlsTotal": 1,
        "controlsOk": 1,
        "controlsNeedsEvidence": 1,
        "controlsExpiringSoon": 1,
        "controlsExpired": 1,
        "controlsDeactivated": 1,
        "readinessPct": 1
      }
    ]
  },
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H",
  "message": "string"
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Bad request",
  "code": "BAD_REQUEST",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

403

Section titled “403”

Forbidden — missing scope

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Forbidden",
  "code": "FORBIDDEN",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Resource not found",
  "code": "NOT_FOUND",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Too many requests",
  "code": "TOO_MANY_REQUESTS",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}