Loading
Documentation Powered by ReDoc

DFS Credit Risk Services API (latest)

Download OpenAPI specification:Download

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/instances/{instanceid}/creditfacilities/{creditfacilityid}/calculate-risk
https://example-host/v1.0/instances/{instanceid}/creditfacilities/{creditfacilityid}/calculate-risk

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/keyriskindicators/{id}
https://example-host/v1.0/keyriskindicators/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/keyriskindicators/{id}
https://example-host/v1.0/keyriskindicators/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Patch key risk indicator request

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

isBoolean
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

isPercentage
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

storedProcedure
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

keyRiskIndicatorTypeId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

key
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

collateralTypeId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

collateralUsageId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

creditFacilityTypeId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

contactTypeId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/keyriskindicators/{id}
https://example-host/v1.0/keyriskindicators/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "isBoolean":
    {
    },
  • "isPercentage":
    {
    },
  • "storedProcedure":
    {
    },
  • "keyRiskIndicatorTypeId":
    {
    },
  • "key":
    {
    },
  • "collateralTypeId":
    {
    },
  • "collateralUsageId":
    {
    },
  • "creditFacilityTypeId":
    {
    },
  • "contactTypeId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/keyriskindicators/{id}/details/{detailId}
https://example-host/v1.0/keyriskindicators/{id}/details/{detailId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/keyriskindicators
https://example-host/v1.0/keyriskindicators

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create key risk indicator request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/keyriskindicators
https://example-host/v1.0/keyriskindicators

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "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:
application/json

PatchKeyRiskIndicatorDetail request

details
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.List%3CKeyRiskIndicatorDetail%3E%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/keyriskindicators/{id}/details
https://example-host/v1.0/keyriskindicators/{id}/details

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "details":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Create Key Risk Indicator Details request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/keyriskindicators/{id}/details
https://example-host/v1.0/keyriskindicators/{id}/details

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "isSoftKnockout": true,
  • "isHardKnockout": true,
  • "value": 0,
  • "minValue": 0,
  • "maxValue": 0,
  • "constraintTypeId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json
page
integer <int32>
pageSize
integer <int32>
creditFacilityIds
Array of integers <int32> Nullable
creditFacilityTypeIds
Array of integers <int32> Nullable
keyRiskIndicatorTypeIds
Array of integers <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/keyriskindicators/search
https://example-host/v1.0/keyriskindicators/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "creditFacilityIds":
    [
    ],
  • "creditFacilityTypeIds":
    [
    ],
  • "keyRiskIndicatorTypeIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/keyriskindicators/types/{id}
https://example-host/v1.0/keyriskindicators/types/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Request with parameters for patch

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

key
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

externalId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

isRiskModel
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/keyriskindicators/types/{id}
https://example-host/v1.0/keyriskindicators/types/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "key":
    {
    },
  • "externalId":
    {
    },
  • "isRiskModel":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/keyriskindicators/types
https://example-host/v1.0/keyriskindicators/types

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create key risk indicator type request

name
required
string non-empty
isRiskModel
required
boolean
key
required
string non-empty
externalId
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/keyriskindicators/types
https://example-host/v1.0/keyriskindicators/types

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "isRiskModel": true,
  • "key": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/rates/{id}
https://example-host/v1.0/rates/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/rates/{id}
https://example-host/v1.0/rates/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicator":
    {
    },
  • "rateGroupId": 0,
  • "propertyName": "string",
  • "minValue": 0,
  • "maxValue": 0,
  • "weight": 0,
  • "haircut": 0,
  • "isPercentage": true,
  • "isDenominator": true,
  • "createDate": "2025-07-31T10:57: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:
application/json

Patch rate request

creditFacilityId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

collateralUsageId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

keyRiskIndicatorId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

rateGroupId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

propertyName
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

minValue
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

maxValue
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

weight
object (Api.Common.UpdateableProperty%3CDecimal%3E)

Wrapper around properties used in patch requests

haircut
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

isPercentage
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

isDenominator
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/rates/{id}
https://example-host/v1.0/rates/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditFacilityId":
    {
    },
  • "collateralUsageId":
    {
    },
  • "keyRiskIndicatorId":
    {
    },
  • "rateGroupId":
    {
    },
  • "propertyName":
    {
    },
  • "minValue":
    {
    },
  • "maxValue":
    {
    },
  • "weight":
    {
    },
  • "haircut":
    {
    },
  • "isPercentage":
    {
    },
  • "isDenominator":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

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 <double> Nullable
maxValue
number <double> Nullable
weight
number <double>
haircut
number <double> Nullable
isPercentage
boolean
isDenominator
boolean

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/rates
https://example-host/v1.0/rates

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicatorId": 0,
  • "rateGroupId": 0,
  • "propertyName": "string",
  • "minValue": 0,
  • "maxValue": 0,
  • "weight": 0,
  • "haircut": 0,
  • "isPercentage": true,
  • "isDenominator": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json
rateId
integer <int32> Nullable
creditFacilityId
integer <int32> Nullable
collateralUsageId
integer <int32> Nullable
keyRiskIndicatorId
integer <int32> Nullable
rateGroupId
integer <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/rates/search
https://example-host/v1.0/rates/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rateId": 0,
  • "creditFacilityId": 0,
  • "collateralUsageId": 0,
  • "keyRiskIndicatorId": 0,
  • "rateGroupId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/rategroups
https://example-host/v1.0/rategroups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/riskclasses/{id}
https://example-host/v1.0/riskclasses/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Patch risk class request

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

description
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

riskClassTypeId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

externalId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/riskclasses/{id}
https://example-host/v1.0/riskclasses/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "description":
    {
    },
  • "riskClassTypeId":
    {
    },
  • "externalId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/riskclasses
https://example-host/v1.0/riskclasses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create risk class request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/riskclasses
https://example-host/v1.0/riskclasses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "riskClassTypeId": 0,
  • "description": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/riskclasses/types/{id}
https://example-host/v1.0/riskclasses/types/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

PatchRiskClassTypeRequest

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/riskclasses/types/{id}
https://example-host/v1.0/riskclasses/types/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/riskclasses/types
https://example-host/v1.0/riskclasses/types

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create risk class type request

name
required
string non-empty

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/riskclasses/types
https://example-host/v1.0/riskclasses/types

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/riskmodels/{id}
https://example-host/v1.0/riskmodels/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/riskmodels/{id}
https://example-host/v1.0/riskmodels/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Patch RiskModel Request

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

creditFacilityId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

storedProcedure
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

isActive
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E)

Wrapper around properties used in patch requests

modelScores
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.List%3CModelScore%3E%3E)

Wrapper around properties used in patch requests

modelCompositionScores
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.List%3CModelCompositionScores%3E%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/riskmodels/{id}
https://example-host/v1.0/riskmodels/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "creditFacilityId":
    {
    },
  • "storedProcedure":
    {
    },
  • "isActive":
    {
    },
  • "modelScores":
    {
    },
  • "modelCompositionScores":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/riskmodels
https://example-host/v1.0/riskmodels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create risk model request

name
required
string non-empty
creditFacilityId
required
integer <int32>
storedProcedure
string Nullable
modelScores
Array of objects (ModelScore) Nullable
modelCompositionScores
Array of objects (ModelCompositionScores) Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/riskmodels
https://example-host/v1.0/riskmodels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "creditFacilityId": 0,
  • "storedProcedure": "string",
  • "modelScores":
    [
    ],
  • "modelCompositionScores":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0
}