Sign in
latestOpenAPI 3.0.02026-08-102034118.0 KB

8f580eff2157

Consumer Loan

Retrieve consumer loan application

Returns the current status and details of an existing consumer loan application. Additionally, you can subscribe to the webhook event CONSUMER_LOAN_APPLICATION to receive status updates on the application.

get/v1/persons/{person_id}/consumer_loan_applications/{application_id}

Path parameters

person_idstring required

The person_id of the customer applying for the loan.

application_idstring required

The unique ID of the customer's loan application.

Response

Application

status_descriptionstring nullable

Additional details about the consumer loan application status.

status'offered' | 'account_snapshot_verification' | 'approved' | 'esign_pending' | 'screening_pending' | 'esign_failed' | 'loan_creation_pending' | 'loan_created' | 'rejected' | 'deleted' | 'expired' required

The status of a consumer loan application.

skip_account_snapshotboolean
signing_idstring nullable

The ID of the signing resource, created after the customer's identification and e-signing process has been triggered.

sellerstring nullable

The name of the seller of the financed good.

payout_descriptionstring nullable

Additional details around the loan payout.

loan_idstring nullable

The unique ID of a loan.

idstring required

The unique ID of a customer's consumer loan application.

financed_goodstring nullable

The financed good that was purchased using the loan.

delayed_payout_strategy'none' | 'after_revocation'

Field to indicate the payout strategy to be applied to the loan. If set to none, then the loan payout will happen automatically.

Example response

{
  "status": "esign_pending",
  "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
  "id": "108787ede6b743dcbe0c3398bc4a6ce8clap",
  "cash_price": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "approximate_total_loan_expenses": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  }
}