Loading
API docs by Redocly

DFS Credit Instance Services API (latest)

Download OpenAPI specification:

Contains functionality around credit instances.

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

Get the details of a credit instance belonging to a contact

Gets the details of a credit instance belonging to a contact.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>
id
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "creditInstanceId": 0,
  • "creditInstanceUid": "13038638-c4c3-44ea-8b75-8c353f9b2537",
  • "creditInstanceTypeId": {
    },
  • "creditUsageIds": [
    ],
  • "contactGroupId": 0,
  • "durationDays": 0,
  • "amount": 0.1,
  • "calculatedRiskClassId": 0,
  • "calculatedRiskClassScore": 0.1,
  • "calculatedCreditHistoryScore": 0.1,
  • "calculatedInterestRate": 0.1,
  • "ownEquityCashAmount": 0.1,
  • "ownEquityNonCashAmount": 0.1,
  • "ownEquityAdditionalCollateralAmount": 0.1,
  • "creditStatus": {
    },
  • "creditInstanceIntegrationStatus": {
    },
  • "isActive": true,
  • "isComplete": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "collaterals": [
    ],
  • "collateralIds": [
    ],
  • "repaymentIds": [
    ],
  • "offers": [
    ],
  • "ownEquityTypes": [
    ],
  • "billingTypeId": 0,
  • "dynamicSchemaId": 0,
  • "data": "string",
  • "customAttributes": "string",
  • "externalId": "string",
  • "creditFacilityTypeId": 0,
  • "creditFacilityType": {
    },
  • "memberId": 0,
  • "assignedMemberId": 0,
  • "approvedBy": 0,
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "currencyId": 0,
  • "currency": {
    },
  • "closingDate": "2019-08-24T14:15:22Z",
  • "productBases": [
    ],
  • "documentation": [
    ],
  • "dueDate": "2019-08-24T14:15:22Z",
  • "createdByInternalUid": "string",
  • "assignedInternalUid": "string",
  • "approvedByInternalUid": "string",
  • "createdMemberDetails": {
    },
  • "assignedMemberDetails": {
    },
  • "approvedMemberDetails": {
    }
}

Modify an existing credit instance

Modifies an existing credit instance. Once all the values are filled, the instances/{id}/complete method should be called to mark it has been successfully completed by the user.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

id
required
integer <int32>

Credit instance id

header Parameters
Accept-Language
string

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

Request Body schema:

Patch credit instance request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

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

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.ICollection<OwnEquityTypeDto>>)

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

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.Collections.Generic.ICollection<CreditInstanceProductBase>>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

message
string or null

Responses

Request samples

Content type
{
  • "creditInstanceTypeId": {
    },
  • "creditInstanceUsageIds": {
    },
  • "contactGroupId": {
    },
  • "durationDays": {
    },
  • "amount": {
    },
  • "calculatedRiskClassId": {
    },
  • "calculatedRiskClassScore": {
    },
  • "calculatedCreditHistoryScore": {
    },
  • "calculatedInterestRate": {
    },
  • "ownEquityCashAmount": {
    },
  • "ownEquityAdditionalCollateralAmount": {
    },
  • "ownEquityNonCashAmount": {
    },
  • "statusId": {
    },
  • "creditInstanceIntegrationStatusId": {
    },
  • "isActive": {
    },
  • "collateralIds": {
    },
  • "repaymentIds": {
    },
  • "ownEquityTypes": {
    },
  • "billingTypeId": {
    },
  • "dynamicSchemaId": {
    },
  • "data": {
    },
  • "externalId": {
    },
  • "customAttributes": {
    },
  • "currencyId": {
    },
  • "creditFacilityTypeId": {
    },
  • "productBases": {
    },
  • "memberId": {
    },
  • "message": "string"
}

Response samples

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

Get a list of credit instances belonging to a contact Deprecated

Gets a list of all the credit instances belonging to a contact. The list of instances is determined by the contact groups the contact is a member of.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact 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 credit instance

Creates a new credit instance. This will create a new credit instance with a default instance status of “NotCompleted”. Most attributes are optional to allow its state management and the PATCH method should be used to update the instance. Once all the values are filled, the instances/{id}/complete method should be called to mark it has been successfully completed by the user.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

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

Request Body schema:

Create credit instance request

