# papi Panorays Public API Version: 2 ## Servers ``` https://api.panoraysapp.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [papi](https://panorays-papi-v2-documentation.redocly.app/_bundle/swagger.yaml) ## Supplier Use these routes to access and update your suppliers. ### Add Supplier - [POST /v2/suppliers](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/postsupplier.md): Add a new supplier to the portfolio. If a questionnaire is also sent via this request, and you have more than 1 questionnaire template, the latest template will be sent. For information regarding which template is the latest one, please contact Panorays Support. It is recommended to use “Send questionnaire” POST request to send a questionnaire instead. ### Get Suppliers - [GET /v2/suppliers](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/getsuppliers.md): Get all of your suppliers ### Get Supplier - [GET /v2/suppliers/{id}](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/getsupplier.md): Get a single supplier by id ### Update Supplier - [PUT /v2/suppliers/{supplierId}](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/putsupplier.md): Update a single supplier by id. ### Delete Supplier - [DELETE /v2/suppliers/{supplierId}](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/deletesupplier.md): Delete a single supplier by id. ### Get Suppliers Tests - [GET /v2/suppliers/{supplierId}/tests](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/getsupplierstests.md): This endpoint will return data and information about the requested supplier's tests performed as part of the evaluation. ### Create Supplier Assets - [POST /v2/suppliers/{supplierId}/assets](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/postsupplierassets.md): This endpoint will create assets of a supplier. ### Get Supplier Assets - [GET /v2/suppliers/{supplierId}/assets](https://panorays-papi-v2-documentation.redocly.app/swagger/supplier/getsupplierassets.md): Get assets of a specific supplier. ## Segment ### Update Segment - [PUT /v2/suppliers/{supplierId}/segments/{segmentId}](https://panorays-papi-v2-documentation.redocly.app/swagger/segment/putsegment.md): Update a single segment by id. ### Get Segment by ID - [GET /v2/suppliers/{supplierId}/segments/{segmentId}](https://panorays-papi-v2-documentation.redocly.app/swagger/segment/getsegment.md): Retrieve a single segment by supplier ID and segment ID. ### Delete Segment - [DELETE /v2/suppliers/{supplierId}/segments/{segmentId}](https://panorays-papi-v2-documentation.redocly.app/swagger/segment/deletesegment.md): Delete a single segment by id. ### Create Segment - [POST /v2/suppliers/{supplierId}/segments](https://panorays-papi-v2-documentation.redocly.app/swagger/segment/postsegment.md): Create a single segment. ### Get Segments - [GET /v2/segments](https://panorays-papi-v2-documentation.redocly.app/swagger/segment/getsegments.md): Get all segments optionally filtered by supplier ## Posture ### Get Supplier Posture - [GET /v2/suppliers/{supplierId}/posture](https://panorays-papi-v2-documentation.redocly.app/swagger/posture/getsupplierposture.md): This endpoint will return data and information about the requested supplier's posture in the portfolio. ### Get Company Posture - [GET /v2/posture](https://panorays-papi-v2-documentation.redocly.app/swagger/posture/getposture.md): This endpoint will return data and information about the posture in the portfolio. ## Portfolio ### Get Company Portfolios - [GET /v2/portfolios](https://panorays-papi-v2-documentation.redocly.app/swagger/portfolio/getportfolios.md): This endpoint will return the portfolios and the supplier’s id’s under it. ## Asset ### Get Company Assets - [GET /v2/assets](https://panorays-papi-v2-documentation.redocly.app/swagger/asset/getassets.md): The endpoint is used to get all company assets. ### Create Company Assets - [POST /v2/assets](https://panorays-papi-v2-documentation.redocly.app/swagger/asset/postassets.md): The endpoint is used to create company assets. ## Finding ### Get Company Finding - [GET /v2/findings/{id}](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getcompanyfinding.md): This endpoint will return data and information about a specific finding. ### Get Company Findings - [GET /v2/findings](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getcompanyfindings.md): This endpoint will return data and information about findings in the portfolio. ### Get Supplier Report - [GET /v2/suppliers/{supplierId}/report/findings](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getfindingsreport.md): This endpoint will return csv with information about findings in the portfolio. ### Get Supplier Finding by ID - [GET /v2/suppliers/{supplierId}/findings/{findingId}](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getsupplierfinding.md): This endpoint will return data and information about a supplier's specific finding. ### Get Supplier Findings - [GET /v2/suppliers/{supplierId}/findings](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getsupplierfindings.md): This endpoint will return data and information about findings in the portfolio. ### Get Supplier Assessment Report - [GET /v2/suppliers/{supplierId}/report/summary](https://panorays-papi-v2-documentation.redocly.app/swagger/finding/getassessmentreport.md): This endpoint will return pdf with assessment report. ## RemediationTasks ### Get Remediation Task by ID - [GET /v2/suppliers/{supplierId}/remediation/{taskId}](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/gettaskbyid.md): This endpoint is used to get a specific remediation task of a supplier by id. ### Update Remediation Task by ID - [PUT /v2/suppliers/{supplierId}/remediation/{taskId}](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/updatetaskbyid.md): This endpoint is used to update a specific remediation task of a supplier by id. ### Create internal general task - [POST /v2/suppliers/{supplierId}/remediation/general_internal](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/postinternalgeneraltask.md): Create a general task assigned to a member of your company about this supplier. ### Create external general task - [POST /v2/suppliers/{supplierId}/remediation/general_external](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/postexternalgeneraltask.md): Create a general task assigned to supplier-side points-of-contact. ### Create a finding remediation task - [POST /v2/suppliers/{supplierId}/remediation/criterion](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/postcriterionremediationtask.md): Create a remediation task for a single criterion. ### Create a questionnaire remediation task - [POST /v2/suppliers/{supplierId}/remediation/question](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/postquestionremediationtask.md): Create a remediation task for a single question in a questionnaire. ### Get Supplier Remediation Tasks - [GET /v2/suppliers/{supplierId}/remediation](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/getsupplierremediationtasks.md): The endpoint will retrieve all the remediation tasks of a specific supplier ### Delete Supplier Remediation Tasks - [DELETE /v2/suppliers/{supplierId}/remediation](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/deletesuppliertasks.md): This endpoint will delete specific tasks of a supplier. ### Get Suppliers Remediation Tasks - [GET /v2/suppliers/remediation](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/getallremediationtasks.md): The endpoint retrieves all the remediation task of all suppliers ### Delete Segment Tasks - [DELETE /v2/suppliers/{supplierId}/segment/{segmentId}/remediation](https://panorays-papi-v2-documentation.redocly.app/swagger/remediationtasks/deletesegmenttasks.md): This endpoint will delete specific tasks of a segment. ## BusinessInformation ### Get Company Business Information Template - [GET /v2/business_information](https://panorays-papi-v2-documentation.redocly.app/swagger/businessinformation/getbusinessinformation.md): The endpoint is used to get business information questions and structure ## File ### Upload Files - [POST /v2/files/upload](https://panorays-papi-v2-documentation.redocly.app/swagger/file/uploadfiles.md): Upload one or multiple files to the system. Supports bulk uploads and various file sources. Files are uploaded via multipart/form-data and can be associated with suppliers, segments, or folders for organization. ### Get File - [GET /v2/files/{fileId}](https://panorays-papi-v2-documentation.redocly.app/swagger/file/getfile.md): The endpoint is used to get related files to the company or its suppliers ### Get Supplier Files - [GET /v2/suppliers/{supplierId}/files](https://panorays-papi-v2-documentation.redocly.app/swagger/file/getsupplierfiles.md): The endpoint will retrieve all the files of a specific supplier ## Questionnaire ### Get Supplier Questionnaires Info - [GET /v2/suppliers/{supplierId}/questionnaires](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/getinquiriesinfo.md): This endpoint will return info about the latest questionnaires for each template sent to a specific supplier. ### Get Segment Questionnaires Info - [GET /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/getsegmentinquiriesinfo.md): This endpoint will return info about the latest questionnaires for each template sent to a specific segment. ### Get Supplier Questionnaire - [GET /v2/suppliers/{supplierId}/questionnaires/{questionnaireId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/getquestionnaireanswersinfo.md): This endpoint will return info about the latest questionnaires for each template sent to a specific supplier including the answers. ### Extend Questionnaire Due Date - [PUT /v2/suppliers/{supplierId}/questionnaires/{questionnaireId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/putinquiry.md): This endpoint will extend due date of a questionnaire. ### Get Segment Questionnaire - [GET /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/{questionnaireId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/getsegmentquestionnaireanswersinfo.md): This endpoint will return info about the latest questionnaire for each template sent to a specific segment including the answers. ### Extend Segment Questionnaire Due Date - [PUT /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/{questionnaireId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/putsegmentinquiry.md): This endpoint will extend due date of a segment questionnaire. ### Get Supplier Questionnaire Report - [GET /v2/suppliers/{supplierId}/report/questionnaire/{templateName}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/getinquiryreport.md): This endpoint will return pdf with questionnaire report. ### Send Questionnaire - [POST /v2/suppliers/{supplierId}/questionnaires/{templateId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/postinquiry.md): This endpoint will send questionnaire to supplier. ### Copy Questionnaires to Segment - [POST /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/copy](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/copyquestionnairestosegment.md): This endpoint will copy all supplier questionnaires to a specific segment. ### Send Segment Questionnaire - [POST /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/{templateId}](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/postsegmentinquiry.md): This endpoint will send questionnaire to segment. ### Submit Supplier Internal Questionnaire Answers - [PUT /v2/suppliers/{supplierId}/questionnaires/{questionnaireId}/answer](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/putsupplierquestionnaireanswers.md): This endpoint submits answers for an internal questionnaire for a specific supplier. ### Submit Segment Internal Questionnaire Answers - [PUT /v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/{questionnaireId}/answer](https://panorays-papi-v2-documentation.redocly.app/swagger/questionnaire/putsegmentquestionnaireanswers.md): This endpoint submits answers for an internal questionnaire for a specific segment. ## Tests ### Get Company Tests - [GET /v2/tests](https://panorays-papi-v2-documentation.redocly.app/swagger/tests/gettests.md): This endpoint returns the tests of the company. ## RiskInsights ### Get Company Risk Insights - [GET /v2/risk_insights/company](https://panorays-papi-v2-documentation.redocly.app/swagger/riskinsights/getcompanyriskinsights.md): This endpoint will return data and information about risk insights of the company. ## BusinessSnapshot ### Get Company Business Snapshot - [GET /v2/business_snapshot](https://panorays-papi-v2-documentation.redocly.app/swagger/businesssnapshot/getbusinesssnapshot.md) ### Get Supplier Business Snapshot - [GET /v2/suppliers/{supplierId}/business_snapshot](https://panorays-papi-v2-documentation.redocly.app/swagger/businesssnapshot/getsupplierbusinesssnapshotv2.md): This endpoint will return business snapshot information. ## Relationship ### Get Relationships - [GET /v2/relationships](https://panorays-papi-v2-documentation.redocly.app/swagger/relationship/getrelationships.md): This endpoint will return all defined relationships. ## Licenses ### Get License Usage - [GET /v2/licenses](https://panorays-papi-v2-documentation.redocly.app/swagger/licenses/getcompanylicenses.md): This endpoint will return data and information about licenses of the company. ## Templates ### Get Templates - [GET /v2/templates](https://panorays-papi-v2-documentation.redocly.app/swagger/templates/templatescontroller_gettemplates.md): Get all company templates ## Activity Center ### Get Company Activity Items - [GET /v2/activity](https://panorays-papi-v2-documentation.redocly.app/swagger/activity-center/getcompanyactivity.md): The endpoint is used to pull Activity Center events (audit). ## 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. ### Get All Company Tags - [GET /v2/tags](https://panorays-papi-v2-documentation.redocly.app/swagger/tags/getcompanytags.md): This endpoint will return data of the company tags. ### Create Company Tag - [POST /v2/tags](https://panorays-papi-v2-documentation.redocly.app/swagger/tags/createcompanytag.md): This endpoint will create a new tag. ### Update Company Tag - [PUT /v2/tags/{id}](https://panorays-papi-v2-documentation.redocly.app/swagger/tags/updatecompanytag.md): This endpoint will update the name of a tag. ### Delete Company Tag - [DELETE /v2/tags/{id}](https://panorays-papi-v2-documentation.redocly.app/swagger/tags/deletecompanytag.md): This endpoint will delete a tag. ## Factors ### Get Supplier Custom Factors - [GET /v2/suppliers/{supplierId}/custom-factors](https://panorays-papi-v2-documentation.redocly.app/swagger/factors/getsuppliercustomfactors.md): This endpoint will return data about custom factors of a supplier. ### Apply Custom Factors for Supplier - [POST /v2/suppliers/{supplierId}/custom-factors](https://panorays-papi-v2-documentation.redocly.app/swagger/factors/postsuppliercustomfactors.md): This endpoint will apply custom factor to a supplier. ### Get Supplier Factors - [GET /v2/suppliers/{supplierId}/factors](https://panorays-papi-v2-documentation.redocly.app/swagger/factors/getsupplierfactors.md): This endpoint will return the risk factors and custom factors for a supplier. ### Get Custom Factors - [GET /v2/factors/custom](https://panorays-papi-v2-documentation.redocly.app/swagger/factors/getcustomfactors.md): This endpoint will return data about custom factors of the company. ## CyberNewsArticles ### Get Company Cyber-News Articles - [GET /v2/cyber-news-articles](https://panorays-papi-v2-documentation.redocly.app/swagger/cybernewsarticles/getcompanycybernewsarticles.md): This endpoint will return data and information about Cyber-News articles of the company. ### Get Cyber-News Articles by Supplier IDs - [GET /v2/cyber-news-articles/suppliers](https://panorays-papi-v2-documentation.redocly.app/swagger/cybernewsarticles/getsupplierscybernewsarticles.md): This endpoint will return data and information about Cyber-News articles of the company by suppliers IDs. ## DarkWebMentions ### Get Company Dark Web Mentions - [GET /v2/dark-web-mentions](https://panorays-papi-v2-documentation.redocly.app/swagger/darkwebmentions/getcompanydarkwebmentions.md): This endpoint will return data and information about Dark Web Mentions of the company. ### Get Suppliers Dark Web Mentions - [GET /v2/dark-web-mentions/suppliers](https://panorays-papi-v2-documentation.redocly.app/swagger/darkwebmentions/getsuppliersdarkwebmentions.md): This endpoint will return data and information about Dark Web Mentions of the company suppliers. ## ReEvaluation ### Apply Re-evaluation for Supplier - [POST /v2/suppliers/{supplierId}/re-evaluation](https://panorays-papi-v2-documentation.redocly.app/swagger/reevaluation/postsupplierreevaluation.md): This endpoint will apply re evaluation to a supplier. ### Delete Re-evaluation for Supplier - [DELETE /v2/suppliers/{supplierId}/re-evaluation](https://panorays-papi-v2-documentation.redocly.app/swagger/reevaluation/deletesupplierreevaluation.md): Removes the scheduled re-evaluation for a specific supplier. ### Update Re-evaluation for Supplier - [PUT /v2/suppliers/{supplierId}/re-evaluation](https://panorays-papi-v2-documentation.redocly.app/swagger/reevaluation/putsupplierreevaluation.md): This endpoint will update the scheduled re evaluation settings for a specific supplier. ## Handshake ### Webhook Handshake - [POST /v2/hooks/handshake](https://panorays-papi-v2-documentation.redocly.app/swagger/handshake/hookhandshakev2.md): Before being able to register and receive events, a server should be registered and verified. A “Verification Handshake” will happen which will verify SSL certificate and send a POST with a body of { challenge: } to the server given. The response to the POST message should contain the given challenge hash and status 200. The verification handshake process should only happen once and will be done during the onboarding of the API by Panorays. ## Subscription ### Subscribe to Webhook - [POST /v2/hooks/subscriptions](https://panorays-papi-v2-documentation.redocly.app/swagger/subscription/hooksubscribev2.md): To enable notifications for a certain event you will need to subscribe to it using this route. ### Unsubscribe from Webhook - [DELETE /v2/hooks/subscriptions](https://panorays-papi-v2-documentation.redocly.app/swagger/subscription/hookunsubscribev2.md): To disable notifications for a certain event you will need to unsubscribe from it using this route.