Thanks to visit codestin.com
Credit goes to developer.hyperproof.app

Skip to content
Hyperproof API
/
/
Proof API

Proof API (1.0)

Provides access to the proof that is part of a Hyperproof organization.

Download OpenAPI description
proof.openapi.json
proof.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi
Hyperproof US
https://api.hyperproof.app/v1/proof
Hyperproof EU
https://api.hyperproof.eu/v1/proof
Hyperproof Gov
https://api.hyperproofgov.app/v1/proof

Get Proof Metadata Collection

Request

GET /

Description

Retrieves metadata for a specified organization, control, label, or task, providing key contextual and configuration details.

Security
oauth2
Query
limitnumber<= 500

The maximum number of proof to return.

Default 25
sortBystring

The proof property to use when sorting the result.

Default "uploadedOn"
Enum"createdBy""uploadedOn"
sortDirectionstring

The direction the data should be sorted.

Default "desc"
Enum"asc""desc"
nextTokenstring

Token returned from a previous call to retrieve proof.

objectTypestring

Linked object type.

Enum"control""label"
objectIdstring

Unique ID of the linked object.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi/?limit=25&sortBy=createdBy&sortDirection=asc&nextToken=string&objectType=control&objectId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
dataArray of objects(ProofCollection)

A collection of proof.

Example: [{"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.694353Z","isPrivate":false,"status":"active","createdBy":"82d7c228-8bcd-11e9-a94b-ab3de8494987","updatedBy":"82d7c228-8bcd-11e9-a94b-ab3de8494987","createdOn":"2023-09-12T20:59:47.694353Z","updatedOn":"2023-09-12T20:59:47.694353Z"}]
nextTokenstring
Response
application/json
{
  "data": [
    { … }
  ],
  "nextToken": "string"
}

Add Proof

Request

POST /

Description

Adds a new proof item to an organization, storing evidence details, file attachments, and metadata for compliance tracking.

Uploading Testable CSV proof

When sending CSV files, you need to explicitly declare the type as text/csv. This tells Hyperproof to treat the uploaded blob as tabular data. This allows the CSV proof to be usable in automated tests.

curl --request POST \
  --url https://api.hyperproof.app/v1/proof \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --form proof=@"./policies/AcceptableUse.csv:type=text/csv" \
  --form hp-proof-owned-by="$USER_ID"
  --form contentType="text/csv"
Security
oauth2
Bodymultipart/form-data
curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi/ \
  -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"
}

Get Proof Metadata

Request

GET {proofId}

Description

Retrieves metadata for a specific proof item in an organization by its ID, including details such as source, status, and associated objects.

Security
oauth2
Path
proofIdstringrequired

Unique ID of the proof

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

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"
}

Update Proof

Request

PATCH /{proofId}

Description

Updates an existing proof file identified by its ID, allowing modification to whether it is private. Also allows adding the schema file for proof uploaded in CSV format to make that file compatible with the automated testing feature.

Updating Testable CSV proof

After uploading a CSV file intended for automated testing, a PATCH request should be made to create the schema to be tested. The body of the request will define the CSV fields and types for the automated testing feature. Available types include text , number , boolean , and date.

curl --request PATCH 'https://api.hyperproof.app/v1/proof/:proofid' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "isPrivate": false,
    "schema": {
        "class": "CsvFileSchema",
        "fields": [{
            "name": "Name",
            "type": "text"
        }, {
            "name": "Email",
            "type": "text"
        }]
    }
}'
Security
oauth2
Path
proofIdstringrequired

Unique identifier of the proof to update.

Bodyapplication/json
isPrivateboolean

Whether the proof item is private.

schemaobject(CsvFileSchema)

Schema definition for CSV file proof data.

Example: {"class":"CsvFileSchema","fields":[{"name":"Name","type":"text"},{"name":"Access Level","type":"number"},{"name":"Last Access","type":"date"},{"name":"MFA Enabled","type":"boolean"}]}
curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi/{proofId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "isPrivate": false,
    "schema": {
      "class": "CsvFileSchema",
      "fields": [
        {
          "name": "Name",
          "type": "text"
        },
        {
          "name": "Email",
          "type": "text"
        }
      ]
    }
  }'

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.694353Z",
  "isPrivate": false,
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T20:59:47.694353Z",
  "updatedOn": "2023-09-12T20:59:47.694353Z"
}

Add Proof Version

Request

POST /{proofId}/versions

Description

Creates a new version of an existing proof item, capturing updated evidence details, files, or metadata.

Security
oauth2
Path
proofIdstringrequired

Unique ID of the proof

Bodymultipart/form-data
curl -i -X POST \
  'https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi/{proofId}/versions' \
  -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"
}

Gets the contents of a proof.

Request

GET /{proofId}/contents

Description

Retrieves the content of a proof item as a downloadable file, providing access to the original evidence data.

Security
oauth2
Path
proofIdstringrequired

Unique ID of the proof

Query
versionnumber

The proof version to retrieve.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/proof/proof.openapi/{proofId}/contents?version=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Body*/*
string(binary)
Response
*/*
null
® 2026 Hyperproof All Rights Reserved.