creditInstanceTypeId
integer or null <int32>
contactGroupId
required
integer <int32>
creditFacilityTypeId
integer or null <int32>
creditInstanceIntegrationStatusId
integer or null <int32>
amount
number or null <double>
calculatedInterestRate
number or null <double>
calculatedCreditHistoryScore
number or null <double>
calculatedRiskClassScore
number or null <double>
ownEquityCashAmount
number or null <double>
ownEquityNonCashAmount
number or null <double>
ownEquityAdditionalCollateralAmount
number or null <double>
calculatedRiskClassId
integer or null <int32>
collateralIds
Array of integers or null <int32> [ items <int32 > ]
creditInstanceUsageIds
Array of integers or null <int32> [ items <int32 > ]
durationDays
integer or null <int32>
repaymentIds
Array of integers or null <int32> [ items <int32 > ]
Array of objects or null (OwnEquityTypeDto)
billingTypeId
integer or null <int32>
dynamicSchemaId
integer or null <int32>
data
string or null
externalId
string or null
customAttributes
string or null
currencyId
integer or null <int32>
Array of objects or null (CreditInstanceProductBase)

Responses

Request samples

Content type
{
  • "creditInstanceTypeId": 0,
  • "contactGroupId": 0,
  • "creditFacilityTypeId": 0,
  • "creditInstanceIntegrationStatusId": 0,
  • "amount": 0.1,
  • "calculatedInterestRate": 0.1,
  • "calculatedCreditHistoryScore": 0.1,
  • "calculatedRiskClassScore": 0.1,
  • "ownEquityCashAmount": 0.1,
  • "ownEquityNonCashAmount": 0.1,
  • "ownEquityAdditionalCollateralAmount": 0.1,
  • "calculatedRiskClassId": 0,
  • "collateralIds": [
    ],
  • "creditInstanceUsageIds": [
    ],
  • "durationDays": 0,
  • "repaymentIds": [
    ],
  • "ownEquityTypes": [
    ],
  • "billingTypeId": 0,
  • "dynamicSchemaId": 0,
  • "data": "string",
  • "externalId": "string",
  • "customAttributes": "string",
  • "currencyId": 0,
  • "productBases": [
    ]
}

Response samples

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

Get a list of credit instances belonging to a contact

Gets a list of all the credit instances belonging to a contact. The list of instances is determined by the contact groups the contact is a member of.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Id

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an overview of the credit instances of a contact.

Get an overview of the credit instances of a contact. Only the credit instances in status Drawn and OfferAccepted are taken into consideration in the overview. The amounts are converted to the contacts default currency.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Id

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "totalAmount": 0.1,
  • "totalAmortization": 0.1,
  • "totalInterestRateCosts": 0.1,
  • "totalEffectiveInterestRateCosts": 0.1,
  • "totalOutstandingAmount": 0.1,
  • "contactCurrency": {
    }
}

Retrieve the repayment plan details for a Credit instance

Retrieve the repayment plan details for a Credit instance in status “Drawn” or “OfferAccepted”. The repayment plan is returned per product.

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
{
  • "offerId": 0,
  • "repaymentPlan": {
    }
}

Retrieve an overview of all the instances in the system relating to a member.

Retrieve an overview of all the instances in the system that are related to a member. Only the data that the member has access to via DFS Participants Management is taken into consideration.

Authorizations:
Bearer
query Parameters
fromDate
string <date-time>

Lower bound of the date range

toDate
string <date-time>

Upper bound of the date range

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "totalAmountOfLoans": 0.1,
  • "numberOfLoansGranted": 0,
  • "pendingLoanRequests": 0
}

Mark a credit instance as complete

Marks the credit instance as "Complete" and changes its status to "UnderReview".

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
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get a list of all the credit instances Deprecated

Gets a list of all the existing credit instances. A request body defining the pagination must be set. The page numbering starts from 1. Ordered by default based on the create date ASC. There is also the option of applying filters by credit instance type id, external id, credit instance status id.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

