POST api/superadmin/vendors/documents/{documentId}/verify

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

integer

Required

Body Parameters

DocumentVerificationRequest
NameDescriptionTypeAdditional information
Verified

boolean

Required

Notes

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Verified": true,
  "Notes": "sample string 2"
}

application/xml, text/xml

Sample:
<DocumentVerificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Notes>sample string 2</Notes>
  <Verified>true</Verified>
</DocumentVerificationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentVerificationRequest'.

Response Information

Resource Description

DocumentVerificationResult
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

DocumentId

integer

None.

Verified

boolean

None.

VerificationDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "DocumentId": 3,
  "Verified": true,
  "VerificationDate": "2026-03-26T03:51:08.7191091+02:00"
}

application/xml, text/xml

Sample:
<DocumentVerificationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <DocumentId>3</DocumentId>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <VerificationDate>2026-03-26T03:51:08.7191091+02:00</VerificationDate>
  <Verified>true</Verified>
</DocumentVerificationResult>