Skip to content

Policy Versions API (1.0)

Provides access to the policies that are part of a Hyperproof organization.

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

Get Policy Versions

Request

GET /{policyId}

Description

Retrieves details of all policy versions linked to a specific policy, including version metadata, content, and associated documents or proof.

Security
oauth2
Query
policyIdstringrequired

Gets policy versions by this policy ID.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/?policyId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring
Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring
Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
policyIdstring
Example: "85604927-8912-4471-8db6-480571dc78ce "
documentIdstring
Example: "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa"
namestring
Example: "Password Policy Version"
ownerIdstring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusstring(PolicyVersionStatus)
Enum"approval""draft""effective""retired"
revisionStatusUpdatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusUpdatedOnstring
Example: "2025-06-15T18:26:10.005365Z"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.hyperproof.io"
shareLinkstring
Example: "www.hyperproof.io"
createdBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring
Example: "2025-01-12T18:26:10.005365Z"
updatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring
Example: "2025-01-12T18:26:10.005365Z"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
permissionsArray of strings
Example: []
]
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": [] } ]

Add Policy Version

Request

POST /{policyId}

Description

Creates a new version of an existing policy identified by its ID, capturing updated content, metadata, or compliance references.

Security
oauth2
Query
policyIdstringrequired

Gets policy versions by this policy ID.

Bodyapplication/json
namestringrequired
Example: "Password Policy Version"
revisionStatusstring(PolicyVersionStatus)required
Enum"approval""draft""effective""retired"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.google.com"
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"
  }'

Responses

Success.

Bodyapplication/json
idstring
Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring
Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
policyIdstring
Example: "85604927-8912-4471-8db6-480571dc78ce "
documentIdstring
Example: "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa"
namestring
Example: "Password Policy Version"
ownerIdstring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusstring(PolicyVersionStatus)
Enum"approval""draft""effective""retired"
revisionStatusUpdatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusUpdatedOnstring
Example: "2025-06-15T18:26:10.005365Z"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.hyperproof.io"
shareLinkstring
Example: "www.hyperproof.io"
createdBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring
Example: "2025-01-12T18:26:10.005365Z"
updatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring
Example: "2025-01-12T18:26:10.005365Z"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
permissionsArray of strings
Example: []
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": [] }

Get Policy Version

Request

GET /{versionId}

Description

Retrieves details of a specific policy version by its unique ID, including version metadata, content, and associated documents or proof.

Security
oauth2
Path
versionIdstringrequired

Unique ID of the policy version.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/policy-versions/policyversions.openapi/{versionId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring
Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring
Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
policyIdstring
Example: "85604927-8912-4471-8db6-480571dc78ce "
documentIdstring
Example: "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa"
namestring
Example: "Password Policy Version"
ownerIdstring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusstring(PolicyVersionStatus)
Enum"approval""draft""effective""retired"
revisionStatusUpdatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusUpdatedOnstring
Example: "2025-06-15T18:26:10.005365Z"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.hyperproof.io"
shareLinkstring
Example: "www.hyperproof.io"
createdBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring
Example: "2025-01-12T18:26:10.005365Z"
updatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring
Example: "2025-01-12T18:26:10.005365Z"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
permissionsArray of strings
Example: []
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": [] }

Update a single policy version

Request

PATCH /{versionId}?policyId={policyId}

Description

Updates an existing policy version, allowing modifications to its content, metadata, or associated references.

Security
oauth2
Path
versionIdstringrequired

Unique ID of the policy version.

Query
policyIdstringrequired

Gets policy versions by this policy ID.

Bodyapplication/json
namestring
Example: "Password Policy Version"
revisionStatusstring(PolicyVersionStatus)
Enum"approval""draft""effective""retired"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.google.com"
shareLinkstring
Example: "www.google.com"
ownerIdstring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
clearNextReviewDateboolean
clearNextRevisionDateboolean
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
  }'

Responses

Success.

