Skip to main content

Risk Assessment

Requirements
  • API key pair
  • RA credits
  • RA profile created via dashboard
Image alt text

Advanced Customer Risk Assessment Service

  • Automate KYC, KYB, and AML risk assessments.
  • Customize rules, weights, and risk profiles easily.
  • Save time, reduce costs, and eliminate manual errors.
  • Meet regulatory requirements with accessible historical data.
  • Assess individual and business client risk accurately.
Read more

RA profile(s)​

get all RA profiles

Authorization: API key pair
Method: GET
Endpoint: https://ivs.idenfy.com/risk/assessment-profiles/

Response example​

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

RA check​

perform RA check

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/risk/assessment-profiles/{id}/check/

ParameterLocationRequiredTypeExplanation
idPathYesStringThe RA Profile ID for the assessment. Must be a legitimate ID retrieved from RA profiles.
sectionsBodyYesObjectObject containing section keys and their corresponding values, filled according to the specific profile (id). Retrieve profile structure from RA profiles.
nameBodyYesStringFull name of the person that should be checked.
{
  "sections": {
    "bXUsmLJeMI": {
      "lib-YHlTleSKmo": {
        "value": ["XOCgRfvUlu"]
      },
      "lib-AEgWHKDkwF": {
        "value": ["HU"]
      }
    }
  },
  "name": "Matthew Collins"
}

Retrieve RA checks​

Get All RA Checks

Authorization: API key pair
Method: GET
Endpoint: 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
    }
  ]
}

Perform RA Check​

Perform RA Check

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/risk/assessments/{assessment-id}

ParameterLocationRequiredTypeExplanation
assessment-idPathYesStringThe ID of the RA check. Must be a legitimate ID received from retrieving all RA checks.
sectionsBodyYesObjectSection keys from the questionnaire. Required if answers are being changed. Structure must follow the RA check request format.
nameBodyYesStringFull name of the person being checked. Required if the name is being changed. Structure must follow the RA check request format.
note

The request body (containing sections and name) is only needed if modifying existing answers or details, as per the note.

{
  "sections": {
    "bXUsmLJeMI": {
      "lib-YHlTleSKmo": {
        "value": ["QQALQApLKI"]
      },
      "lib-AEgWHKDkwF": {
        "value": ["EE"]
      }
    }
  },
  "name": "Matthew Collins"
}