Skip to main content

Risk Assessment (RA)

Client risk scoring is dedicated to evaluate the risks involved with a new or existing client. This process is key to preventing fraud, ensuring compliance with regulations, and managing financial exposure. It typically involves assessing various aspects of a client's profile to understand and mitigate potential risks.

note

The requests described below must contain basic auth headers where username is api key and password is api secret.

1. RA profile(s)​

Firstly, a risk assessment profile should be created. You can do that by logging into our dashboard and navigating to Risk assessment -> Risk assessment profiles

Risk Assessment Path

Send a HTTP GET request to: https://ivs.idenfy.com/risk/assessment-profiles/

Example response:​

[
    {
        "id": "dd121b5c-e3ef-4197-b036-8b7e872f6678",
        "name": "RA profile name"
    }
]

2. RA check​

Construct body and send HTTP POST request to:
https://ivs.idenfy.com/risk/assessment-profiles/{id}/check/

note

{id} in the request should be a legit RA profile ID that could be retrieved on previous steps. Request body must contain sections object that should be filled according to previously set profiles, that could be retrieved from RA profiles.

Example request & response​

KeyRequiredExplanationType
sectionsYesSection keys from a questionnaire.Object
nameYesFull name of the person that should be checkedString
{
    "sections": {
        "bXUsmLJeMI": {
            "lib-YHlTleSKmo": {
                "value": ["XOCgRfvUlu"]
            },
            "lib-AEgWHKDkwF": {
                "value": ["HU"]
            }
        }
    },
    "name": "Matthew Collins"
}

3. RA recheck​

Construct body and send HTTP PUT request to:
https://ivs.idenfy.com/risk/assessments/{assessment-id}

note

The assessment-id in the request should be a legit RA check ID that could be received by retrieving all RA checks. If answers were changed, body should be contructed according to RA check request.

Example request & response​

KeyRequiredExplanationType
sectionsYesSection keys from a questionnaire.Object
nameYesFull name of the person that should be checkedString
{
    "sections": {
        "bXUsmLJeMI": {
            "lib-YHlTleSKmo": {
                "value": ["QQALQApLKI"]
            },
            "lib-AEgWHKDkwF": {
                "value": ["EE"]
            }
        }
    },
    "name": "Matthew Collins"
}

4. Retrieve RA check list/entry​

To retrieve list of all RA checks send a HTTP GET request to: https://ivs.idenfy.com/risk/assessments/

Response Example​

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "17CRlVRrxUa91BAMvMdeYP",
            "name": "Matthew Collins",
            "riskLevel": "VERY_HIGH",
            "createdAt": "2024-05-16T08:57:04.654818Z",
            "updateRequired": false
        },
        {
            "id": "F1WQIFa7EdHAvjanJ0pAKc",
            "name": "Sarah Robins",
            "riskLevel": "VERY_LOW",
            "createdAt": "2024-05-07T12:50:03.816388Z",
            "updateRequired": false
        }
    ]
}