Sign in
latestOpenAPI 3.0.02026-08-102633113.7 KB

ab5ecf64ab87

Consumer Overdrafts

Create Consumer Overdraft Application

Creates a consumer overdraft application and assigns it to the person with the given person_id in the path parameter. Before calling this endpoint, you must collect the required information from the customer, such as the employment status and income declaration and the consent to the account snapshot and credit check. Additionally, you need to create a credit record for the customer. Afterwards, Solaris' credit scoring system assesses the application to determine the person credit eligibility and either approves or rejects the application.

post/v1/persons/{person_id}/consumer_overdraft_applications

Path parameters

person_idstring required

The unique person ID, generated after completing the person onboarding process.

Request body

partner_risk_classstring

The risk class assigned to a customer by the partner.

partner_reference_numberstring

The partner's reference number.

partner_contact_numberstring

The number of the partner's contact person.

partner_contact_namestring

The name of the partner's contact person.

minimum_credit_risk_criteriaobject nullable

Minimum credit risk criteria fields for scorer

identification_idstring required

The unique identification ID of a person, generated after completing the person identification process.

employment_status'EMPLOYED' | 'UNEMPLOYED' | 'PUBLIC_SECTOR_EMPLOYEE' | 'PROFESSIONAL_SOLDIER' | 'FREELANCER' | 'HOUSEWORK' | 'APPRENTICE' | 'MANAGEMENT' | 'RETIRED' | 'STUDENT' | 'SELF_EMPLOYED' | 'MILITARY_OR_COMMUNITY_SERVICE' required

The consumer's employment status, mentioned in the signed self-declaration form.

credit_record_idstring

The unique ID of a credit record, generated after creating a consumer credit record.

account_ibanstring required

The IBAN of a person account.

Example request

{
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "account_iban": "DE87110101001000057123"
}

Response

Application

status_descriptionstring nullable

The description of the consumer overdraft application status.

status'scoring_pending' | 'offered' | 'overdraft_created' | 'rejected' | 'deleted' required

The status of a consumer overdraft application.

person_idstring required

The unique person ID, generated after completing the person onboarding process.

partner_risk_classstring nullable

The risk class assigned to a customer by the partner.

partner_reference_numberstring nullable

The partner's reference number.

partner_idstring required

The unique partner ID, generated after creating a partner.

partner_contact_numberstring nullable

The number of the partner's contact person.

partner_contact_namestring nullable

The name of the partner's contact person.

overdraft_idstring nullable

The unique ID of a consumer overdraft, generated after an overdraft is offered.

minimum_credit_risk_criteriaobject nullable

Minimum credit risk criteria fields for scorer

interest_accrual_ratenumber float nullable

Scorer rate for risk based pricing

identification_idstring required

The unique identification ID of a person, generated after completing the person identification process.

idstring required

The unique ID of a consumer overdraft application.

employment_status'EMPLOYED' | 'UNEMPLOYED' | 'PUBLIC_SECTOR_EMPLOYEE' | 'PROFESSIONAL_SOLDIER' | 'FREELANCER' | 'HOUSEWORK' | 'APPRENTICE' | 'MANAGEMENT' | 'RETIRED' | 'STUDENT' | 'SELF_EMPLOYED' | 'MILITARY_OR_COMMUNITY_SERVICE' nullable

The consumer's employment status, mentioned in the signed self-declaration form.

credit_record_idstring nullable

The unique ID of a credit record, generated after creating a consumer credit record.

created_atstring datetime required

The date and time the consumer overdraft application was created.

account_ibanstring required

The IBAN of a person account.

Example response

{
  "status_description": "The overdraft is approved and offered to the customer.",
  "status": "offered",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "id": "b83z264de98741018419b53648e20ca9coap",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_iban": "DE87110101001000057123"
}