page
integer <int32>
pageSize
integer <int32>
creditInstanceTypeId
integer or null <int32>
statusIds
Array of integers or null <int32> [ items <int32 > ]
offerStatusIds
Array of integers or null <int32> [ items <int32 > ]
externalId
string or null
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
amountFrom
integer or null <int32>
amountTo
integer or null <int32>
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
riskClassIds
Array of integers or null <int32> [ items <int32 > ]
memberId
integer or null <int32>
assignedMemberIds
Array of integers or null <int32> [ items <int32 > ]
creditInstanceIds
Array of integers or null <int32> [ items <int32 > ]
contactGroupIds
Array of integers or null <int32> [ items <int32 > ]
sortBy
string or null

Property to sort by. Accepted values: id, status, createDate, amount, externalid, contactgroupid. If not provided, defaults to createDate.

sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "creditInstanceTypeId": 0,
  • "statusIds": [
    ],
  • "offerStatusIds": [
    ],
  • "externalId": "string",
  • "creditFacilityTypeIds": [
    ],
  • "amountFrom": 0,
  • "amountTo": 0,
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "riskClassIds": [
    ],
  • "memberId": 0,
  • "assignedMemberIds": [
    ],
  • "creditInstanceIds": [
    ],
  • "contactGroupIds": [
    ],
  • "sortBy": "string",
  • "sortOrder": "Ascending"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Get a list of all the credit instances

Gets a list of all the existing credit instances. A request body defining the pagination must be set. The page numbering starts from 1. Ordered by default based on the create date ASC. There is also the option of applying filters by credit instance type id, external id, credit instance status id, contact group ids. Sorting can be customized using the sortBy parameter with values: id, status, createDate, amount, externalid, contactgroupid. The sortOrder parameter (Ascending=0, Descending=1) can be used to control sort direction.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

page
integer <int32>
pageSize
integer <int32>
creditInstanceTypeId
integer or null <int32>
statusIds
Array of integers or null <int32> [ items <int32 > ]
offerStatusIds
Array of integers or null <int32> [ items <int32 > ]
externalId
string or null
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
amountFrom
integer or null <int32>
amountTo
integer or null <int32>
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
riskClassIds
Array of integers or null <int32> [ items <int32 > ]
memberId
integer or null <int32>
assignedMemberIds
Array of integers or null <int32> [ items <int32 > ]
creditInstanceIds
Array of integers or null <int32> [ items <int32 > ]
contactGroupIds
Array of integers or null <int32> [ items <int32 > ]
sortBy
string or null

Property to sort by. Accepted values: id, status, createDate, amount, externalid, contactgroupid. If not provided, defaults to createDate.

sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "creditInstanceTypeId": 0,
  • "statusIds": [
    ],
  • "offerStatusIds": [
    ],
  • "externalId": "string",
  • "creditFacilityTypeIds": [
    ],
  • "amountFrom": 0,
  • "amountTo": 0,
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "riskClassIds": [
    ],
  • "memberId": 0,
  • "assignedMemberIds": [
    ],
  • "creditInstanceIds": [
    ],
  • "contactGroupIds": [
    ],
  • "sortBy": "string",
  • "sortOrder": "Ascending"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Assign a member to an instance

Assign the member to a credit instance.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

instanceId
required
integer <int32>

Credit instance id

memberId
required
integer <int32>

Member 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"
}

Remove member assignment from an instance

Remove member assignment from an 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

Response samples

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

Anonymize credit instance data.

Anonymize all the credit instances data related to the list of contact groups passed.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Anonymize credit instances request

contactGroupIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "contactGroupIds": [
    ]
}

Response samples

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

CreditInstanceType

Delete a credit instance type

Deletes an existing credit instance type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditInstanceType 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 credit instance type

Modifies an existing credit instance type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditInstanceTypeId of the credit instance type that will be modified

header Parameters
Accept-Language
string

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

Request Body schema:

Patch credit instance type request

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "key": {
    },
  • "externalId": {
    }
}

Response samples

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

Get a list of credit instance types

Gets a list of all the existing credit instance 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 credit instance type

Creates a new credit instance type which can be used to configure the credit facility or allow the customer to specify its credit instance.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Create credit instance type request

name
required
string non-empty
key
required
string non-empty
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "key": "string",
  • "externalId": "string"
}

Response samples

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

CreditStatus

Get a list of credit instance statuses

Gets a list of all the existing credit instance statuses.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Documents

Retrieve all the documents that are uploaded for a credit instance

Retrieves all the documents that are uploaded for a credit instance. The documents returned will be grouped by client documents and credit instance documents.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact ID

