UPupguard
vendors

Get vendor assessment details

Returns detailed information about a specific vendor assessment version, including assessment metadata, text sections, and evidence summaries.

Note: use /api/public/vendor/security_profile/assessment instead for security profile assessments.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

get/vendor/assessment

Request

Query parameters

idinteger required

The Assessment ID.

version_numberinteger

The version number within the assessment. If not provided, returns the latest version.

Response

Vendor assessment details

Example response

{
  "assessment": {
    "assessment_id": 1234567890123,
    "author_email": "john.smith@example.com",
    "author_name": "John Smith",
    "created_at": "2024-03-15T10:00:00Z",
    "id": 1234567890124,
    "include_waivers": true,
    "include_website_risks": true,
    "name": "Q1 2024 Security Assessment",
    "published_at": "2024-03-20T15:30:00Z",
    "sections": [
      {
        "content": "This assessment evaluates...",
        "name": "introduction"
      }
    ],
    "status": "published",
    "updated_at": "2024-03-19T16:45:00Z",
    "version_number": 2
  },
  "evidence": {
    "additional": [
      {
        "commentary": "Document provides comprehensive security policies",
        "created_at": "2024-02-28T09:15:00Z",
        "document_type": "Policy",
        "filename": "security-policy-2024.pdf",
        "id": 67890,
        "name": "Security Policy Document",
        "num_risks": 3,
        "selected": true
      }
    ],
    "num_active_risk_waivers": 3,
    "num_risk_waivers": 4,
    "num_scanning_risks": 15,
    "num_unapproved_risk_waivers": 1,
    "shared_additional": [
      {
        "accessible": true,
        "commentary": "Document provides comprehensive security policies",
        "created_at": "2024-02-28T09:15:00Z",
        "document_type": "Policy",
        "filename": "security-policy-2024.pdf",
        "id": 67890,
        "name": "Security Policy Document",
        "num_risks": 3,
        "selected": true,
        "uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "shared_surveys": [
      {
        "accessible": true,
        "id": 12345,
        "last_answered_at": "2024-03-10T14:30:00Z",
        "name": "ISO 27001 Questionnaire",
        "num_answers": 48,
        "num_questions": 50,
        "num_risks": 5,
        "num_waivers": 2,
        "score": 650,
        "selected": true,
        "state": "complete",
        "type": "ISO 27001"
      }
    ],
    "surveys": [
      {
        "id": 12345,
        "last_answered_at": "2024-03-10T14:30:00Z",
        "name": "ISO 27001 Questionnaire",
        "num_answers": 48,
        "num_questions": 50,
        "num_risks": 5,
        "num_waivers": 2,
        "score": 650,
        "selected": true,
        "state": "complete",
        "type": "ISO 27001"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.