OVI Reference
Create an OVI Reference to be embedded within the document. This unique reference will serve as a secure and verifiable identifier for the document's content.
API Endpoint
POST
https://api.ovcode.com/ovcode-file/api/v1/reference/generator
Request Headers
Ocp-Apim-Subscription-KeyYour Enterprise Subscription KeyApi-KeyYour Enterprise Project API Key
Request Body
No Content
API Response
Success{
"success": true,
"data": {
"reference": "S-550e8400-e29b-41d4-a716-446655440000",
"encrypted_reference": "N2brV1NPvbyyhrHPLNPjPJLQRlWHrB+f2YJbPefKLKCp/OGUSTVlplhVgBKbD+r+",
"verification_link": "https://ovcode.com/v/S-550e8400-e29b-41d4-a716-446655440000"
},
"error": null
}
Error
{
"success": false,
"data": null,
"error": "<Error Message>"
}
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
201 | Created |
204 | No Content |
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
415 | Unsupported Media Type |
500 | Internal Server Error |