Loading
API docs by Redocly

DFS Credit Document Services API (latest)

Download OpenAPI specification:

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. If the CreditInstance.Status is not InProgress, then the endpoint will filter based on the CreditFacilityIds of the present Offers

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

Response samples

Content type
application/json
[
  • {
    }
]

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

Response samples

Content type
application/json
[
  • {
    }
]

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

Response samples

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

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:

Patch document context 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<Boolean>>)

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

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IEnumerable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IEnumerable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IEnumerable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IEnumerable<DocumentContextCollateralType>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IEnumerable<String>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "dmsDocumentCategoryKey": {
    },
  • "isMandatory": {
    },
  • "isActive": {
    },
  • "hasValidityDate": {
    },
  • "externalId": {
    },
  • "customAttributes": {
    },
  • "dmsDocumentSetId": {
    },
  • "dmsDocumentMetadataId": {
    },
  • "contactTypes": {
    },
  • "creditInstanceTypes": {
    },
  • "creditUsages": {
    },
  • "collateralUsages": {
    },
  • "collateralTypes": {
    },
  • "listItems": {
    }
}

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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:

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 or null
customAttributes
string or null
dmsDocumentSetId
integer or null <int32>
creditInstanceTypes
required
Array of integers <int32> [ items <int32 > ]
creditUsages
required
Array of integers <int32> [ items <int32 > ]
collateralUsages
required
Array of integers <int32> [ items <int32 > ]
required
Array of objects (DocumentContextCollateralType)
contactTypes
Array of integers or null <int32> [ items <int32 > ]
listItems
Array of strings or null

Responses

Request samples

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

Response samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "dmsDocumentCategoryKey": "string",
  • "dmsDocumentMetadataId": 0,
  • "creditFacilityId": 0,
  • "isMandatory": true,
  • "isActive": true,
  • "hasValidityDate": true,
  • "externalId": "string",
  • "customAttributes": "string",
  • "dmsDocumentSetId": 0,
  • "creditInstanceTypes": [
    ],
  • "creditUsages": [
    ],
  • "collateralUsages": [
    ],
  • "collateralTypes": [
    ],
  • "contactTypes": [
    ],
  • "listItems": [
    ],
  • "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:

Request

contactTypeIds
required
Array of integers <int32> [ items <int32 > ]
creditInstanceTypeIds
required
Array of integers <int32> [ items <int32 > ]
creditUsageIds
required
Array of integers <int32> [ items <int32 > ]
collateralUsageIds
required
Array of integers <int32> [ items <int32 > ]
collateralTypeIds
required
Array of integers <int32> [ items <int32 > ]
contactGroupId
integer or null <int32>

Responses

Request samples

Content type
{
  • "contactTypeIds": [
    ],
  • "creditInstanceTypeIds": [
    ],
  • "creditUsageIds": [
    ],
  • "collateralUsageIds": [
    ],
  • "collateralTypeIds": [
    ],
  • "contactGroupId": 0
}

Response samples

Content type
application/json
[
  • {
    }
]