DFS v26.1
Loading
API docs by Redocly

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

Collaterals

Delete collateral

Deletes an existing collateral and its JSON data.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id for contact group verification

id
required
integer <int32>

Collateral 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 existing collateral

Modifies an existing collateral.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id for account validation

id
required
integer <int32>

Collateral id

header Parameters
Accept-Language
string

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

Request Body schema:

Request

object (UpdateableProperty<>)

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<System.Collections.Generic.List<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

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 (Api.Common.UpdateableProperty<Boolean>)

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 (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<System.Nullable<Decimal>>)

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

Responses

Request samples

Content type
{
  • "name": {
    },
  • "collateralUsageId": {
    },
  • "contactGroupId": {
    },
  • "accountIds": {
    },
  • "collateralTypeId": {
    },
  • "isFinanced": {
    },
  • "isPrimaryResidence": {
    },
  • "isHolidayResidence": {
    },
  • "data": {
    },
  • "value": {
    },
  • "netValue": {
    },
  • "customAttributes": {
    },
  • "minValuation": {
    },
  • "maxValuation": {
    },
  • "medianValuation": {
    },
  • "address": {
    },
  • "externalId": {
    }
}

Response samples

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

Get collaterals

Gets a list of all collaterals with the data of the collateral. The list of collaterals is determined by the contact groups the contact is a member of.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id for contact group verification

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create collateral

Creates a new collateral. A list of account ids can be passed that will indicate the account/s used as collateral.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id for account validation

header Parameters
Accept-Language
string

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

Request Body schema:

Request

name
required
string non-empty
collateralUsageId
required
integer <int32>
contactGroupId
required
integer <int32>
collateralTypeId
required
integer <int32>
isFinanced
required
boolean
isPrimaryResidence
required
boolean
isHolidayResidence
required
boolean
value
number or null <double>
netValue
number or null <double>
customAttributes
string or null
accountIds
Array of integers or null <int32> [ items <int32 > ]
data
string or null
minValuation
number or null <double>
maxValuation
number or null <double>
medianValuation
number or null <double>
address
string or null
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "collateralUsageId": 0,
  • "contactGroupId": 0,
  • "collateralTypeId": 0,
  • "isFinanced": true,
  • "isPrimaryResidence": true,
  • "isHolidayResidence": true,
  • "value": 0.1,
  • "netValue": 0.1,
  • "customAttributes": "string",
  • "accountIds": [
    ],
  • "data": "string",
  • "minValuation": 0.1,
  • "maxValuation": 0.1,
  • "medianValuation": 0.1,
  • "address": "string",
  • "externalId": "string"
}

Response samples

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

Get a collateral

Gets a collateral with the data of the collateral. The collateral is determined by the contact groups id the contact is a member of and id of the collateral.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id for contact group verification

collateralId
required
integer <int32>

Collateral ID

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",
  • "collateralUsageId": 0,
  • "contactGroupId": 0,
  • "collateralType": {
    },
  • "isFinanced": true,
  • "isPrimaryResidence": true,
  • "isHolidayResidence": true,
  • "value": 0.1,
  • "netValue": 0.1,
  • "customAttributes": "string",
  • "accountsIds": [
    ],
  • "data": "string",
  • "minValuation": 0.1,
  • "maxValuation": 0.1,
  • "medianValuation": 0.1,
  • "address": "string",
  • "externalId": "string",
  • "createDate": "2019-08-24T14:15:22Z"
}

CollateralTypes

Delete collateral type

Deletes an existing collateral type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CollateralType 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 a collateral type

Modifies an existing collateral type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CollateralTypeId of the collateral type that will be modified

header Parameters
Accept-Language
string

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

Request Body schema:

Patch collateral type request

object (UpdateableProperty<>)

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<Boolean>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "key": {
    },
  • "dynamicSchemaId": {
    },
  • "canBeLoaned": {
    }
}

Response samples

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

Get collateral types

Gets collateral 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 collateral type

Creates a new collateral type.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Create collateral type request

name
required
string non-empty
key
required
string non-empty
dynamicSchemaId
required
integer <int32>
canBeLoaned
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "key": "string",
  • "dynamicSchemaId": 0,
  • "canBeLoaned": true
}

Response samples

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

CollateralUsages

Get collateral usages

Gets a list of collateral usages.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]