VGO Rank API
Wire shapes follow Framework OpenAPI 3.1. Public read host: https://api.vgoframework.org/v1.
Environments
- Active public read
https://api.vgoframework.org/v1- Production base
https://api.vgoframework.org/v1- Alternate trial base
https://sandbox-api.vgoframework.org/v1
Operation reference
Each operationId matches the frozen OpenAPI. Planned items do not offer production call buttons.
| operationId | Method | Path | Auth | Portal status |
|---|---|---|---|---|
listProtocols | GET | /protocols | anonymous | planned |
submitEntity | POST | /entities | oauth2 | limited |
getEntity | GET | /entities/{entityId} | oauth2 | limited |
createScope | POST | /scopes | oauth2 | limited |
getScope | GET | /scopes/{scopeId} | oauth2 | limited |
startDiagnosticRun | POST | /diagnostic-runs | oauth2 | limited |
getDiagnosticRun | GET | /diagnostic-runs/{runId} | oauth2 | limited |
requestRating | POST | /rating-requests | oauth2 | limited |
getRatingRequest | GET | /rating-requests/{requestId} | oauth2 | limited |
getCurrentCertificate | GET | /scopes/{scopeId}/current-certificate | anonymous | production |
getCertificate | GET | /certificates/{certificateId} | anonymous | production |
getCertificateStatus | GET | /certificates/{certificateId}/status | anonymous | production |
getIssuerJwks | GET | /.well-known/jwks.json | anonymous | production |
verifyCertificate | POST | /certificates/verify | anonymous | production |
listRankings | GET | /rankings | anonymous | planned |
submitAppeal | POST | /appeals | oauth2 | limited |
getAppeal | GET | /appeals/{appealId} | oauth2 | limited |
createSubscription | POST | /subscriptions | oauth2 | sandbox |
receiveRankEvent | POST | webhook:rankEvent | oauth2 | sandbox |
createDiagnosisRun | POST | /v1/diagnosis-runs | oauth2 | planned |
getDiagnosisRun | GET | /v1/diagnosis-runs/{run_id} | oauth2 | planned |
cancelDiagnosisRun | POST | /v1/diagnosis-runs/{run_id}/cancel | oauth2 | planned |
listDiagnosisDimensions | GET | /v1/diagnosis-runs/{run_id}/dimensions | oauth2 | planned |
listDiagnosisMetrics | GET | /v1/diagnosis-runs/{run_id}/metrics | oauth2 | planned |
listDiagnosisFindings | GET | /v1/diagnosis-runs/{run_id}/findings | oauth2 | planned |
listDiagnosisRecommendations | GET | /v1/diagnosis-runs/{run_id}/recommendations | oauth2 | planned |
getDiagnosisEvidenceSummary | GET | /v1/diagnosis-runs/{run_id}/evidence-summary | oauth2 | planned |
getDiagnosisRetestDiff | GET | /v1/diagnosis-runs/{run_id}/retest-diff | oauth2 | planned |
createVerificationRequest | POST | /v1/diagnosis-runs/{run_id}/verification-requests | oauth2 | planned |
getDiagnosisProtocolManifest | GET | /v1/protocols/diagnosis/{version} | oauth2 | planned |
getMeasurementProtocolManifest | GET | /v1/protocols/measurement/{version} | oauth2 | planned |
Public resources
- Certificate
GET /v1/certificates/{id}
Signed issuance facts and status URL.- Current status
GET /v1/certificates/{id}/status
Current rated, watch, restricted, revoked or expired state.- Verification
POST /v1/certificates/verify
Signature and current-status check; no private evidence.- Approved rankings
GET /v1/rankings
Only approved market and industry snapshots.
Access and errors
Public reads may be anonymous with rate limits. Diagnostics and rating requests need credentials and scopes. Responses must distinguish insufficient evidence, ineligible ratings, unavailable surfaces, rate limits and revoked certificates. Missing samples are not VR0.
Result and status semantics
- Unrated
- Eligibility or evidence gate not met; no numeric Rank.
- VR0
- Eligible, validly sampled, and rated at VR0.
- rated / watch
- Current citation allowed within scope; watch requires a visible caution.
- restricted / revoked / expired / unknown
- Do not show a current valid badge; keep historical issuance facts when available.
Download Rank OpenAPIDownload Diagnosis OpenAPIOpenAPI and developer integration ↗