Sign in
latestOpenAPI 3.0.02026-08-102633113.7 KB

ab5ecf64ab87

Freelancer Overdrafts

Create Freelancer Overdraft Application

Creates a freelancer overdraft application and assigns it to the person with the given person_id in the path parameter. Before calling this endpoint, you need to create a credit record for the customer and include it in the payload. 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}/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 freelancer 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.

credit_record_idstring

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

Example request

{
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

Response

Application

status'initial_scoring_pending' | 'account_snapshot_pending' | 'account_snapshot_verification_pending' | 'offered' | 'rejected' | 'expired' | 'deleted' | 'overdraft_created' required

The status of a freelancer overdraft application.

rejection_reasonsstring[] nullable

The reason(s) for rejecting an 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 freelancer by the partner.

partner_reference_numberstring nullable

The partner's reference number.

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_ratenumber

The interest rate applicable to the overdraft.

overdraft_idstring nullable

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

interest_conditions_enabledboolean
interest_accrual_ratenumber

The daily rate at which interest is accrued on the used amount of an overdraft.

idstring required

The unique ID of a freelancer overdraft application.

decision'REJECTED' | 'OFFERED' nullable

Solaris' decision on the overdraft application.

credit_record_idstring nullable

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

created_atstring datetime required

The date and time the freelancer overdraft application was created.

account_snapshot_idstring nullable

The unique ID of an account snapshot of a specific person account.

Example response

{
  "status": "offered",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_rate": 9,
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "b83z264de98741018419b53648e20ca9coap",
  "decision": "OFFERED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z"
}