API docs by Redocly

Aptic API Gateway - Loan originations (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Loan origination related API for Aptic solutions

Originations

Get list of loan/leasing originations based on specified parameters.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Starts a new origination process by register the new credit application based on specified parameters.

Authorizations:
(oauth2apikey)
Request Body schema:

Credit application detailed information.

clientReference
string or null

client reference string.

customerAccountTypeCode
string or null

CustomerAccount type code.

loanType
string or null

Customer account subtype code.

brokerPartyReference
string or null

Broker Party Reference.

object (CreditApplication)

Origination (credit application) description.

object (CreditApplicantRequest)

Credit applicant request

Array of objects or null (CreditApplicantRequest)

List of credit co-applicants.

Array of objects or null (Object)

List of objects connected to loan.

Array of objects or null (LoanToSettle)

List of loans to settle.

Array of objects or null (PutInsurance)

List of insurances.

Responses

Request samples

Content type
{
  • "clientReference": "string",
  • "customerAccountTypeCode": "string",
  • "loanType": "string",
  • "brokerPartyReference": "string",
  • "creditApplication": {
    },
  • "mainApplicant": {
    },
  • "coApplicants": [
    ],
  • "objects": [
    ],
  • "loansToSettle": [
    ],
  • "insurances": [
    ]
}

Response samples

Content type
{
  • "customerAccountTypeCode": "string",
  • "loanType": "string",
  • "accountNumber": "string",
  • "accountGuid": "string",
  • "originationGuid": "string",
  • "clientReferenceCode": "string",
  • "clientFullName": "string",
  • "currencyCode": "EUR, USD, SEK, NOK, DKK",
  • "originalAppliedCreditAmount": 0,
  • "appliedCreditAmount": 0,
  • "offeredAmount": 0,
  • "acceptedAmount": 0,
  • "assetValue": 0,
  • "residualValue": 0,
  • "applicationDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "originalDurationInMonths": 0,
  • "durationInMonths": 0,
  • "reason": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "status": "NewApplication",
  • "lastDisbursementDate": "2019-08-24T14:15:22Z",
  • "extraFields": [
    ],
  • "applicants": [
    ],
  • "links": [
    ]
}

Get loan/leasing origination.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the origination.

Responses

Response samples

Content type
{
  • "customerAccountTypeCode": "string",
  • "loanType": "string",
  • "accountNumber": "string",
  • "accountGuid": "string",
  • "originationGuid": "string",
  • "clientReferenceCode": "string",
  • "clientFullName": "string",
  • "currencyCode": "EUR, USD, SEK, NOK, DKK",
  • "originalAppliedCreditAmount": 0,
  • "appliedCreditAmount": 0,
  • "offeredAmount": 0,
  • "acceptedAmount": 0,
  • "assetValue": 0,
  • "residualValue": 0,
  • "applicationDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "originalDurationInMonths": 0,
  • "durationInMonths": 0,
  • "reason": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "status": "NewApplication",
  • "lastDisbursementDate": "2019-08-24T14:15:22Z",
  • "extraFields": [
    ],
  • "applicants": [
    ],
  • "links": [
    ]
}

Updates a credit application based on specified parameters.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Credit application GUID identifyer.

Request Body schema:

Credit application detailed information.

originalAppliedCreditAmount
number or null <double>

Original applied credit amount.

appliedCreditAmount
number <double>

Applied credit amount.

offeredAmount
number or null <double>

Offered amount by the lender.

acceptedAmount
number or null <double>

Accepted amount by the borrower.

assetValue
number or null <double>

Asset value of leasing object(s).

residualValue
number or null <double>

Residual value of leasing object(s).

startDate
string or null <date-time>

The application start date.

originalDurationInMonths
integer or null <int32>

The original application duration in months.

durationInMonths
integer or null <int32>

The application duration in months.

reason
string or null

The application reason.

interestRate
number or null <double>

The interest rate of application.

interestCode
string or null

The interest code of application.

status
string (OriginationStatus)
Enum: "NewApplication" "Analysis" "AwaitingConfirmation" "AwaitingAdditionalInfo" "AwaitingSignature" "Rejected" "Approved" "Lost" "Terminated"

Status of the loan/leasing origination.

Responses

Request samples

Content type
{
  • "originalAppliedCreditAmount": 0,
  • "appliedCreditAmount": 0,
  • "offeredAmount": 0,
  • "acceptedAmount": 0,
  • "assetValue": 0,
  • "residualValue": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "originalDurationInMonths": 0,
  • "durationInMonths": 0,
  • "reason": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "status": "NewApplication"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Terminate the credit application by origination unique identifier.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the origination

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get list of a history actions for specified credit applicant.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Credit application GUID.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "historyDocuments": [
    ]
}

Returns the history action document.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Credit application GUID.

docGuid
required
string

History action document's unique identifier.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Waits for a loan activation during specified interval in milliseconds and returns the loan statuses.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The account identifier for a loan.

query Parameters
Timeout
integer <int32>
Default: 5000

Optionally set timeout to wait for result.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "active": true,
  • "statuses": [
    ]
}