Bodyapplication/json
idstring
Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring
Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
policyIdstring
Example: "85604927-8912-4471-8db6-480571dc78ce "
documentIdstring
Example: "cf0bedbe-6ecd-46b1-a84e-07018f61c2aa"
namestring
Example: "Password Policy Version"
ownerIdstring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusstring(PolicyVersionStatus)
Enum"approval""draft""effective""retired"
revisionStatusUpdatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
revisionStatusUpdatedOnstring
Example: "2025-06-15T18:26:10.005365Z"
nextRevisionDatestring
Example: "2025-06-15T18:26:10.005365Z"
nextReviewDatestring
Example: "2025-06-16T18:26:10.005365Z"
approvedDatestring
Example: "2025-06-15T18:26:10.005365Z"
retiredDatestring
Example: "2025-06-15T18:26:10.005365Z"
effectiveDatestring
Example: "2025-06-12T18:26:10.005365Z"
publishedUrlstring
Example: "www.hyperproof.io"
shareLinkstring
Example: "www.hyperproof.io"
createdBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring
Example: "2025-01-12T18:26:10.005365Z"
updatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring
Example: "2025-01-12T18:26:10.005365Z"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
permissionsArray of strings
Example: []
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": [] }

Add Policy Version Proof

Request

POST /{versionId}/proof?policyId={policyId}

Description

Adds a proof item to a specific policy version, linking evidence or supporting documentation to demonstrate compliance.

Security
oauth2
Path
versionIdstringrequired

Unique ID of the policy version.

Query
policyIdstringrequired

Unique ID of the policy version's parent policy.

Bodymultipart/form-data
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'

Responses

Success.

Bodyapplication/json
idstring

Unique identifier for the proof item

Example: "4eb909de-51af-11ee-a644-522476618ae8"
orgIdstring

Unique identifier for the organization

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
filenamestring

Name of the uploaded file

Example: "example.txt"
nameOverridestring

Name of proof Hyperproof given by Hyperproof user

contentTypestring

MIME type of the file (e.g.,text/plain)

Example: "text/plain"
fileExtensionstring

File extension (e.g.,txt)

Example: "txt"
sizenumber

File size in bytes

Example: 627
versioninteger

Version of the proof item

sourcestring

Source of the file (e.g.,localComputer)

Example: "localComputer"
sourceVersioninteger

The version of the proof maintained by the source system

ownedBystring

Unique identifier of the user who owns the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
isPrivateboolean

Whether the proof item is private

uploadedOnstring

The date the proof was uploaded (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
statusstring

Status of the proof item

Enum"active""archived""deleted""pending""canceled"
Example: "active"
createdBystring

Unique identifier of the user who created the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring

The date the proof was created (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
updatedBystring

Unique identifier of the user who last updated the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring

The date the proof was updated (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
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" }

Add a Policy Version Document

Request

POST /{versionId}/documents?policyId={policyId}

Description

Adds a source document to a specific policy version, linking supporting evidence or reference materials to that version.

Security
oauth2
Path
versionIdstringrequired

Unique ID of the policy version.

Query
policyIdstringrequired

Unique ID of the policy version's parent policy.

Bodymultipart/form-data
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'

Responses

Success.

Bodyapplication/json
idstring

Unique identifier for the proof item

Example: "4eb909de-51af-11ee-a644-522476618ae8"
orgIdstring

Unique identifier for the organization

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
filenamestring

Name of the uploaded file

Example: "example.txt"
nameOverridestring

Name of proof Hyperproof given by Hyperproof user

contentTypestring

MIME type of the file (e.g.,text/plain)

Example: "text/plain"
fileExtensionstring

File extension (e.g.,txt)

Example: "txt"
sizenumber

File size in bytes

Example: 627
versioninteger

Version of the proof item

sourcestring

Source of the file (e.g.,localComputer)

Example: "localComputer"
sourceVersioninteger

The version of the proof maintained by the source system

ownedBystring

Unique identifier of the user who owns the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
isPrivateboolean

Whether the proof item is private

uploadedOnstring

The date the proof was uploaded (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
statusstring

Status of the proof item

Enum"active""archived""deleted""pending""canceled"
Example: "active"
createdBystring

Unique identifier of the user who created the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring

The date the proof was created (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
updatedBystring

Unique identifier of the user who last updated the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring

The date the proof was updated (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
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" }