DFS Credit Document Services API (latest)

Download OpenAPI specification:Download

Contains functionality around credit documents.

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.

Contacts

Get the document contexts required for a credit instance

Gets the document contexts required for a credit instance. All of the criteria required to determine the required documents will be deducted based on the client’s credit instance.

Authorizations:

Bearer

path Parameters

contactId required	integer <int32> Contact ID
instanceId required	integer <int32> Credit Instance ID

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}/instances/{instanceId}/documentcontexts

https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/documentcontexts

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"documentContextId": 0
}
]

Get the document contexts required for an offer on specified credit instance.

Gets the document contexts required for an offer on specified credit instance. All of the criteria required to determine the required documents will be deducted based on the client’s credit instance.

Authorizations:

Bearer

path Parameters

contactId required	integer <int32> Contact ID
instanceId required	integer <int32> Credit Instance ID
offerId required	integer <int32> Offer ID

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}/instances/{instanceId}/offers/{offerId}/documentcontexts

https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/documentcontexts

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"documentContextId": 0
}
]

CreditFacilities

Delete an existing document context

Deletes an existing document context linked to the credit facility.

Authorizations:

Bearer

path Parameters

id required	integer <int32> Document Context ID
creditFacilityId required	integer <int32> Credit facility 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/creditfacilities/{creditFacilityId}/documentcontexts/{id}

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Modify an existing document context

Modifies an existing document context linked to the credit facility.

Authorizations:

Bearer

path Parameters

creditFacilityId required	integer <int32> Credit facility ID
id required	integer <int32> Document Context ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Patch document context request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
dmsDocumentCategoryKey	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
isMandatory	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%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
hasValidityDate	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E) Wrapper around properties used in patch requests
externalId	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
customAttributes	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
dmsDocumentSetId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
dmsDocumentMetadataId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
contactTypes	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CInt32%3E%3E) Wrapper around properties used in patch requests
creditInstanceTypes	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CInt32%3E%3E) Wrapper around properties used in patch requests
creditUsages	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CInt32%3E%3E) Wrapper around properties used in patch requests
collateralUsages	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CInt32%3E%3E) Wrapper around properties used in patch requests
collateralTypes	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CDocumentContextCollateralType%3E%3E) Wrapper around properties used in patch requests
listItems	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IEnumerable%3CString%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/creditfacilities/{creditFacilityId}/documentcontexts/{id}

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts/{id}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"dmsDocumentCategoryKey": 
{"doUpdate": true,
"value": "string"
},
"isMandatory": 
{"doUpdate": true,
"value": true
},
"isActive": 
{"doUpdate": true,
"value": true
},
"hasValidityDate": 
{"doUpdate": true,
"value": true
},
"externalId": 
{"doUpdate": true,
"value": "string"
},
"customAttributes": 
{"doUpdate": true,
"value": "string"
},
"dmsDocumentSetId": 
{"doUpdate": true,
"value": 0
},
"dmsDocumentMetadataId": 
{"doUpdate": true,
"value": 0
},
"contactTypes": 
{"doUpdate": true,
"value": 
[0
]
},
"creditInstanceTypes": 
{"doUpdate": true,
"value": 
[0
]
},
"creditUsages": 
{"doUpdate": true,
"value": 
[0
]
},
"collateralUsages": 
{"doUpdate": true,
"value": 
[0
]
},
"collateralTypes": 
{"doUpdate": true,
"value": 
[
{"collateralTypeId": 0,
"isPrimaryResidence": true,
"isHolidayResidence": true
}
]
},
"listItems": 
{"doUpdate": true,
"value": 
["string"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get all document contexts

Gets all the document contexts linked to a credit facility and their details.

Authorizations:

Bearer

path Parameters

creditFacilityId

required

integer <int32>

Credit facility ID

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/creditfacilities/{creditFacilityId}/documentcontexts

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"documentContextId": 0
}
]

Create a new document context

Creates a new document context linked to the credit facility which will be used to determine the required documents for a credit instance.

Authorizations:

Bearer

path Parameters

creditFacilityId

required

integer <int32>

Credit facility ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Create document context request

name required	string non-empty
dmsDocumentCategoryKey required	string non-empty
dmsDocumentMetadataId required	integer <int32>
creditFacilityId required	integer <int32>
isMandatory	boolean
isActive	boolean
hasValidityDate	boolean
externalId	string Nullable
customAttributes	string Nullable
dmsDocumentSetId	integer <int32> Nullable
creditInstanceTypes required	Array of integers <int32>
creditUsages required	Array of integers <int32>
collateralUsages required	Array of integers <int32>
collateralTypes required	Array of objects (DocumentContextCollateralType)
contactTypes	Array of integers <int32> Nullable
listItems	Array of strings Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/creditfacilities/{creditFacilityId}/documentcontexts

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"creditInstanceTypes": 
[0
],
"creditUsages": 
[0
],
"collateralUsages": 
[0
],
"collateralTypes": 
[
{"collateralTypeId": 0,
"isPrimaryResidence": true,
"isHolidayResidence": true
}
],
"contactTypes": 
[0
],
"listItems": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Get single document context

Gets single document context linked to a credit facility.

Authorizations:

Bearer

path Parameters

creditFacilityId required	integer <int32> Credit facility ID
documentContextId required	integer <int32> Document Context ID

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/creditfacilities/{creditFacilityId}/documentcontexts/{documentContextId}

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts/{documentContextId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"creditInstanceTypes": 
[0
],
"creditUsages": 
[0
],
"collateralUsages": 
[0
],
"collateralTypes": 
[
{"collateralTypeId": 0,
"isPrimaryResidence": true,
"isHolidayResidence": true
}
],
"contactTypes": 
[0
],
"listItems": 
["string"
],
"documentContextId": 0
}

Search document contexts

Gets the document contexts required for a credit facility based on the request criteria. The required filters are credit instance type, credit usage, collateral usage, collateral type ids.

Authorizations:

Bearer

path Parameters

creditFacilityId

required

integer <int32>

Credit facility ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Request

contactTypeIds required	Array of integers <int32>
creditInstanceTypeIds required	Array of integers <int32>
creditUsageIds required	Array of integers <int32>
collateralUsageIds required	Array of integers <int32>
collateralTypeIds required	Array of integers <int32>

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/creditfacilities/{creditFacilityId}/documentcontexts/search

https://example-host/v1.0/creditfacilities/{creditFacilityId}/documentcontexts/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"contactTypeIds": 
[0
],
"creditInstanceTypeIds": 
[0
],
"creditUsageIds": 
[0
],
"collateralUsageIds": 
[0
],
"collateralTypeIds": 
[0
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"name": "string",
"dmsDocumentCategoryKey": "string",
"dmsDocumentMetadataId": 0,
"creditFacilityId": 0,
"isMandatory": true,
"isActive": true,
"hasValidityDate": true,
"externalId": "string",
"customAttributes": "string",
"dmsDocumentSetId": 0,
"documentContextId": 0
}
]

DFS Credit Document Services API (latest)

Contacts

Get the document contexts required for a credit instance

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get the document contexts required for an offer on specified credit instance.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

CreditFacilities

Delete an existing document context

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify an existing document context

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get all document contexts

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create a new document context

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get single document context

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Search document contexts

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json