Loading
API docs by Redocly

DFS Credit Risk Services API (latest)

Download OpenAPI specification:

Contains functionality around credit risk.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

CreditInstance

Calculate the risk of a credit instance.

Calculate the risk of the credit instance against the risk model defined for the credit facility.

Authorizations:
Bearer
path Parameters
instanceid
required
integer <int32>
creditfacilityid
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "riskClassTypeId": 0,
  • "riskClassTypeName": "string",
  • "riskClassId": 0,
  • "riskClassName": "string",
  • "riskClassScore": 0
}

KeyRiskIndicator

Delete a key risk indicator

Deletes an existing key risk indicator.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Key risk indicator id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get key risk indicator

Gets key risk indicators for provided key risk indicator id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "isBoolean": true,
  • "isPercentage": true,
  • "storedProcedure": "string",
  • "keyRiskIndicatorType": {
    },
  • "key": "string",
  • "collateralTypeId": 0,
  • "collateralUsageId": 0,
  • "creditFacilityTypeId": 0,
  • "contactTypeId": 0,
  • "details": [
    ]
}

Modify an existing key risk indicator

Modifies an existing key risk indicator. The risk values can be defined as a boolean, as a percentage or as a plain value if both are passed as false. If they are not passed they will both default to false.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the key risk indicator that will be modified

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch key risk indicator request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "isBoolean": {
    },
  • "isPercentage": {
    },
  • "storedProcedure": {
    },
  • "keyRiskIndicatorTypeId": {
    },
  • "key": {
    },
  • "collateralTypeId": {
    },
  • "collateralUsageId": {
    },
  • "creditFacilityTypeId": {
    },
  • "contactTypeId": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Delete key risk indicator detail

Deletes an existing key risk indicator detail.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

KeyRiskIndicatorId

detailId
required
integer <int32>

KeyRiskIndicatorDetailId

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get key risk indicators

Gets a list of all the existing key risk indicators.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new key risk indicator

Creates a new key risk indicator. The risk values can be defined as a boolean, as a percentage or as a plain value if both are passed as false. If they are not passed they will both default to false.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create key risk indicator request

name
required
string non-empty
keyRiskIndicatorTypeId
required
integer <int32>
isBoolean
boolean
isPercentage
boolean
storedProcedure
string or null
key
string or null
collateralTypeId
integer or null <int32>
collateralUsageId
integer or null <int32>
creditFacilityTypeId
integer or null <int32>
contactTypeId
integer or null <int32>
Array of objects or null (CreateKeyRiskIndicatorDetailRequest)

Responses

Request samples

