Skip to main content

Risk-Assessments

In Penneo KYC, Risk-Assessments are used to determine the level of risk associated with a person or a company. They are performed for a Case.

It is possible to set the Risk-Assessment type for a case via the API, and to set the Risk-Assessment conclusion for the case as well.

The current Risk-Assessment type and conclusion can also be read for the Case.

Setting the Risk-Assessment type​

Before you can set the risk-assessment type for a case, you need to know the identifier of the type you want to set. See below for an example of how to do this.

Example of getting available Risk-Assessment types for a case​

To get the available Risk-Assessment types for a case, you can use the availableRiskAssessmentTypesForCase query.

It returns a list of RiskAssessmentTypes. 

query getAvailableRiskAssessmentTypesForCase($caseId: ID!) {
    availableRiskAssessmentTypesForCase(caseId: $caseId) {
        typeName
        localizedNames {
            da
            en
            de
            no
        }
    }
}

Variables:

{
    caseId: <"ID of the Case">,
}

The typeName is the identifier you need to set the Risk-Assessment type for the case.

Below you can see how this is then used to modify the Risk-Assessment type for the case.

Setting the Risk-Assessment type​

To set the Risk-Assessment type on case, you can use the setRiskAssessmentTypeOnCase mutation.

This mutation returns a Case, which contains the Risk-Assessment type that was set.

See below for a full example of how to read the Risk-Assessment type for a Case.

mutation setRiskAssessmentTypeOnCase($caseId: ID!, $typeName: String!) {
    setRiskAssessmentTypeOnCase(caseId: $caseId, typeName: $typeName) {
        id
        name
        riskAssessmentType {
            typeName
            localizedNames {
                da
                en
                de
                no
            }
        }
    }
}

Variables:

{
    caseId: <"ID of the Case">,
    typeName: <"Identifier of the Risk-Assessment type">,
}

Reading the current Risk-Assessment type​

You can read the current Risk-Assessment type for a case anywhere that you get a Case returned.

You could for example use the case query to get the Case.

query getCase($id: ID!) {
    case(id: $id) {
        id
        name
        riskAssessmentType {
            typeName
            localizedNames {
                da
                en
                de
                no
            }
        }
    }
}

Variables:

{
    id: <"ID of the Case">,
}

Setting the Risk-Assessment conclusion​

To easily mark a Risk-Assessment as done, you can set the Risk-Assessment conclusion for a case.

Before you can set the risk-assessment conclusion for a case, you need to know the identifier of the conclusion you want to set. See below for an example of how to do this.

Available Risk-Assessment conclusions​

The available Risk-Assessment conclusions are defined in an enum called RiskAssessmentConclusion.

enum RiskAssessmentConclusion {
  UNKNOWN
  LOW
  MEDIUM
  HIGH
  SUBSTANTIAL
  SOMEWHAT_LOW
  MEDIUM_LOW
}

The values of the conclusions may vary based on your configuration.

See below for an example of how to use this enum and set a Risk-Assessment conclusion for a case.

Setting the Risk-Assessment conclusion​

In order to set the Risk-Assessment conclusion for a case, you can use the setRiskAssessmentConclusion mutation.

It take the Case ID, the conclusion, and any notes you want to add to the conclusion. The notes and conclusion are saved together and can be viewed in the web application.

See below for a full example of how to read the current Risk-Assessment conclusion for a Case.

mutation setRiskAssessmentConclusion($caseId: ID!, $conclusion: RiskAssessmentConclusion!, $notes: String!) {
    setRiskAssessmentConclusion(caseId: $caseId, conclusion: $conclusion, notes: $notes) {
        id
        name
        riskAssessmentConclusion
        riskAssessmentNotes
    }
}

Variables:

{
    caseId: <"ID of the Case">,
    conclusion: <"Conclusion value from the RiskAssessmentConclusion enum">,
    notes: <"Any internal notes on this conclusion">,
}

Reading the current Risk-Assessment conclusion​

You can read the current Risk-Assessment conclusion for a case anywhere that you get a Case returned.

You could for example use the case query to get the Case.

query getCase($id: ID!) {
    case(id: $id) {
        id
        name
        riskAssessmentConclusion
        riskAssessmentNotes
    }
}

Variables:

{
    id: <"ID of the Case">,
}