Skip to main content
Requirements
  • API key pair
  • RA credits
  • RA profile created via the dashboard

Learn More

Advanced Customer Risk Assessment Service — automate KYC, KYB, and AML risk assessments with customizable rules and weights.

​
RA Profiles

​
Retrieve 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"
  }
]

​
Retrieve Specific RA Profile

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

​
Request parameter

KeyRequiredExplanationType
idYesA unique integer value identifying this risk assessment.Integer
Response example: 
{
  "id": "61fbe03e-961c-4c6f-a2cd-801083ddbe0d",
  "name": "Name",
  "description": "",
  "sections": [
    {
      "key": "bXUsmLJeMI",
      "name": "Category",
      "weight": 100,
      "questions": [
        {
          "choices": [
            { "key": "XOCgRfvUlu", "title": "Yes" },
            { "key": "QQALQApLKI", "title": "No" }
          ],
          "key": "lib-YHlTleSKmo",
          "name": "Is shareholder PEP?",
          "title": "Is shareholder PEP?",
          "type": "SELECT",
          "riskLevels": [],
          "riskLevelDefault": "LOW"
        },
        {
          "choices": [],
          "key": "lib-AEgWHKDkwF",
          "name": "Shareholder residency",
          "title": "Shareholder residency",
          "type": "COUNTRY",
          "riskLevels": [],
          "riskLevelDefault": "MEDIUM"
        }
      ]
    }
  ]
}

​
RA Check

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

​
Request parameters

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. 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

​
Retrieve 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
    }
  ]
}

​
Retrieve Specific RA Check

Authorization: API key pair Method: GET Endpoint: https://ivs.idenfy.com/risk/assessments/{id}/
Response example: 
{
  "id": "Fi6cT2FO0AoDYyPljKhM41",
  "name": "Matthew Collins",
  "sections": [
    {
      "key": "OxTPlZAfHZ",
      "name": "Second category",
      "weight": 100,
      "questions": [
        {
          "key": "lib-NObsdcmGfe",
          "name": "Is shareholder PEP?",
          "type": "SELECT",
          "title": "Is shareholder PEP?",
          "choices": [
            { "key": "HAwWshlziF", "title": "Yes" },
            { "key": "WuZBsvsyWC", "title": "No" }
          ],
          "riskLevels": [],
          "riskLevelDefault": "HIGH",
          "answers": []
        },
        {
          "key": "lib-tRdubSLIVr",
          "name": "Country of Incorporation",
          "type": "COUNTRY",
          "title": "Country of Incorporation",
          "choices": [],
          "riskLevels": [],
          "riskLevelDefault": "LOW",
          "answers": []
        }
      ],
      "riskScore": 0,
      "maxRiskScore": 0
    }
  ],
  "riskScore": 0,
  "riskLevel": "VERY_LOW",
  "comment": null,
  "createdAt": "2024-05-06 09:45:02.405602+00:00",
  "updatedAt": "2024-05-06 09:45:02.405609+00:00",
  "updateRequired": false,
  "stateChangeEvent": "INITIAL",
  "companyId": null,
  "partner": {
    "id": 670,
    "created": "2022-08-08T06:37:32.765693Z",
    "companyName": "Mantas Tech",
    "environment": "DEVELOPMENT",
    "isActive": true
  },
  "profile": {
    "id": "dd121b5c-e3ef-4197-b036-8b7e872f6678",
    "name": "RA profile name"
  },
  "riskLevelChangedBy": null
}

​
Perform RA Check

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

​
Request parameters

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.
The request body (containing sections and name) is only needed if modifying existing answers or details.
{
  "sections": {
    "bXUsmLJeMI": {
      "lib-YHlTleSKmo": {
        "value": ["QQALQApLKI"]
      },
      "lib-AEgWHKDkwF": {
        "value": ["EE"]
      }
    }
  },
  "name": "Matthew Collins"
}