Skip to content
/
Get custom factors

papi (2)

Panorays Public API

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Support
support@panorays.com
Languages
Servers
Mock server
https://panorays-papi-v2-documentation.redocly.app/_mock/swagger
https://api.panoraysapp.com

Supplier

Use these routes to access and update your suppliers.

Operations

Segment

Operations

Posture

Operations

Portfolio

Operations

Asset

Operations

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

Questionnaire

Operations

RiskInsights

Operations

BusinessSnapshot

Operations

Relationship

Operations

Licenses

Operations

Templates

Operations

Activity Center

Operations

Tags

Tag actions (Create, Delete, Get, Update) apply to company tags only. Tags can’t be updated via the supplier endpoint, as they may link to multiple suppliers. When a company tag is updated/deleted, all associated suppliers are automatically updated — no separate supplier update is needed.

Operations

Factors

Operations

Apply custom factors for supplier

Request

This endpoint will apply custom factor to a supplier.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

Bodyapplication/jsonrequired
factorIdstringrequired
fileIdstring
effectnumber
commentstringrequired
curl -i -X POST \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/custom-factors' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "factorId": "string",
    "fileId": "string",
    "effect": 0,
    "comment": "string"
  }'

Responses

Array of custom factors

Bodyapplication/jsonArray [
companyIdstringrequired
supplierIdstringrequired
factorIdstringrequired
fileIdstring
effectnumber
commentstringrequired
updated_bystringrequired
added_bystringrequired
]
Response
application/json
[
  {
    "companyId": "string",
    "supplierId": "string",
    "factorId": "string",
    "fileId": "string",
    "effect": 0,
    "comment": "string",
    "updated_by": "string",
    "added_by": "string"
  }
]

Get custom factors

Request

This endpoint will return data about custom factors of the company.

Security
bearer
curl -i -X GET \
  https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/factors/custom \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Array of custom factors

Bodyapplication/jsonArray [
factor_idstringrequired

The unique identifier for the factor.

namestringrequired

The name of the factor.

factornumberrequired

The impact value for this factor

override_allowedbooleanrequired

Indicates whether overriding the impact value is allowed for this factor (true or false).

document_upload_requiredbooleanrequired

Indicates whether document upload is required for this factor (true or false).

]
Response
application/json
[
  {
    "factor_id": "string",
    "name": "string",
    "factor": 0,
    "override_allowed": true,
    "document_upload_required": true
  }
]

CyberNewsArticles

Operations

DarkWebMentions

Operations

ReEvaluation

Operations

Webhooks Intro

The hook api provides a simple way of registering to events that happen with your suppliers

Getting Started

The following steps will walk you through the process of registering and reacting to webhooks.

  1. Register an API token

If you don’t already have an API token, you can generate one through Panorays platform or contact Panorays Support at support@panorays.com.

  1. Register your app

Before you can start receiving events, register your application with Panorays using the Handshake API call.

  1. Subscribe to relevant events

You will only receive event calls for events you subscribe to using the Subscribe API call.
Note: You can unsubscribe at any time using the Unsubscribe API call.

  1. Start receiving events

You're done! From now on, you will receive notifications for every event you subscribed to.

To learn how to secure your app and ensure you handle events only from Panorays, read about Verifying requests.

Verify Requests

Panorays signs every request with a secret that's unique to your service account, using this secret you can verify that the incoming request arrived from Panorays servers.

Handshake

Operations

Subscription

Operations