Register a raise credit

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The guid representing the origination

Request Body schema:

Raise credit detailed information

object (RaiseCreditApplication)
Array of objects or null (LoanToSettle)

List of loans to settle

Responses

Request samples

Content type
{
  • "creditApplication": {
    },
  • "loansToSettle": [
    ]
}

Get list insurances for specified credit application.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Credit application GUID.

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Create insurance

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string
Request Body schema:

Insurance data

type
string or null

Insurance type code

insuranceCompany
string or null

Insurance company reference

status
integer <int32> (InsuranceStatus)
Enum: 0 1 2 3 4
reference
string or null

Insurance reference

endDate
string or null <date-time>

Insruace end date

insuranceCalcType
integer <int32> (InsuranceCalcType)
Enum: 1 4
feePercent
number <double>

Insurance fee amount

minPeriodicFee
number <double>

Minumal periodic fee

maxPeriodicFee
number or null <double>

Maximal periodic fee

note
string or null

Note

Responses

Request samples

Content type
{
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "maxPeriodicFee": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "creditInsuranceGuid": "string",
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "maxPeriodicFee": 0,
  • "note": "string"
}

Get list of insurances based on specified parameters.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get insurance

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the insurance.

Responses

Response samples

Content type
{
  • "creditInsuranceGuid": "string",
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "maxPeriodicFee": 0,
  • "note": "string",
  • "links": [
    ]
}

Delete insurance by unique identifier.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the insurnace

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Updates an Insurance based on specified parameters.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Insurance GUID identifyer.

Request Body schema:

Insurance detailed information.

type
string or null

Insurance type code

insuranceCompany
string or null

Insurance company reference

status
integer <int32> (InsuranceStatus)
Enum: 0 1 2 3 4
reference
string or null

Insurance reference

endDate
string or null <date-time>

Insruace end date

clearEndDate
boolean or null

Clear insruace end date

insuranceCalcType
integer <int32> (InsuranceCalcType)
Enum: 1 4
feePercent
number or null <double>

Insurance fee amount

minPeriodicFee
number or null <double>

Minumal periodic fee

maxPeriodicFee
number or null <double>

Maximal periodic fee

clearMaxPeriodicFee
boolean or null

Clear maximal periodic fee

insuredAmount
number or null <double>

Insured amount

periodAmount
number or null <double>

Period amount

note
string or null

Note

Responses

Request samples