Content type
{
  • "name": "string",
  • "keyRiskIndicatorTypeId": 0,
  • "isBoolean": true,
  • "isPercentage": true,
  • "storedProcedure": "string",
  • "key": "string",
  • "collateralTypeId": 0,
  • "collateralUsageId": 0,
  • "creditFacilityTypeId": 0,
  • "contactTypeId": 0,
  • "details": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Modify an existing key risk indicator detail

Modifies an existing key risk indicator detail. If "IsSoftKnockout" and "IsHardKnockout" are false this indicates that the details is read as pass.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

KeyRiskIndicatorId

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

PatchKeyRiskIndicatorDetail request

object (Api.Common.UpdateableProperty<System.Collections.Generic.List<KeyRiskIndicatorDetail>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create a new key risk indicator detail

Creates a new key risk indicator detail. If "IsSoftKnockout" and "IsHardKnockout" are false this indicates that the details is read as pass.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

KeyRiskIndicator ID

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create Key Risk Indicator Details request

isSoftKnockout
required
boolean
isHardKnockout
required
boolean
value
number or null <double>
minValue
number or null <double>
maxValue
number or null <double>
constraintTypeId
integer or null <int32>

Responses

Request samples

Content type
{
  • "isSoftKnockout": true,
  • "isHardKnockout": true,
  • "value": 0.1,
  • "minValue": 0.1,
  • "maxValue": 0.1,
  • "constraintTypeId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get key risk indicators and key risk indicators types

Gets a list of all the existing key risk indicators and its details based on a filtering criteria. The available filters are credit facility id, credit facility type id, key risk indicator type id.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
page
integer <int32>
pageSize
integer <int32>
creditFacilityIds
Array of integers or null <int32> [ items <int32 > ]
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
keyRiskIndicatorTypeIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "creditFacilityIds": [
    ],
  • "creditFacilityTypeIds": [
    ],
  • "keyRiskIndicatorTypeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

KeyRiskIndicatorType

Delete a key risk indicator detail type

Deletes an existing key risk indicator detail type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Key risk indicator id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Modify the key risk indicator type

Modifies the details of a key risk indicator type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

KeyRiskIndicatorTypeId

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Request with parameters for patch

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Boolean>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "key": {
    },
  • "externalId": {
    },
  • "isRiskModel": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get all the key risk indicator detail types

Gets a list of all the existing key risk indicator detail types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new key risk indicator detail type

Creates a new key risk indicator detail type.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create key risk indicator type request

name
required
string non-empty
isRiskModel
required
boolean
key
required
string non-empty
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "isRiskModel": true,
  • "key": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Rate

Delete a rate

Deletes an existing rate.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Rate id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get an existing rate

Gets all the details of an existing rate by passing the rate id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

RateId

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicator": {
    },
  • "rateGroupId": 0,
  • "propertyName": "string",
  • "minValue": 0.1,
  • "maxValue": 0.1,
  • "weight": 0.1,
  • "haircut": 0.1,
  • "isPercentage": true,
  • "isDenominator": true,
  • "createDate": "2019-08-24T14:15:22Z"
}

Modify an existing rate

Modifies the details of an existing rate.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Rate id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch rate request

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Decimal>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "creditFacilityId": {
    },
  • "collateralUsageId": {
    },
  • "keyRiskIndicatorId": {
    },
  • "rateGroupId": {
    },
  • "propertyName": {
    },
  • "minValue": {
    },
  • "maxValue": {
    },
  • "weight": {
    },
  • "haircut": {
    },
  • "isPercentage": {
    },
  • "isDenominator": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create a new rate

Creates a new rate that can be later linked to a lender as part of its offering.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create rate request

creditFacilityId
required
integer <int32>
collateralUsageId
required
integer <int32>
keyRiskIndicatorId
required
integer <int32>
rateGroupId
required
integer <int32>
propertyName
required
string non-empty
minValue
number or null <double>
maxValue
number or null <double>
weight
number <double>
haircut
number or null <double>
isPercentage
boolean
isDenominator
boolean

Responses

Request samples

Content type
{
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicatorId": 0,
  • "rateGroupId": 0,
  • "propertyName": "string",
  • "minValue": 0.1,
  • "maxValue": 0.1,
  • "weight": 0.1,
  • "haircut": 0.1,
  • "isPercentage": true,
  • "isDenominator": true
}

Response samples

Content type
application/json
{
  • "id": 0
}

Filter existing rates

Gets the details of all the existing rates. The results can be filtered by passing in request body credit facility id, collateral usage id, group or key risk indicator id.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
rateId
integer or null <int32>
creditFacilityId
integer or null <int32>
collateralUsageId
integer or null <int32>
keyRiskIndicatorId
integer or null <int32>
rateGroupId
integer or null <int32>

Responses

Request samples

Content type
{
  • "rateId": 0,
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicatorId": 0,
  • "rateGroupId": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

RateGroup

Get a list of rate groups

Gets a list of all the existing rate groups.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

RiskClass

Delete a risk class

Deletes an existing risk class.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Risk class id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Modify an risk class

Modifies an existing risk class.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Risk class id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch risk class request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "description": {
    },
  • "riskClassTypeId": {
    },
  • "externalId": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get risk classes

Gets a list of all the existing risk classes.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new risk class

Creates a new risk class which can be used in creating a new risk model.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create risk class request

name
required
string non-empty
riskClassTypeId
required
integer <int32>
description
string or null
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "riskClassTypeId": 0,
  • "description": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

RiskClassType

Delete risk class type

Deletes an existing risk class type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the risk class type

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Modify a risk class type

Modifies the details of an existing risk class type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

PatchRiskClassType Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

PatchRiskClassTypeRequest

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get risk class types

Gets risk class types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new risk class type

Creates a new risk class type which can be used to define one or more risk classes.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create risk class type request

name
required
string non-empty

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

RiskModel

Delete risk model

Deletes an existing risk model and its model scoring and model composition.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

RiskModel ID

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get the details of a risk model

Gets all the details of a risk model.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Risk model id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "creditFacilityId": 0,
  • "storedProcedure": "string",
  • "id": 0,
  • "isActive": true,
  • "modelScores": [
    ],
  • "modelCompositionScores": [
    ]
}

Modify an existing risk model

Modifies an existing risk model with composition and scoring.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

RiskModel ID

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch RiskModel Request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Boolean>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.List<ModelScore>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.List<ModelCompositionScores>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "creditFacilityId": {
    },
  • "storedProcedure": {
    },
  • "isActive": {
    },
  • "modelScores": {
    },
  • "modelCompositionScores": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get a list of existing risk models

Gets a list of existing risk models.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new risk model

Creates a new risk model with composition and scoring.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create risk model request

name
required
string non-empty
creditFacilityId
required
integer <int32>
storedProcedure
string or null
Array of objects or null (ModelScore)
Array of objects or null (ModelCompositionScores)

Responses

Request samples

Content type
{
  • "name": "string",
  • "creditFacilityId": 0,
  • "storedProcedure": "string",
  • "modelScores": [
    ],
  • "modelCompositionScores": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}