Loading
Documentation Powered by ReDoc

DFS Credit Instance Services API (latest)

Download OpenAPI specification:Download

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditInstanceId": 0,
  • "creditInstanceUid": "string",
  • "creditInstanceTypeId":
    {
    },
  • "creditUsageIds":
    [
    ],
  • "contactGroupId": 0,
  • "durationDays": 0,
  • "amount": 0,
  • "calculatedRiskClassId": 0,
  • "calculatedRiskClassScore": 0,
  • "calculatedCreditHistoryScore": 0,
  • "calculatedInterestRate": 0,
  • "ownEquityCashAmount": 0,
  • "ownEquityNonCashAmount": 0,
  • "ownEquityAdditionalCollateralAmount": 0,
  • "creditStatus":
    {
    },
  • "creditInstanceIntegrationStatus":
    {
    },
  • "isActive": true,
  • "isComplete": true,
  • "createDate": "2025-05-09T12:06:31Z",
  • "collateralIds":
    [
    ],
  • "repaymentIds":
    [
    ],
  • "offers":
    [
    ],
  • "ownEquityTypes":
    [
    ],
  • "billingTypeId": 0,
  • "customAttributes": "string",
  • "externalId": "string",
  • "creditFacilityTypeId": 0,
  • "creditFacilityType":
    {
    },
  • "memberId": 0,
  • "assignedMemberId": 0,
  • "currencyId": 0,
  • "currency":
    {
    },
  • "closingDate": "2025-05-09T12:06:31Z",
  • "productBases":
    [
    ],
  • "documentation":
    [
    ]
}

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

Patch credit instance request

creditInstanceTypeId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

creditInstanceUsageIds
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E)

Wrapper around properties used in patch requests

contactGroupId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

durationDays
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

amount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

calculatedRiskClassId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

calculatedRiskClassScore
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

calculatedCreditHistoryScore
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

calculatedInterestRate
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

ownEquityCashAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

ownEquityAdditionalCollateralAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

ownEquityNonCashAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

statusId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

creditInstanceIntegrationStatusId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

isActive
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

collateralIds
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E)

Wrapper around properties used in patch requests

repaymentIds
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E)

Wrapper around properties used in patch requests

ownEquityTypes
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3COwnEquityTypeDto%3E%3E)

Wrapper around properties used in patch requests

billingTypeId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

externalId
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

customAttributes
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

currencyId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

creditFacilityTypeId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

productBases
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CCreditInstanceProductBase%3E%3E)

Wrapper around properties used in patch requests

memberId
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}/instances/{id}
https://example-host/v1.0/contacts/{contactId}/instances/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditInstanceTypeId":
    {
    },
  • "creditInstanceUsageIds":
    {
    },
  • "contactGroupId":
    {
    },
  • "durationDays":
    {
    },
  • "amount":
    {
    },
  • "calculatedRiskClassId":
    {
    },
  • "calculatedRiskClassScore":
    {
    },
  • "calculatedCreditHistoryScore":
    {
    },
  • "calculatedInterestRate":
    {
    },
  • "ownEquityCashAmount":
    {
    },
  • "ownEquityAdditionalCollateralAmount":
    {
    },
  • "ownEquityNonCashAmount":
    {
    },
  • "statusId":
    {
    },
  • "creditInstanceIntegrationStatusId":
    {
    },
  • "isActive":
    {
    },
  • "collateralIds":
    {
    },
  • "repaymentIds":
    {
    },
  • "ownEquityTypes":
    {
    },
  • "billingTypeId":
    {
    },
  • "externalId":
    {
    },
  • "customAttributes":
    {
    },
  • "currencyId":
    {
    },
  • "creditFacilityTypeId":
    {
    },
  • "productBases":
    {
    },
  • "memberId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Create credit instance request