Content type
{
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "clearEndDate": true,
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "maxPeriodicFee": 0,
  • "clearMaxPeriodicFee": true,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Gets loan offers

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new loan offer to the origination

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

Request Body schema:

Loan offer information

Array
loanTypeCode
string or null

Code of the loan type to offer

maturity
integer <int32>

Maturity length in years

interestTypeCode
string or null

Interest type code

interestMarginCode
string or null

Interest margin code

interestDiscount
number or null <double>

Interest discount (in percent)

fixedInterestRate
number or null <double>

Interest rate for fixed interest (in percent)

baseRate
number or null <double>

Optional base rate used with the spread to calculate the proposed interest rate (in percent)

spread
number or null <double>

Optional spread for the proposed interest rate (in percent)

interestTerm
integer or null <int32>

Interest term

1 = Monthly

2 = Bi-monthly

3 = Quarterly

4 = Tertiary

5 = Semiannual

6 = Annual

7 = Bullet

8 = IMM

initialInterestTerm
integer or null <int32>

Initial interest term in months

firstPaymentDate
string or null <date-time>

Date for the first payment occasion

maturityDate
string or null <date-time>

Maturity date of the loan

instalmentTerm
integer or null <int32>

Instalment term

1 = Monthly

2 = Bi-monthly

3 = Quarterly

4 = Tertiary

5 = Semiannual

6 = Annual

7 = Bullet

8 = IMM

firstInstalmentDate
string or null <date-time>

Date for the first instalment occasion

loanPaymentPlanType
integer or null <int32>

Loan payment plan type

1 = Linear

2 = Annuity

3 = Bullet

status
integer <int32>

Loan offer status

10 = Preparing

20 = Offered

70 = Rejected

80 = Accepted

90 = Expired

validUntil
string or null <date-time>

End date if the offer is limited in time

description
string or null

Optional description and addition terms for the offer

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Get specific loan offer

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

offerGuid
required
string

Loan offer guid

Responses

Response samples

Content type
{
  • "loanOfferGuid": "string",
  • "loanTypeCode": "string",
  • "maturity": 0,
  • "interestTypeCode": "string",
  • "interestMarginCode": "string",
  • "interestDiscount": 0,
  • "fixedInterestRate": 0,
  • "currentInterestRate": 0,
  • "interestTerm": 0,
  • "firstPaymentDate": "2019-08-24T14:15:22Z",
  • "instalmentTerm": 0,
  • "firstInstalmentDate": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "loanPaymentPlanType": 0,
  • "status": 0,
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "lastDisbursementDate": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "links": [
    ]
}

Updates a loan offer

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

offerGuid
required
string

Loan offer guid

Request Body schema:

Loan offer information

firstPaymentDate
string or null <date-time>

Date for the first payment occasion

firstInstalmentDate
string or null <date-time>

Date for the first instalment occasion

status
integer <int32>

Loan offer status

10 = Preparing

20 = Offered

70 = Rejected

80 = Accepted

90 = Expired

validUntil
string or null <date-time>

End date if the offer is limited in time

description
string or null

Optional description and addition terms for the offer

Responses

Request samples

Content type
{
  • "firstPaymentDate": "2019-08-24T14:15:22Z",
  • "firstInstalmentDate": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a loan offer

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

offerGuid
required
string

Loan offer guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get specific loan offer payment plan

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

offerGuid
required
string

Loan offer guid

Responses

Response samples

Content type
{
  • "planGuid": "string",
  • "active": "Inactive",
  • "loanType": "string",
  • "paymentPlanType": "Flat",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "interestTerm": 0,
  • "instalmentTerm": 0,
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "interestTypeCode": "string",
  • "interestMarginCode": "string",
  • "interestDiscount": 0,
  • "fixedInterestRate": 0,
  • "currentInterestRate": 0,
  • "totalPayments": 0,
  • "remainingPayments": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "apr": 0,
  • "payments": [
    ]
}

Get specific loan offer interest terms

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

offerGuid
required
string

Loan offer guid

Responses

Response samples

Content type
[
  • {
    }
]

Gets scheduled disbursements

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new scheduled disbursement to the origination

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

Request Body schema:

Scheduled disbursement information

Array
bankAccountGuid
string or null

Guid of bank account to disburse to

disbursementDate
string <date-time>

Day for disbursement

disbursementAmount
number <double>

Amount to disbursement

currencyCode
string or null

Currency code for disbursement

feeAmount
number or null <double>

Fee to add for disbursement

feeChargeType
integer or null <int32>

Type of fee charge

0 = Add to account

1 = Deduct from disbursed amount

message
string or null

Message text on disbursement

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Get specific scheduled disbursement

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

disbursementGuid
required
string

Scheduled disbursement guid

Responses

Response samples

Content type
{
  • "scheduledDisbursementGuid": "string",
  • "bankAccountGuid": "string",
  • "bankAccountNo": "string",
  • "disbursementDate": "2019-08-24T14:15:22Z",
  • "disbursementAmount": 0,
  • "currencyCode": "string",
  • "feeAmount": 0,
  • "feeChargeType": 0,
  • "message": "string",
  • "status": 0,
  • "links": [
    ]
}

Updates a scheduled disbursement

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

disbursementGuid
required
string

Scheduled disbursement guid

Request Body schema:

Scheduled disbursement information

bankAccountGuid
string or null

Guid of bank account to disburse to

disbursementDate
string <date-time>

Day for disbursement

disbursementAmount
number <double>

Amount to disbursement

currencyCode
string or null

Currency code for disbursement

feeAmount
number or null <double>

Fee to add for disbursement

feeChargeType
integer or null <int32>

Type of fee charge

0 = Add to account

1 = Deduct from disbursed amount

message
string or null

Message text on disbursement

Responses

Request samples

Content type
{
  • "bankAccountGuid": "string",
  • "disbursementDate": "2019-08-24T14:15:22Z",
  • "disbursementAmount": 0,
  • "currencyCode": "string",
  • "feeAmount": 0,
  • "feeChargeType": 0,
  • "message": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a scheduled disbursement

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Origination guid

disbursementGuid
required
string

Scheduled disbursement guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
originationGuid
required
string

Origination unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }