UPupguard
vendors

Get onboarding request details

Returns detailed information about a specific vendor onboarding request, including vendor data and assessment links.

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

get/onboarding_request

Request

Query parameters

idinteger required

The ID of the onboarding request (survey ID)

Response

Onboarding request details response

archivedboolean

Whether the request is archived

date_completedstring date-time

When the request was completed, if applicable

date_createdstring date-time

When the request was created

due_datestring date-time

The due date for the request, if set

idinteger

The unique ID of the onboarding request (survey ID)

is_inboundboolean

Whether this is an inbound request (submitted via portal)

num_answersinteger

The total number of answered questions

num_messagesinteger

The number of messages/comments on the request

num_questionsinteger

The total number of questions in the questionnaire

priority'low' | 'medium' | 'high' | 'critical'

The priority level of the request

status'Complete' | 'Sent' | 'In Progress' | 'In Review' | 'Assessment Underway' | 'Awaiting Review'

The current status of the request

Example response

{
  "assignee": {
    "email": "john@example.com",
    "name": "John Doe"
  },
  "completed_by": {
    "email": "john@example.com",
    "name": "John Doe"
  },
  "date_completed": "2024-02-01T15:30:00Z",
  "date_created": "2024-01-15T10:00:00Z",
  "due_date": "2024-03-01T00:00:00Z",
  "id": 12345,
  "is_inbound": true,
  "linked_risk_assessment": {
    "id": 456,
    "name": "Annual Review",
    "published_at": "2024-02-01T15:30:00Z"
  },
  "num_answers": 50,
  "num_messages": 3,
  "num_questions": 50,
  "outcome": {
    "category": "positive",
    "comment": "Approved with conditions",
    "description": "Vendor approved for use",
    "name": "Approved"
  },
  "priority": "high",
  "status": "Complete",
  "submitted_by": {
    "email": "john@example.com",
    "name": "John Doe"
  },
  "vendor": {
    "hostname": "acme.com",
    "id": 789,
    "is_monitored": true,
    "labels": [
      "SOC2",
      "PCI"
    ],
    "lifecycle_stage": "onboarding",
    "name": "Acme Corp",
    "portfolios": [
      "Production"
    ],
    "score": 750,
    "tier": "Critical"
  }
}

Changes

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