creditInstanceTypeId
integer <int32> Nullable
contactGroupId
required
integer <int32>
creditFacilityTypeId
integer <int32> Nullable
creditInstanceIntegrationStatusId
integer <int32> Nullable
amount
number <double> Nullable
calculatedInterestRate
number <double> Nullable
calculatedCreditHistoryScore
number <double> Nullable
calculatedRiskClassScore
number <double> Nullable
ownEquityCashAmount
number <double> Nullable
ownEquityNonCashAmount
number <double> Nullable
ownEquityAdditionalCollateralAmount
number <double> Nullable
calculatedRiskClassId
integer <int32> Nullable
collateralIds
Array of integers <int32> Nullable
creditInstanceUsageIds
Array of integers <int32> Nullable
durationDays
integer <int32> Nullable
repaymentIds
Array of integers <int32> Nullable
ownEquityTypes
Array of objects (OwnEquityTypeDto) Nullable
billingTypeId
integer <int32> Nullable
externalId
string Nullable
customAttributes
string Nullable
currencyId
integer <int32> Nullable
productBases
Array of objects (CreditInstanceProductBase) Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditInstanceTypeId": 0,
  • "contactGroupId": 0,
  • "creditFacilityTypeId": 0,
  • "creditInstanceIntegrationStatusId": 0,
  • "amount": 0,
  • "calculatedInterestRate": 0,
  • "calculatedCreditHistoryScore": 0,
  • "calculatedRiskClassScore": 0,
  • "ownEquityCashAmount": 0,
  • "ownEquityNonCashAmount": 0,
  • "ownEquityAdditionalCollateralAmount": 0,
  • "calculatedRiskClassId": 0,
  • "collateralIds":
    [
    ],
  • "creditInstanceUsageIds":
    [
    ],
  • "durationDays": 0,
  • "repaymentIds":
    [
    ],
  • "ownEquityTypes":
    [
    ],
  • "billingTypeId": 0,
  • "externalId": "string",
  • "customAttributes": "string",
  • "currencyId": 0,
  • "productBases":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contacts/{contactId}/instances/overview
https://example-host/v1.0/contacts/{contactId}/instances/overview

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalAmount": 0,
  • "totalAmortization": 0,
  • "totalInterestRateCosts": 0,
  • "totalEffectiveInterestRateCosts": 0,
  • "totalOutstandingAmount": 0,
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contacts/{contactId}/creditinstances/{instanceId}/repayment-plan
https://example-host/v1.0/contacts/{contactId}/creditinstances/{instanceId}/repayment-plan

Response samples

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/members/instances/overview
https://example-host/v1.0/members/instances/overview

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalAmountOfLoans": 0,
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Search request

page
integer <int32>
pageSize
integer <int32>
creditInstanceTypeId
integer <int32> Nullable
statusIds
Array of integers <int32> Nullable
offerStatusIds
Array of integers <int32> Nullable
externalId
string Nullable
creditFacilityTypeIds
Array of integers <int32> Nullable
amountFrom
integer <int32> Nullable
amountTo
integer <int32> Nullable
createDateFrom
string <date-time> Nullable
createDateTo
string <date-time> Nullable
riskClassIds
Array of integers <int32> Nullable
memberId
integer <int32> Nullable
assignedMemberIds
Array of integers <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/search
https://example-host/v1.0/instances/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "creditInstanceTypeId": 0,
  • "statusIds":
    [
    ],
  • "offerStatusIds":
    [
    ],
  • "externalId": "string",
  • "creditFacilityTypeIds":
    [
    ],
  • "amountFrom": 0,
  • "amountTo": 0,
  • "createDateFrom": "2025-05-09T12:06:31Z",
  • "createDateTo": "2025-05-09T12:06:31Z",
  • "riskClassIds":
    [
    ],
  • "memberId": 0,
  • "assignedMemberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
application/json

Search request

page
integer <int32>
pageSize
integer <int32>
creditInstanceTypeId
integer <int32> Nullable
statusIds
Array of integers <int32> Nullable
offerStatusIds
Array of integers <int32> Nullable
externalId
string Nullable
creditFacilityTypeIds
Array of integers <int32> Nullable
amountFrom
integer <int32> Nullable
amountTo
integer <int32> Nullable
createDateFrom
string <date-time> Nullable
createDateTo
string <date-time> Nullable
riskClassIds
Array of integers <int32> Nullable
memberId
integer <int32> Nullable
assignedMemberIds
Array of integers <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/instances/search
https://example-host/v1.1/instances/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "creditInstanceTypeId": 0,
  • "statusIds":
    [
    ],
  • "offerStatusIds":
    [
    ],
  • "externalId": "string",
  • "creditFacilityTypeIds":
    [
    ],
  • "amountFrom": 0,
  • "amountTo": 0,
  • "createDateFrom": "2025-05-09T12:06:31Z",
  • "createDateTo": "2025-05-09T12:06:31Z",
  • "riskClassIds":
    [
    ],
  • "memberId": 0,
  • "assignedMemberIds":
    [
    ]
}

Response samples

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/instances/{instanceId}/members/{memberId}/assign-member
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/members/{memberId}/assign-member

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/instances/{instanceId}/members/unassign-member
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/members/unassign-member

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Anonymize credit instances request