instanceId
required
integer <int32>

Credit Instance ID

query Parameters
languageTwoLetterIsoCode
string
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "clientDocuments": [
    ],
  • "creditInstanceDocuments": [
    ],
  • "offerDocuments": [
    ]
}

Upload a document in DMS and mark the status to “Uploaded” on the offer documentation Deprecated

Uploads a document in DMS and mark the status to "Uploaded" on the offer documentation. The status change is done for every dms document metadata id present in the offer documentation.

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.

Request Body schema:

Upload document request

fileName
required
string non-empty
offerId
integer or null <int32>

Set the offer for which the document will be linked.

dmsDocumentMetadataId
integer <int32>

Set under which metadata will the document be using metadata id. If both metadata id and metadata reference id are supplied, this field takes precedence.

ownerIds
Array of integers or null <int32> [ items <int32 > ]

Set owners of a document. A client-type document must have at least one contact as owner. General-type documents should not have contacts as owners.

customAttributes
string or null
externalId
string or null

Set a unique external-id for the document. A document may later be fetched by the external-id alone.

validTill
string or null <date-time>

Set validity of the document. This field is informational only and does not effect the active state of the document.

metadataReferenceId
string or null

Set under which metadata will the document be using metadata reference id

languageTwoLetterIsoCode
string or null
file
required
string <byte>
proxyParticipantUid
string or null <uuid>
fileType
string or null
creditInstanceUid
string or null <uuid>

Responses

Request samples

Content type
{
  • "fileName": "string",
  • "offerId": 0,
  • "dmsDocumentMetadataId": 0,
  • "ownerIds": [
    ],
  • "customAttributes": "string",
  • "externalId": "string",
  • "validTill": "2019-08-24T14:15:22Z",
  • "metadataReferenceId": "string",
  • "languageTwoLetterIsoCode": "string",
  • "file": "string",
  • "proxyParticipantUid": "7fec805a-0620-484b-855b-42da4bcb4859",
  • "fileType": "string",
  • "creditInstanceUid": "13038638-c4c3-44ea-8b75-8c353f9b2537"
}

Response samples

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

Retrieve all the documents that are uploaded for an offer

Retrieves all the documents that are uploaded for an offer. The documents returned will be grouped by client documents which are shared across the credit instance and offer documents which are specific to offer based on the lender configuration.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact ID

instanceId
required
integer <int32>

Credit Instance ID

offerId
required
integer <int32>

Offer ID

query Parameters
languageTwoLetterIsoCode
string
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "clientDocuments": [
    ],
  • "creditInstanceDocuments": [
    ],
  • "offerDocuments": [
    ]
}

Retrieve document extracted data from cache

Retrieve cached data related to a credit instance that comes out of the document extraction process.

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
[
  • {
    }
]

Upload a document in DMS and mark the status to “Uploaded” on the offer documentation

Uploads a document in DMS and mark the status to "Uploaded" on the offer documentation. The status change is done for every dms document metadata id present in the offer documentation. Allows sending of parameter “EnableDocumentExtraction” (default true) to indicate if the uploaded document is passed to the DFS document extraction service or not. Once the service extracts the data this endpoint will publish an event via the publish/events endpoint.

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.

Request Body schema: multipart/form-data
file
required
string <binary>
fileName
required
string <string>
offerId
integer or null <int32>
dmsDocumentMetadataId
integer <int32>
Default: 0
ownerIds
required
Array of integers <int32> [ items <int32 > ]
customAttributes
string <string>
externalId
string <string>
validTill
string <date-time>
metadataReferenceId
string <string>
languageTwoLetterIsoCode
string <string>
enableDocumentExtraction
boolean <boolean>

Responses

Response samples

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

Search documentation for credit instance or offer

Retrieves a list of all credit instance or offer documentation grouped by category and document contexts based on provided filters.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

contactId
integer <int32>
creditInstanceId
integer <int32>
offerId
integer or null <int32>
languageTwoLetterIsoCode
string or null

Responses

Request samples

