latestOpenAPI 3.0.02026-08-101924100.1 KB

7fb31ddc103c

Business fronting

Create business fronting loan or fronting factoring application

Creates a fronting loan or fronting factoring application and assigns it to the business with the business_id specified in the request URL. The payload of this endpoint includes all the required financial information and account data about the business, which the credit scorer uses to initiate a series of credit checks to determine the business's credit risk and eligibility.

post/v1/businesses/{business_id}/fronting_loan_applications

Path parameters

business_idstring required

The ID of the business applying for a fronting loan or fronting factoring.

Request body

agionumber float

The credit commission amount.

creditreform_pdstring

The business's probability of default as scored by any credit risk service provider, e.g., Creditreform.

creditreform_scoreinteger

The business's credit score as scored by any credit risk service provider, e.g., Creditreform.

durationinteger

The number of months over which the loan will be repaid.

effective_interest_ratenumber float

The effective annual interest rate applied to the loan.

minimum_credit_risk_criteriaobject nullable

Minimum credit risk criteria fields for scorer

nominal_interest_ratenumber float

The nominal interest rate applied to the loan.

partner_contact_namestring

Your internal contact name for the business.

partner_contact_numberstring

Your internal contact number for the business.

partner_reference_numberstring

our internal reference number for the business. Acts as an idempotency key.

partner_scorestring

The score assigned to the business by your internal scoring flow.

purposestring

The purpose of the loan.

purpose_descriptionstring

Additional information about the purpose of the loan.

recipient_ibanstring

The IBAN of the loan's recipient, to which the loan will be paid out.

recipient_namestring

The name of the loan recipient.

transaction_descriptionstring

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

transaction_end_to_end_idstring

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example request

{
  "creditreform_pd": "0.10",
  "creditreform_score": 2,
  "duration": 24,
  "effective_interest_rate": 0.309,
  "factoring_fee": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "nominal_interest_rate": 0.299,
  "partner_contact_name": "Daniel Schmidt",
  "partner_contact_number": "+49345195891",
  "partner_reference_number": "tf2df3ceac0e384352b78cb6987d1d987",
  "partner_score": "AA",
  "purpose": "Buying office equipment, factoring of receivables, etc.",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "requested_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Response

Application

agionumber float nullable

The credit commission amount.

creditreform_pdstring nullable required

The business's probability of default as scored by any credit risk service provider, e.g., Creditreform.

creditreform_scoreinteger nullable required

The business's credit score as scored by any credit risk service provider, e.g., Creditreform.

durationinteger nullable

The number of months over which the loan will be repaid.

effective_interest_ratenumber float nullable

The effective annual interest rate applied to the loan.

idstring required

The unique ID of the business fronting loan application.

identification_idstring nullable

The unique ID of the identification resource created for the business.

minimum_credit_risk_criteriaobject nullable

Minimum credit risk criteria fields for scorer

nominal_interest_ratenumber float nullable

The nominal interest rate applied to the loan.

partner_contact_namestring nullable

Your internal contact name for the business.

partner_contact_numberstring nullable

Your internal contact number for the business.

partner_reference_numberstring required

Your internal reference number for the business. Acts as an idempotency key.

partner_scorestring required

The score assigned to the business by your internal scoring flow.

purposestring required

The purpose of the loan.

purpose_descriptionstring nullable

Additional information about the purpose of the loan. In case of factoring, include the invoice number and reference in this field.

recipient_ibanstring required

The IBAN of the loan's recipient, to which the loan will be paid out.

recipient_namestring required

The name of the loan recipient.

The status of the business fronting loan application.

transaction_descriptionstring nullable

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

transaction_end_to_end_idstring nullable

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example response

{
  "creditreform_pd": "0.10",
  "creditreform_score": 2,
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "identification_id": "1063504cf74919f60ae4c806bdc9ce75bid",
  "nominal_interest_rate": 0.299,
  "partner_contact_name": "Daniel Schmidt",
  "partner_contact_number": "+49345195891",
  "partner_reference_number": "tf2df3ceac0e384352b78cb6987d1d987",
  "partner_score": "AA",
  "purpose": "Buying office equipment, factoring of receivables, etc.",
  "purpose_description": "Buying office equipment for new headquarters.",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Daniel Schmidt",
  "requested_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "status": "approved",
  "transaction_description": "Example transaction",
  "transaction_end_to_end_id": "DDHHDHG333243"
}