Skip to main content
POST
Start an Assessment

Body

multipart/form-data
request
string
required

Information necessary to start the assessment.

Recipient details are optional. When all of recipientEmail, recipientFirstName, and recipientLastName are omitted, the assessment is started in research mode (no vendor contact). Research-mode assessments may also include any combination of uploaded files and/or publicDocumentUrls; if neither is provided, VISO will run public information search only.

Example (vendor-contact assessment): { "relationshipId": 1, "recipientEmail": "dan@example.com", "recipientFirstName": "Dan", "recipientLastName": "Example", "publicDocumentUrls": ["google.com"], "followupType": "MANUAL", "followupRiskThreshold": null, "followupTimeline": null, "collectionTimeline": null, "noVendorResponseAction": null, "aiProcessingOnly": false, "questionnaires": ["00000000-0000-0000-0000-000000000000"] }

Example (research-only assessment): { "relationshipId": 1 }

files
file[]

Any files to associate with the assessment

Response

200 - application/json

OK

id
integer<int64>
status
enum<string>
Available options:
NOT_ASSESSED,
AWAITING_REMEDIATION,
STARTED,
REVIEW_STARTED,
AUDIT_COMPLETED,
COMPLETED,
CANCELLED,
DELETED,
COLLECTING_INFORMATION
sentToEmail
string
createdDate
string<date-time>
summary
string
default:""
deprecated
expirationDate
string<date-time>
completedDate
string<date-time>
requestedAuditTypes
string[]
aiProcessingOnly
boolean
noVendorResponseAction
enum<string>
Available options:
CLOSE_COLLECTION_REQUEST,
NOTIFY_ME
collectionTimeline
enum<string>
Available options:
SEVEN_DAYS,
FOURTEEN_DAYS,
THIRTY_DAYS,
SIXTY_DAYS,
NINETY_DAYS,
ONE_HUNDRED_TWENTY_DAYS
followupTimeline
enum<string>
Available options:
SEVEN_DAYS,
FOURTEEN_DAYS,
THIRTY_DAYS,
SIXTY_DAYS,
NINETY_DAYS
followupRiskThreshold
enum<string>
Available options:
NO_CONTEXT,
LOW,
MEDIUM,
HIGH,
EXTREME
followupType
enum<string>
Available options:
MANUAL,
AUTOMATIC,
CONCIERGE
statusHistories
object[]
createdReason
enum<string>
Available options:
INITIAL_ASSESSMENT,
ARTIFACTS_EXPIRED,
RECERTIFICATION_INITIATED,
BUSINESS_CASE_OR_DATA_TYPES_CHANGED,
THIRD_PARTY_CONTACT_UPDATED,
ARTIFACTS_UPLOADED_ON_RELATIONSHIP,
REMEDIATION,
RISK_ADVISORY_RESPONSE,
INSTANT_ANALYSIS,
PUBLIC_SEARCH
assessmentType
string
sentToFirstName
string
sentToLastName
string
recommendations
object[]
updatedDate
string<date-time>
phaseDate
string<date-time>
sentBy
object
requestedArtifactCollection
boolean