Content type
{
  • "contactId": 0,
  • "creditInstanceId": 0,
  • "offerId": 0,
  • "languageTwoLetterIsoCode": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

IntegrationStatus

Delete a credit instance integration status

Deletes an existing credit instance integration status.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Integration status 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 credit instance integration status

Modifies an existing credit instance integration status which can be used to track external status updates.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Integration status Id

header Parameters
Accept-Language
string

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

Request Body schema:

Patch integration status request

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "externalId": {
    }
}

Response samples

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

Get a list of credit instance integration statuses

Gets a list of all the existing credit instance integration statuses.

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 credit instance integration status

Creates a new credit instance integration status which can be used to track external status updates.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Create integration status request

name
required
string non-empty
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "externalId": "string"
}

Response samples

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

Offer

Get all the offers linked to an existing credit instance

Gets all the offers linked to an existing credit instance.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

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 offer for an existing credit instance

Creates a new offer for an existing credit instance. If offers exist in the system for the same credit facility id + lender id with the same passed origination flag is system generated, they will be set to inactive.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Create Offer Request

creditFacilityId
required
integer <int32>
lenderId
required
integer <int32>
required
object (Detail)
comments
string or null

Responses

Request samples

Content type
{
  • "creditFacilityId": 0,
  • "lenderId": 0,
  • "details": {
    },
  • "comments": "string"
}

Response samples

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

Get all the offers linked to an existing contact and credit instance

Gets all the offers linked to an existing contact and credit instance.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Identifier

instanceId
required
integer <int32>

Instance Identifier

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Modify the details of an existing offer

Modifies the details of an existing offer.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

offerId
required
integer <int32>

Offer Identifier

detailId
required
integer <int32>

Detail Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Patch Request

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

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<DateTime>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

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 (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 (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.Collections.Generic.IList<DetailFee>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IList<DetailKeyRiskIndicator>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.IList<DetailProduct>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "riskClassId": {
    },
  • "riskClassScore": {
    },
  • "loanAmount": {
    },
  • "amortizationAmount": {
    },
  • "financedCollateralValue": {
    },
  • "isAccepted": {
    },
  • "externalId": {
    },
  • "validityDate": {
    },
  • "customAttributes": {
    },
  • "ownEquityCashAmount": {
    },
  • "ownEquityNonCashAmount": {
    },
  • "ownEquityAdditionalCollateralAmount": {
    },
  • "interestRate": {
    },
  • "effectiveInterestRate": {
    },
  • "interestRateCosts": {
    },
  • "effectiveInterestRateCosts": {
    },
  • "outstandingAmount": {
    },
  • "durationDays": {
    },
  • "fees": {
    },
  • "keyRiskIndicatorDetails": {
    },
  • "products": {
    }
}

Response samples

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

Set an offer breach to inactive

Sets an offer breach to inactive.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance ID

detailId
required
integer <int32>

Offer detail ID

breachId
required
integer <int32>

Breach 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 the status or comments of an existing offer

Modifies the status or comments of an existing offer.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

offerId
required
integer <int32>

Offer Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Patch Offer Status Request

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<RejectionDetails>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "statusId": {
    },
  • "creditInstanceIntegrationStatusId": {
    },
  • "comments": {
    },
  • "rejectionDetails": {
    }
}

Response samples

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

Create a new offer breach

Creates a new offer breach. The breach can be created for either a key risk indicator detail or for a combination of risk class + risk model. The request will not be accepted if both key risk indicator detail id and risk class + risk model is passed.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance ID

detailId
required
integer <int32>

Offer detail ID

header Parameters
Accept-Language
string

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

Request Body schema:

Request

keyRiskIndicatorDetailId
integer or null <int32>
keyRiskIndicatorId
integer or null <int32>
riskClassId
integer or null <int32>
riskModelId
integer or null <int32>
calculatedValue
number <double>

Responses

Request samples

Content type
{
  • "keyRiskIndicatorDetailId": 0,
  • "keyRiskIndicatorId": 0,
  • "riskClassId": 0,
  • "riskModelId": 0,
  • "calculatedValue": 0.1
}

Response samples

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

Get all credit instances for an offer Deprecated

