Provides access to the policies that are part of a Hyperproof organization.
Hyperproof API
//
Get Policy Version
Policy Versions API (1.0)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi
Hyperproof US
https://api.hyperproof.app/v1/policyversions
Hyperproof Gov
https://api.hyperproofgov.app/v1/policyversions
Hyperproof EU
https://api.hyperproof.eu/v1/policyversions
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/?policyId=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
[ { "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "policyId": "85604927-8912-4471-8db6-480571dc78ce ", "documentId": "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa", "name": "Password Policy Version", "ownerId": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatus": "approval", "revisionStatusUpdatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatusUpdatedOn": "2025-06-15T18:26:10.0053650+00:00", "nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00", "nextReviewDate": "2025-06-16T18:26:10.0053650+00:00", "approvedDate": "2025-06-15T18:26:10.0053650+00:00", "retiredDate": "2025-06-15T18:26:10.0053650+00:00", "effectiveDate": "2025-06-12T18:26:10.0053650+00:00", "publishedUrl": "www.hyperproof.io", "shareLink": "www.hyperproof.io", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2025-01-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2025-01-12T18:26:10.0053650+00:00", "status": "active", "permissions": [] } ]
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/?policyId=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Password Policy Version",
"revisionStatus": "approval",
"nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00",
"nextReviewDate": "2025-06-16T18:26:10.0053650+00:00",
"approvedDate": "2025-06-15T18:26:10.0053650+00:00",
"retiredDate": "2025-06-15T18:26:10.0053650+00:00",
"effectiveDate": "2025-06-12T18:26:10.0053650+00:00",
"publishedUrl": "www.google.com"
}'Response
application/json
{ "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "policyId": "85604927-8912-4471-8db6-480571dc78ce ", "documentId": "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa", "name": "Password Policy Version", "ownerId": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatus": "approval", "revisionStatusUpdatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatusUpdatedOn": "2025-06-15T18:26:10.0053650+00:00", "nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00", "nextReviewDate": "2025-06-16T18:26:10.0053650+00:00", "approvedDate": "2025-06-15T18:26:10.0053650+00:00", "retiredDate": "2025-06-15T18:26:10.0053650+00:00", "effectiveDate": "2025-06-12T18:26:10.0053650+00:00", "publishedUrl": "www.hyperproof.io", "shareLink": "www.hyperproof.io", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2025-01-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2025-01-12T18:26:10.0053650+00:00", "status": "active", "permissions": [] }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions/{versionId}
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions/{versionId}
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions/{versionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "policyId": "85604927-8912-4471-8db6-480571dc78ce ", "documentId": "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa", "name": "Password Policy Version", "ownerId": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatus": "approval", "revisionStatusUpdatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatusUpdatedOn": "2025-06-15T18:26:10.0053650+00:00", "nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00", "nextReviewDate": "2025-06-16T18:26:10.0053650+00:00", "approvedDate": "2025-06-15T18:26:10.0053650+00:00", "retiredDate": "2025-06-15T18:26:10.0053650+00:00", "effectiveDate": "2025-06-12T18:26:10.0053650+00:00", "publishedUrl": "www.hyperproof.io", "shareLink": "www.hyperproof.io", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2025-01-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2025-01-12T18:26:10.0053650+00:00", "status": "active", "permissions": [] }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions/{versionId}
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions/{versionId}
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions/{versionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}?policyId=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Password Policy Version",
"revisionStatus": "approval",
"status": "active",
"nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00",
"nextReviewDate": "2025-06-16T18:26:10.0053650+00:00",
"approvedDate": "2025-06-15T18:26:10.0053650+00:00",
"retiredDate": "2025-06-15T18:26:10.0053650+00:00",
"effectiveDate": "2025-06-12T18:26:10.0053650+00:00",
"publishedUrl": "www.google.com",
"shareLink": "www.google.com",
"ownerId": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
"clearNextReviewDate": false,
"clearNextRevisionDate": false
}'Response
application/json
{ "id": "d88d505d-5199-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "policyId": "85604927-8912-4471-8db6-480571dc78ce ", "documentId": "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa", "name": "Password Policy Version", "ownerId": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatus": "approval", "revisionStatusUpdatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "revisionStatusUpdatedOn": "2025-06-15T18:26:10.0053650+00:00", "nextRevisionDate": "2025-06-15T18:26:10.0053650+00:00", "nextReviewDate": "2025-06-16T18:26:10.0053650+00:00", "approvedDate": "2025-06-15T18:26:10.0053650+00:00", "retiredDate": "2025-06-15T18:26:10.0053650+00:00", "effectiveDate": "2025-06-12T18:26:10.0053650+00:00", "publishedUrl": "www.hyperproof.io", "shareLink": "www.hyperproof.io", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2025-01-12T18:26:10.0053650+00:00", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedOn": "2025-01-12T18:26:10.0053650+00:00", "status": "active", "permissions": [] }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}/proof
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions/{versionId}/proof
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions/{versionId}/proof
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions/{versionId}/proof
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}/proof?policyId=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data'Success.
Unique identifier of the user who owns the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
The date the proof was uploaded (ISO-8601 format)
Example: "2023-09-12T20:59:47.694353Z"
Status of the proof item
Enum"active""archived""deleted""pending""canceled"
Example: "active"
Unique identifier of the user who created the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
The date the proof was created (ISO-8601 format)
Example: "2023-09-12T20:59:47.694353Z"
Unique identifier of the user who last updated the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
Response
application/json
{ "id": "4eb909de-51af-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "filename": "example.txt", "contentType": "text/plain", "fileExtension": "txt", "size": 627, "version": 0, "source": "localComputer", "ownedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "uploadedOn": "2023-09-12T20:59:47.6943530+00:00", "isPrivate": false, "status": "active", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T20:59:47.6943530+00:00", "updatedOn": "2023-09-12T20:59:47.6943530+00:00" }
- Mock serverhttps://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}/documents
- Hyperproof UShttps://api.hyperproof.app/v1/policyversions/{versionId}/documents
- Hyperproof Govhttps://api.hyperproofgov.app/v1/policyversions/{versionId}/documents
- Hyperproof EUhttps://api.hyperproof.eu/v1/policyversions/{versionId}/documents
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}/documents?policyId=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data'Success.
Unique identifier of the user who owns the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
The date the proof was uploaded (ISO-8601 format)
Example: "2023-09-12T20:59:47.694353Z"
Status of the proof item
Enum"active""archived""deleted""pending""canceled"
Example: "active"
Unique identifier of the user who created the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
The date the proof was created (ISO-8601 format)
Example: "2023-09-12T20:59:47.694353Z"
Unique identifier of the user who last updated the proof item
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
Response
application/json
{ "id": "4eb909de-51af-11ee-a644-522476618ae8", "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8", "filename": "example.txt", "contentType": "text/plain", "fileExtension": "txt", "size": 627, "version": 0, "source": "localComputer", "ownedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "uploadedOn": "2023-09-12T20:59:47.6943530+00:00", "isPrivate": false, "status": "active", "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987", "createdOn": "2023-09-12T20:59:47.6943530+00:00", "updatedOn": "2023-09-12T20:59:47.6943530+00:00" }