This article will take you through the process of extracting and interacting with your data using the Open API integration in the Phinity platform.
On the welcome page of the Phinity platform, click on the cogwheel icon.
Navigate to the 'API Integrations' tile in the Control Panel.
You will then be directed to the below screen, you can click on 'Phinity External Accesss'.
Click on 'Generate Secret Key' if you have not already generated one.
Click on 'Copy' to copy your secret key.
Click the 'Here' link to access our swagger documentation.
On our swagger documentation, you can click on the relevant solution that you want to query.
Paste your secret key into the authorisation field. Once you have provided your secret key you can click on the try it out button and you will receive your data.
You need to provide your secret key for all swagger requests made.
The data points available are as follows.
Triplicity
| API Name | Field | Sub Field |
| /openapi/v1/campaignslookup | ||
| id | ||
| name | ||
| assessment type id | ||
| is risk assessment | ||
| assessment group id | ||
| assessment type name | ||
| requirements url | ||
| progress percentage | ||
| status | ||
| requires review | ||
| is risk profile assessment | ||
| actual start date | ||
| auto generated from campaign id | ||
| end date | ||
| start date | ||
| campaign reviewer names | ||
| client id | ||
| client name | ||
| /openapi/v1/extracts/dataExtractTypeId=1 | ||
| name | ||
| business unit description | ||
| department description | ||
| category description | ||
| inherent risk | ||
| residual risk | ||
| campaign name | ||
| supply Wisdom Risk Rating | ||
| bitSight Rating | ||
| use Case | ||
| black Kite Company DBI | ||
| privacy Risk | ||
| black Kite Company Cyber Risk Rating | ||
| iso 27001 Certification | ||
| black Kite Company RSI | ||
| questionnaire name | ||
| assessment creation date | ||
| assessment start date | ||
| assessment end date | ||
| year assessed | ||
| assessment submit date | ||
| assessment closed date | ||
| assessment outcome | ||
| status | ||
| /openapi/v1/extracts/dataExtractTypeId=2 | ||
| third party name | ||
| third party number | ||
| service status | ||
| relationship manager name | ||
| assessment type name | ||
| campaign name | ||
| questionnaire name | ||
| business unit description | ||
| department description | ||
| category description | ||
| risk profile description | ||
| inherent risk rating | ||
| residual risk rating | ||
| assessment start date | ||
| assessment end date | ||
| assessment completion date | ||
| assessment email received | ||
| feedback received | ||
| assessment progress percentage | ||
| assessment reviewed | ||
| assessment marked as completed | ||
| supporting files uploaded | ||
| assessment outcome | ||
| /openapi/v1/extracts/dataExtractTypeId=5 | ||
| number | ||
| name | ||
| description | ||
| service status | ||
| service start date | ||
| service end date | ||
| relationship manager name | ||
| relationship manager email address | ||
| relationship manager contact number | ||
| key contact name | ||
| key contact email address | ||
| key contact contact number | ||
| department description | ||
| parent risk | ||
| business unit description | ||
| category description | ||
| risk profile description | ||
| notification required | ||
| created date | ||
| supply wisdom risk rating | ||
| bitsight rating | ||
| use case | ||
| black kite company dbi | ||
| privacy risk | ||
| black kite company cyber risk rating | ||
| iso 27001 certification | ||
| black kite company rsi | ||
| /openapi/v1/questionnaireresponses | ||
| third party name | ||
| third party id | ||
| campaign third party id | ||
| campaign id | ||
| campaign name | ||
| questionnaire id | ||
| questionnaire description | ||
| questionnaire name | ||
| section id | ||
| section description | ||
| question id | ||
| question name | ||
| question description | ||
| question response text | ||
| answer option | ||
| answer option score | ||
| question response date | ||
| question compliance percentage | ||
| client id | ||
| client name | ||
| section maturity | ||
| question maturity | ||
| /openapi/v1/questionnaires | ||
| id: 5521 | ||
| assessment type id | ||
| name | ||
| is risk assessment | ||
| created date | ||
| max score | ||
| client id | ||
| client name | ||
| /openapi/v1/riskentity/contractlookup | ||
| id | ||
| status id | ||
| contract name | ||
| contract description | ||
| email template id | ||
| contract start date | ||
| contract end date | ||
| notification days | ||
| contract type | ||
| contract type description | ||
| person contacts | ||
| client name | ||
| id | ||
| client id | ||
| name | ||
| email address | ||
| contact number | ||
| risk entity contract id | ||
| person contact type id | ||
| /openapi/v1/riskentitylookup | ||
| id | ||
| name | ||
| number | ||
| client id | ||
| solution id | ||
| client name | ||
| active | ||
| created date | ||
| service status | ||
| business unit description | ||
| department description | ||
| category description | ||
| /openapi/v1/riskentitystakeholderslookup | ||
| id | ||
| risk entity person contact type id | ||
| risk entity person contact type name | ||
| risk entity person contact type description | ||
| third party id | ||
| person contact id | ||
| person contact name | ||
| person contact number | ||
| person contact email address | ||
| client id | ||
| visible |
Procensus
| API | Field | Sub Field |
| /openapi/v1/campaignslookup | ||
| id | ||
| name | ||
| assessment type id | ||
| is risk assessment | ||
| assessment group id | ||
| assessment type name | ||
| requirements url | ||
| progress percentage | ||
| status | ||
| requires review | ||
| is risk profile assessment | ||
| actual start date | ||
| auto generated from campaign id | ||
| end date | ||
| start date | ||
| campaign reviewer names | ||
| client id | ||
| client name | ||
| /openapi/v1/extracts/dataExtractTypeId=1 | ||
| name | ||
| business unit description | ||
| department description | ||
| category description | ||
| inherent risk | ||
| residual risk | ||
| campaign name | ||
| supply Wisdom Risk Rating | ||
| bitSight Rating | ||
| use Case | ||
| black Kite Company DBI | ||
| privacy Risk | ||
| black Kite Company Cyber Risk Rating | ||
| iso 27001 Certification | ||
| black Kite Company RSI | ||
| questionnaire name | ||
| assessment creation date | ||
| assessment start date | ||
| assessment end date | ||
| year assessed | ||
| assessment submit date | ||
| assessment closed date | ||
| assessment outcome | ||
| status | ||
| /openapi/v1/extracts/dataExtractTypeId=2 | ||
| third party name | ||
| third party number | ||
| service status | ||
| relationship manager name | ||
| assessment type name | ||
| campaign name | ||
| questionnaire name | ||
| business unit description | ||
| department description | ||
| category description | ||
| risk profile description | ||
| inherent risk rating | ||
| residual risk rating | ||
| assessment start date | ||
| assessment end date | ||
| assessment completion date | ||
| assessment email received | ||
| feedback received | ||
| assessment progress percentage | ||
| assessment reviewed | ||
| assessment marked as completed | ||
| supporting files uploaded | ||
| assessment outcome | ||
| /openapi/v1/extracts/dataExtractTypeId=5 | ||
| number | ||
| name | ||
| description | ||
| service status | ||
| service start date | ||
| service end date | ||
| relationship manager name | ||
| relationship manager email address | ||
| relationship manager contact number | ||
| key contact name | ||
| key contact email address | ||
| key contact contact number | ||
| department description | ||
| parent risk | ||
| business unit description | ||
| category description | ||
| risk profile description | ||
| notification required | ||
| created date | ||
| supply wisdom risk rating | ||
| bitsight rating | ||
| use case | ||
| black kite company dbi | ||
| privacy risk | ||
| black kite company cyber risk rating | ||
| iso 27001 certification | ||
| black kite company rsi | ||
| /openapi/v1/questionnaireresponses | ||
| third party name | ||
| third party id | ||
| campaign third party id | ||
| campaign id | ||
| campaign name | ||
| questionnaire id | ||
| questionnaire description | ||
| questionnaire name | ||
| section id | ||
| section description | ||
| question id | ||
| question name | ||
| question description | ||
| question response text | ||
| answer option | ||
| answer option score | ||
| question response date | ||
| question compliance percentage | ||
| client id | ||
| client name | ||
| section maturity | ||
| question maturity | ||
| /openapi/v1/questionnaires | ||
| id | ||
| assessment type id | ||
| name | ||
| is risk assessment | ||
| created date | ||
| max score | ||
| client id | ||
| client name | ||
| /openapi/v1/riskentity/contractlookup | ||
| id | ||
| status id | ||
| contract name | ||
| contract description | ||
| email template id | ||
| contract start date | ||
| contract end date | ||
| notification days | ||
| contract type | ||
| contract type description | ||
| person contacts | ||
| client name | ||
| id | ||
| client id | ||
| name | ||
| email address | ||
| contact number | ||
| risk entity contract id | ||
| person contact type id | ||
| /openapi/v1/riskentitylookup | ||
| id | ||
| name | ||
| number | ||
| client id | ||
| solution id | ||
| client name | ||
| active | ||
| created date | ||
| service status | ||
| business unit description | ||
| department description | ||
| category description | ||
| /openapi/v1/riskentitystakeholderslookup | ||
| id | ||
| risk entity person contact type id | ||
| risk entity person contact type name | ||
| risk entity person contact type description | ||
| third party id | ||
| person contact id | ||
| person contact name | ||
| person contact number | ||
| person contact email address | ||
| client id | ||
| visible |
Resilience
| API | Field | Sub Field |
| /openapi/v1/questionnaireresponses | ||
| third party name | ||
| third party id | ||
| campaign third party id | ||
| campaign id | ||
| campaign name | ||
| questionnaire id | ||
| questionnaire description | ||
| questionnaire name | ||
| section id | ||
| section description | ||
| question id | ||
| question name | ||
| question description | ||
| question response text | ||
| answer option | ||
| answer option score | ||
| question response date | ||
| question compliance percentage | ||
| client id | ||
| client name | ||
| section maturity | ||
| question maturity | ||
| /openapi/v1/questionnaires | ||
| id | ||
| assessment type id | ||
| name | ||
| is risk assessment | ||
| created date | ||
| max score | ||
| client id | ||
| client name | ||
| /openapi/v1/risklog | ||
| id | ||
| name | ||
| description | ||
| client id | ||
| category description | ||
| business unit description | ||
| department description | ||
| service start date | ||
| service end date | ||
| service status | ||
| close flag | ||
| status | ||
| risk profile description | ||
| campaign reviewers | ||
| risk remedial action | ||
| last assessment submit date | ||
| last reminder date | ||
| last assessment assigned to | ||
| risk profile display color | ||
| agreed risk remedial action | ||
|
name |
||
| category | ||
| department | ||
| business unit | ||
| participants | ||
| email address | ||
| agreed risk remedial action | ||
| assign to | ||
| assessment type | ||
| reviewers | ||
| email address | ||
| risk profile |
Kindly contact support@phinityrisk.com for any additional assistance required.