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

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/contacts/{contactId}/collaterals/{id}

https://example-host/v1.0/contacts/{contactId}/collaterals/{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 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:
application/json

Request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
collateralUsageId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
contactGroupId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
accountIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.List%3CInt32%3E%3E) Wrapper around properties used in patch requests
collateralTypeId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
isFinanced	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
isPrimaryResidence	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
isHolidayResidence	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
data	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
value	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
netValue	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
customAttributes	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
minValuation	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
maxValuation	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
medianValuation	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
address	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/contacts/{contactId}/collaterals/{id}

https://example-host/v1.0/contacts/{contactId}/collaterals/{id}

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contacts/{contactId}/collaterals

https://example-host/v1.0/contacts/{contactId}/collaterals

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string",
"collateralUsageId": 0,
"contactGroupId": 0,
"collateralType": 
{"id": 0,
"name": "string",
"key": "string",
"canBeLoaned": true
},
"isFinanced": true,
"isPrimaryResidence": true,
"isHolidayResidence": true,
"value": 0,
"netValue": 0,
"customAttributes": "string",
"accountsIds": 
[0
],
"data": "string",
"minValuation": 0,
"maxValuation": 0,
"medianValuation": 0,
"address": "string",
"createDate": "2025-07-31T10:57:22Z"
}
]

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

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 <double> Nullable
netValue	number <double> Nullable
customAttributes	string Nullable
accountIds	Array of integers <int32> Nullable
data	string Nullable
minValuation	number <double> Nullable
maxValuation	number <double> Nullable
medianValuation	number <double> Nullable
address	string Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/collaterals

https://example-host/v1.0/contacts/{contactId}/collaterals

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

CollateralTypes

Delete collateral type

Deletes an existing collateral type.

Authorizations:

Bearer

path Parameters

required

integer <int32>

CollateralType 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/collateraltypes/{id}

https://example-host/v1.0/collateraltypes/{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 collateral type

Modifies an existing collateral type.

Authorizations:

Bearer

path Parameters

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

Patch collateral type request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
dynamicSchemaId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
canBeLoaned	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/collateraltypes/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"key": 
{"doUpdate": true,
"value": "string"
},
"dynamicSchemaId": 
{"doUpdate": true,
"value": 0
},
"canBeLoaned": 
{"doUpdate": true,
"value": true
}
}

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 collateral types

Gets collateral types.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/collateraltypes

https://example-host/v1.0/collateraltypes

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string",
"key": "string",
"canBeLoaned": true,
"dynamicSchemaId": 0,
"feeIds": 
[0
]
}
]

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

Create collateral type request

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/collateraltypes

https://example-host/v1.0/collateraltypes

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/collateralusages

https://example-host/v1.0/collateralusages

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string"
}
]

DFS Collateral Services API (latest)

Collaterals

Delete collateral

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify an existing collateral

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get collaterals

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create collateral

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

CollateralTypes

Delete collateral type

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a collateral type

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get collateral types

Authorizations:

header Parameters

Responses

Response samples

Create a new collateral type

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

CollateralUsages

Get collateral usages

Authorizations:

header Parameters

Responses

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json