client-api-relationship-rest-resource

Mark a relationship as not onboarded

put/api/v1/relationships/{id}/offboard

Request

Base URL
https://app.visotrust.com
Auth
none declared
TypeScript
https://skmtc.dev/visotrust/apis/viso-trust-api-documentation/docs/api/v1/relationships/:id/offboard/put.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

idinteger

namestring required

homepagestring

descriptionstring

businessUnitstring

createdDatestring date-time

updatedDatestring date-time

recertificationDatestring date-time

status'ARCHIVED' | 'NOT_ONBOARDED' | 'ONBOARDED' | 'PURGED'

inherentRisk'NO_CONTEXT' | 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME'

inherentRiskScorenumber float

residualRisk'NO_CONTEXT' | 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME'

residualRiskScorenumber float

isTransitionalboolean

recertificationType'MANUAL' | 'AUTOMATIC' | 'NONE'

tagsstring[]

tierstring

complianceStandardsstring[]

riskAcceptanceStatus'RISK_ACCEPTED' | 'REVIEW_NEEDED' | 'REMEDIATION_REQUESTED'

externalIdstring

productIdstring uuid

productNamestring

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