Debt Lines

Get a debt line's onboarding and draw-eligibility status

Changed on
get/debt-lines/{id}/status

Request

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

Response

Successful operation

completed_countinteger required

steps completed

total_countinteger required

steps in the checklist

can_submitboolean required

whether the checklist is complete, so the terms can be approved: they are pre_approved and every onboarding check is completed. Sivo then approves them, without a review, and the customer reviews and accepts them

can_drawboolean required

whether principal can be drawn: the terms are active and every blocking step (collateral, payout) is completed; financials, receivables and payin never stop a draw. A draw is still capped by the available_to_draw of the debt line position

summarystring required

what the next action waits on, in words ready for the customer. For pre_approved terms, every step still stopping the terms from being approved, and for active terms every step still stopping a draw (never the non-blocking setup steps): first the ones the customer still has to complete, then the submitted ones Sivo is checking, which need nothing more from the customer. For any other terms status it only says where the application stands and names no steps. Relay all of it; never single out one step as the only blocker or the only one left when it names several

Example response

{
  "checks": {
    "kyx": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "collateral": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "payout": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "payin": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "financials": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "receivables": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    },
    "yc": {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    }
  },
  "steps": [
    {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    }
  ],
  "completed_count": 42,
  "total_count": 42,
  "blockers": [
    {
      "detail": {
        "settled": 10000,
        "required": 10000
      }
    }
  ]
}

Changes