contactGroupIds
Array of integers <int32> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/anonymize
https://example-host/v1.0/instances/anonymize

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contactGroupIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/instances/types/{id}
https://example-host/v1.0/instances/types/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Patch credit instance type request

name
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

key
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

externalId
object (Api.Common.UpdateableProperty%3CString%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/instances/types/{id}
https://example-host/v1.0/instances/types/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "key":
    {
    },
  • "externalId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/instances/types
https://example-host/v1.0/instances/types

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Create credit instance type request

name
required
string non-empty
key
required
string non-empty
externalId
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/types
https://example-host/v1.0/instances/types

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "key": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/instances/statuses
https://example-host/v1.0/instances/statuses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "clientDocuments":
    [
    ],
  • "creditInstanceDocuments":
    [
    ]
}

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

Upload document request

fileName
required
string non-empty
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 <int32> Nullable

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 Nullable
externalId
string Nullable

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

validTill
string <date-time> Nullable

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

metadataReferenceId
string Nullable

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

languageTwoLetterIsoCode
string Nullable
file
required
string <byte>
proxyParticipantUid
string <uuid> Nullable
fileType
string Nullable
creditInstanceUid
string <uuid> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fileName": "string",
  • "dmsDocumentMetadataId": 0,
  • "ownerIds":
    [
    ],
  • "customAttributes": "string",
  • "externalId": "string",
  • "validTill": "2025-05-09T12:06:31Z",
  • "metadataReferenceId": "string",
  • "languageTwoLetterIsoCode": "string",
  • "file": "string",
  • "proxyParticipantUid": "string",
  • "fileType": "string",
  • "creditInstanceUid": "string"
}

Response samples

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

header Parameters
Accept-Language
string

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

Responses

200

OK

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}/documents
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/documents

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "clientDocuments":
    [
    ],
  • "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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contacts/{contactId}/instances/{instanceId}/cached-documents-data
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/cached-documents-data

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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>
dmsDocumentMetadataId
integer <int32>
Default: 0
ownerIds
required
Array of integers <int32>
customAttributes
string <string>
externalId
string <string>
validTill
string <date-time>
metadataReferenceId
string <string>
languageTwoLetterIsoCode
string <string>
enableDocumentExtraction
boolean <boolean>

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/contacts/{contactId}/instances/{instanceId}/documents
https://example-host/v1.1/contacts/{contactId}/instances/{instanceId}/documents

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Search request

contactId
integer <int32>
creditInstanceId
integer <int32>
offerId
integer <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/documentation/search
https://example-host/v1.0/instances/documentation/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contactId": 0,
  • "creditInstanceId": 0,
  • "offerId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/instances/integrationstatuses/{id}
https://example-host/v1.0/instances/integrationstatuses/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Patch integration status request

name
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

externalId
object (Api.Common.UpdateableProperty%3CString%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/instances/integrationstatuses/{id}
https://example-host/v1.0/instances/integrationstatuses/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "externalId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/instances/integrationstatuses
https://example-host/v1.0/instances/integrationstatuses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Create integration status request

name
required
string non-empty
externalId
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/integrationstatuses
https://example-host/v1.0/instances/integrationstatuses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/instances/{instanceId}/offers
https://example-host/v1.0/instances/{instanceId}/offers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Create Offer Request

creditFacilityId
required
integer <int32>
lenderId
required
integer <int32>
details
required
object (Detail)
comments
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/{instanceId}/offers
https://example-host/v1.0/instances/{instanceId}/offers

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creditFacilityId": 0,
  • "lenderId": 0,
  • "details":
    {
    },
  • "comments": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Patch Request

riskClassId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

riskClassScore
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

loanAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

amortizationAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

financedCollateralValue
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

isAccepted
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E)

Wrapper around properties used in patch requests

externalId
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

validityDate
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDateTime%3E%3E)

Wrapper around properties used in patch requests

customAttributes
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

ownEquityCashAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

ownEquityNonCashAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

ownEquityAdditionalCollateralAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

interestRate
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

effectiveInterestRate
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

interestRateCosts
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

effectiveInterestRateCosts
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

outstandingAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

durationDays
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

fees
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IList%3CDetailFee%3E%3E)

Wrapper around properties used in patch requests

keyRiskIndicatorDetails
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IList%3CDetailKeyRiskIndicator%3E%3E)

Wrapper around properties used in patch requests

