The Risk API is used for creating and reading risk assessments for either natural persons (customers) or juridical persons (businesses).

These are the typical steps for setting up your account and creating a risk assessments:

• You are granted with a set of credentials that allow you to authenticate your user when sending requests to Nemuru's Risk API (handled internally by Nemuru).
• One or more policies are linked to your user (handled internally by Nemuru).
• A policiy is composed of a set of rules and can be versioned.
• Each policy rule is linked to a data resource. There are different data resources:
  • Data provided by you when creating the assessment
  • External data sources integrated by Nemuru: credit bureaus, ML models, etc.
• When creating an assessment, you need to specify a policy to analyze the customer or business with.
• Depending on the type of policy, specific information will be required when creating the assessment.
• Once the assessment is computed, the response will return the result.
• Assessment results can be consulted on demand.

1. Creating a Risk Assessment

There are two endpoints to create Risk Assessments:

• Natural person: for analyzing individuals (GET assess a natural person).
• Juridical person: for analyzing business (GET asses a juridical person).

2. Retrieving Risk Assessments

There are two endpoints to get Risk Assessments:

• Natural person: get all Risk Assessments by documentNumber (GET assessments by document number).
• Juridical person: get all Risk Assessments by corporateIdNumber (GET assessments by corporate number).

Nemuru's APIs use HTTP status codes together with error objects to handle errors. When an API call fails, the response will include a 4xx or 5xx status code together with a response body.

The error object MUST contain an exception and an error property. ONLY in case of 400 Bad Request error, the schema_errors property will also be present:

• The exception is a path referring to the unique and enumerable error that occurred in Nemuru. The intent of this property is that it is machine readable and so that you can act properly on its value.
• The error is the message that accompanies Nemuru's exception. It's value is a human readable message to aid in debugging.
• The schema_errors returns an object indicating invalid fields in the request. This property is ONLY available when an API call returns a status 400 Bad Request —the request data do not comply with the scheme validation.

Status codes

The following endpoints will allow you to create and retrieve natural person risk assessments.

• Assess a Natural Person generates a natural person risk assessment with a specific policy. This endpoint requires you to pass the policy ID and all the data that the policy needs as query params.
• Get Assessments by Document Number returns all natural person risk assessments filtered by the natural person's document number (e.g. DNI or NIE).

A natural person can be assessed stand-alone or within a company structure (juridical person). For the latter, it will be necessary to reference the parent corporate Id number (e.g. CIF) of the parent company so that it is possible to nest the natural person below the juridical person when retrieving the whole company assessments.

The following endpoints will allow you to create and retrieve juridical person risk assessments.

• Assess a Juridical Person generates a juridical person risk assessment with a specific policy. This endpoint requires you to pass the policy ID and all the data that the policy needs as query params.
• Get Assessments by Corporate Id Number returns all juridical person risk assessments filtered by the juridical person's corporate Id number (e.g. CIF).

A juridical person can be assessed stand-alone or within a company structure (juridical person). For the latter, it will be necessary to reference the parent corporate Id number (e.g. CIF) of the parent company so that it is possible to nest the natural person below the juridical person when retrieving the whole company assessments.