VIvisotrust
client-api-assessment-rest-resource

Start an Assessment

post/api/v1/assessments

Request

Request body multipart/form-data

requeststring 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 }

filesstring[]

Any files to associate with the assessment

Response

OK

idinteger
status'NOT_ASSESSED' | 'AWAITING_REMEDIATION' | 'STARTED' | 'REVIEW_STARTED' | 'AUDIT_COMPLETED' | 'COMPLETED' | 'CANCELLED' | 'DELETED' | 'COLLECTING_INFORMATION' | 'EXPIRED'
assessmentTypestring
sentToFirstNamestring
sentToLastNamestring
createdReason'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'
sentToEmailstring
createdDatestring date-time
summarystring
expirationDatestring date-time
completedDatestring date-time
requestedAuditTypesstring[]
aiProcessingOnlyboolean
noVendorResponseAction'CLOSE_COLLECTION_REQUEST' | 'NOTIFY_ME'
collectionTimeline'SEVEN_DAYS' | 'FOURTEEN_DAYS' | 'THIRTY_DAYS' | 'SIXTY_DAYS' | 'NINETY_DAYS' | 'ONE_HUNDRED_TWENTY_DAYS'
followupTimeline'SEVEN_DAYS' | 'FOURTEEN_DAYS' | 'THIRTY_DAYS' | 'SIXTY_DAYS' | 'NINETY_DAYS'
followupRiskThreshold'NO_CONTEXT' | 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME'
followupType'MANUAL' | 'AUTOMATIC' | 'CONCIERGE'
updatedDatestring date-time
phaseDatestring date-time
requestedArtifactCollectionboolean

Changes

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