Sign in

v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014121451.1 MB
Vendors

Create vendor

Create a vendor record so teams can track third-party risk, assessment evidence, owner, category, and compliance status.

post/v1/vendors

Request body

namestring required

Vendor name

descriptionstring required

Detailed description of the vendor and services provided

category'cloud' | 'infrastructure' | 'software_as_a_service' | 'finance' | 'marketing' | 'sales' | 'hr' | 'other' required

Vendor category

status'not_assessed' | 'in_progress' | 'assessed' required

Assessment status of the vendor

inherentProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely' required

Inherent probability of risk before controls

inherentImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe' required

Inherent impact of risk before controls

residualProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely' required

Residual probability after controls are applied

residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe' required

Residual impact after controls are applied

websitestring

Vendor website URL

isSubProcessorboolean

Whether the vendor is a sub-processor

assigneeIdstring

ID of the user assigned to manage this vendor

Example request

{
  "name": "CloudTech Solutions Inc.",
  "description": "Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers.",
  "category": "cloud",
  "status": "not_assessed",
  "inherentProbability": "possible",
  "inherentImpact": "moderate",
  "residualProbability": "unlikely",
  "residualImpact": "minor",
  "website": "https://www.cloudtechsolutions.com",
  "assigneeId": "mem_abc123def456"
}

Response

Vendor created successfully

idstring

Vendor ID

namestring

Vendor name

descriptionstring

Vendor description

category'cloud' | 'infrastructure' | 'software_as_a_service' | 'finance' | 'marketing' | 'sales' | 'hr' | 'other'
status'not_assessed' | 'in_progress' | 'assessed'
inherentProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
inherentImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
residualProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
websitestring nullable
organizationIdstring
assigneeIdstring nullable

ID of the user assigned to manage this vendor

createdAtstring date-time

When the vendor was created

updatedAtstring date-time

When the vendor was last updated

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "id": "vnd_abc123def456",
  "name": "CloudTech Solutions Inc.",
  "description": "Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers.",
  "category": "cloud",
  "status": "not_assessed",
  "inherentProbability": "possible",
  "inherentImpact": "moderate",
  "residualProbability": "unlikely",
  "residualImpact": "minor",
  "website": "https://www.cloudtechsolutions.com",
  "organizationId": "org_abc123def456",
  "assigneeId": "mem_abc123def456",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}