products
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.IList%3CDetailProduct%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/instances/{instanceId}/offers/{offerId}/details/{detailId}
https://example-host/v1.0/instances/{instanceId}/offers/{offerId}/details/{detailId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/instances/{instanceId}/offers/details/{detailId}/breaches/{breachId}/inactivate
https://example-host/v1.0/instances/{instanceId}/offers/details/{detailId}/breaches/{breachId}/inactivate

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Patch Offer Status Request

statusId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

creditInstanceIntegrationStatusId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

comments
object (Api.Common.UpdateableProperty%3CString%3E)

Wrapper around properties used in patch requests

rejectionDetails
object (Api.Common.UpdateableProperty%3CRejectionDetails%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/instances/{instanceId}/offers/{offerId}
https://example-host/v1.0/instances/{instanceId}/offers/{offerId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "statusId":
    {
    },
  • "creditInstanceIntegrationStatusId":
    {
    },
  • "comments":
    {
    },
  • "rejectionDetails":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Request

keyRiskIndicatorDetailId
integer <int32> Nullable
keyRiskIndicatorId
integer <int32> Nullable
riskClassId
integer <int32> Nullable
riskModelId
integer <int32> Nullable
calculatedValue
number <double>

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/instances/{instanceId}/offers/details/{detailId}/breaches
https://example-host/v1.0/instances/{instanceId}/offers/details/{detailId}/breaches

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keyRiskIndicatorDetailId": 0,
  • "keyRiskIndicatorId": 0,
  • "riskClassId": 0,
  • "riskModelId": 0,
  • "calculatedValue": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Search request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/offers/instances/search
https://example-host/v1.0/offers/instances/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "creditInstanceId": 0,
  • "offerStatusIds":
    [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0,
  • "offerAmountTo": 0,
  • "createDateFrom": "2025-05-09T12:06:31Z",
  • "createDateTo": "2025-05-09T12:06:31Z",
  • "statusIds":
    [
    ],
  • "riskClassIds":
    [
    ],
  • "creditFacilityTypeIds":
    [
    ],
  • "assignedMemberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Search request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/offers/search
https://example-host/v1.0/offers/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "offerIds":
    [
    ],
  • "creditInstanceId": 0,
  • "offerStatusIds":
    [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0,
  • "offerAmountTo": 0,
  • "createDateFrom": "2025-05-09T12:06:31Z",
  • "createDateTo": "2025-05-09T12:06:31Z",
  • "statusIds":
    [
    ],
  • "riskClassIds":
    [
    ],
  • "creditFacilityTypeIds":
    [
    ],
  • "assignedMemberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Search request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/offers/search
https://example-host/v1.1/offers/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "offerIds":
    [
    ],
  • "creditInstanceId": 0,
  • "offerStatusIds":
    [
    ],
  • "offerExternalId": "string",
  • "offerAmountFrom": 0,
  • "offerAmountTo": 0,
  • "createDateFrom": "2025-05-09T12:06:31Z",
  • "createDateTo": "2025-05-09T12:06:31Z",
  • "statusIds":
    [
    ],
  • "riskClassIds":
    [
    ],
  • "creditFacilityTypeIds":
    [
    ],
  • "assignedMemberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Simulate Offer Request

lenderIds
Array of integers <int32> Nullable
withFees
boolean Nullable
isSimulation
boolean

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "lenderIds":
    [
    ],
  • "withFees": true,
  • "isSimulation": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

Generate Offer Request

lenderIds
Array of integers <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "lenderIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/members/{memberId}/assign-member
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/members/{memberId}/assign-member

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/members/unassign-member
https://example-host/v1.0/contacts/{contactId}/instances/{instanceId}/offers/{offerId}/members/unassign-member

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Patch Offer Documentation Request

offerDocumentationStatusId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

customAttributes
object (Api.Common.UpdateableProperty%3CString%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/instances/{instanceId}/offers/{offerId}/documentation/{documentationId}
https://example-host/v1.0/instances/{instanceId}/offers/{offerId}/documentation/{documentationId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "offerDocumentationStatusId":
    {
    },
  • "customAttributes":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

Patch Offer Documentation Status Request

offerDocumentationDetails
required
Array of objects (OfferDocumentationDetails)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/instances/{instanceId}/offers/{offerId}/documentation/status
https://example-host/v1.0/instances/{instanceId}/offers/{offerId}/documentation/status

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "offerDocumentationDetails":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/offers/documentationstatus
https://example-host/v1.0/offers/documentationstatus

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]