Gets all credit instances for an offer.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
creditInstanceId
integer or null <int32>
offerStatusIds
Array of integers or null <int32> [ items <int32 > ]
offerExternalId
string or null
offerAmountFrom
number or null <double>
offerAmountTo
number or null <double>
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
statusIds
Array of integers or null <int32> [ items <int32 > ]
riskClassIds
Array of integers or null <int32> [ items <int32 > ]
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
assignedMemberIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "creditInstanceId": 0,
  • "offerStatusIds": [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0.1,
  • "offerAmountTo": 0.1,
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "statusIds": [
    ],
  • "riskClassIds": [
    ],
  • "creditFacilityTypeIds": [
    ],
  • "assignedMemberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Get a list of offers Deprecated

Gets all credit instances for an offer.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
offerIds
Array of integers or null <int32> [ items <int32 > ]
creditInstanceId
integer or null <int32>
offerStatusIds
Array of integers or null <int32> [ items <int32 > ]
offerExternalId
string or null
offerAmountFrom
number or null <double>
offerAmountTo
number or null <double>
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
statusIds
Array of integers or null <int32> [ items <int32 > ]
riskClassIds
Array of integers or null <int32> [ items <int32 > ]
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
assignedMemberIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "offerIds": [
    ],
  • "creditInstanceId": 0,
  • "offerStatusIds": [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0.1,
  • "offerAmountTo": 0.1,
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "statusIds": [
    ],
  • "riskClassIds": [
    ],
  • "creditFacilityTypeIds": [
    ],
  • "assignedMemberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Get a list of offers

Get a list of offers and its corresponding credit instance details.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Search request

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
offerIds
Array of integers or null <int32> [ items <int32 > ]
creditInstanceId
integer or null <int32>
offerStatusIds
Array of integers or null <int32> [ items <int32 > ]
offerExternalId
string or null
offerAmountFrom
number or null <double>
offerAmountTo
number or null <double>
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
statusIds
Array of integers or null <int32> [ items <int32 > ]
riskClassIds
Array of integers or null <int32> [ items <int32 > ]
creditFacilityTypeIds
Array of integers or null <int32> [ items <int32 > ]
assignedMemberIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "offerIds": [
    ],
  • "creditInstanceId": 0,
  • "offerStatusIds": [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0.1,
  • "offerAmountTo": 0.1,
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "statusIds": [
    ],
  • "riskClassIds": [
    ],
  • "creditFacilityTypeIds": [
    ],
  • "assignedMemberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Simulate offers based on an existing credit instance id

Simulates the offers that the system will generate with the existing data found in a credit instance. This includes eligibility criteria set for each lender’s credit facility. The returned result will not be stored in the system. Depending on the completeness of the credit instance, collateral details and CRM data, the offers might be different from one execution to the other.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Identifier

instanceId
required
integer <int32>

Instance Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Simulate Offer Request

lenderIds
Array of integers or null <int32> [ items <int32 > ]
withFees
boolean or null

Responses

Request samples

Content type
{
  • "lenderIds": [
    ],
  • "withFees": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Generate offers based on an existing credit instance id.

Generate offers based on the system configuration with the existing data found in a credit instance. The returned result will be stored in the system. A list of LenderIds can be passed to pre-select for which lenders the offers will be created, otherwise all the lenders found in the Credit Instance based on its Credit Facility will be selected.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Identifier

instanceId
required
integer <int32>

Instance Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Generate Offer Request

lenderIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "lenderIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Assign a member to an offer

Assign the member to an offer.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

instanceId
required
integer <int32>

Credit instance id

offerId
required
integer <int32>

Offer id

memberId
required
integer <int32>

Member 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"
}

Remove member assignment from an offer

Remove member assignment from an offer.

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
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

OfferDocumentation

Modify documentation for an existing offer

Modifies documentation for an existing offer.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

offerId
required
integer <int32>

Offer Identifier

documentationId
required
integer <int32>

Offer Documentation Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Patch Offer Documentation Request

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "offerDocumentationStatusId": {
    },
  • "customAttributes": {
    }
}

Response samples

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

Modify documentation status for an existing offer

Modifies documentation status for an existing offer by passing a list of offer documents.

Authorizations:
Bearer
path Parameters
instanceId
required
integer <int32>

Instance Identifier

offerId
required
integer <int32>

Offer Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Patch Offer Documentation Status Request

required
Array of objects (OfferDocumentationDetails)

Responses

Request samples

Content type
{
  • "offerDocumentationDetails": [
    ]
}

Response samples

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

OfferDocumentationStatus

Get all the offer documentation statuses

Gets all the offer documentation statuses.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]