Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
documentSubmissions

Find and update a documentSubmission

Partially update one existing documentSubmission

put/api/servicecompliancev2/documentSubmissions/{identifier}

Path parameters

identifierstring uuid required

documentSubmission unique identifier

Request body

uuidstring
companyUuidstring
workerUuidstring required
partnerExternalIdstring
documentTypeUuidstring required
expirableFieldUuidstring
status'PENDING' | 'APPROVED' | 'REJECTED' required
imageWasAutoRotatedboolean
importSource'HIRE' | 'COMPLIANCE_V1_WORKERCOMPLIANCECHECK_CURRENTLY_APPROVED' | 'COMPLIANCE_V1_WORKERCOMPLIANCEGROUP_PENDING' | 'COMPLIANCE_V2_WEEKLY_STUART_RTW_DOC_UPLOAD' | 'CHECKR'
importSourceIdstring
importSourceDetailstring
ocrResponseUuidstring
ocrJobUuidstring
isExpiredboolean
isExpiringSoonboolean
expirationDateOverridestring date-time
isFlaggedAsFraudboolean
createdAtstring date-time
createdBystring
updatedAtstring date-time
updatedBystring
action'approve' | 'reject' | 'edit' | 'reportAutoRotateIssue'
bypassAutoRejectionboolean

Response

updated documentSubmission.

Example response

{
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}