{
  "service": "Creditcrest shadow mode",
  "version": "shadow-2",
  "what": "Run Creditcrest beside your own process before going live: your applications read, your policy and the Creditcrest Score run on them, and each set beside the decision you made.",
  "not_a_decision": "A shadow comparison sets Creditcrest’s reading of an application beside the lender’s own decision on it. Creditcrest does not approve or decline: its policy run reports which of the lender’s conditions were met, which were not, and which tests would send the file to a person. Where the two part, somebody should read the file; the difference is not a verdict on either. Creditcrest Technologies is not a credit provider, is not a credit assistance provider, and does not hold an Australian credit licence. Its software produces evidence; the licensee makes the decision.",
  "stores": "Nothing. Comparisons are sealed and returned; where your own records service is connected they are written there, and nowhere else.",
  "endpoints": {
    "POST /v1/shadow": {
      "what": "Up to 50 of your applications, each with your own outcome: the statement read, your policy and the score run on it, and a sealed comparison of where Creditcrest’s reading and your decision agree and part, with the rules, figures and transactions behind each difference. A report over the batch comes with them.",
      "body": {
        "applications": "[{ reference, on?: \"YYYY-MM-DD\", statement, answers?, checks?, history?, commitment?, lender: { outcome, amount?, termMonths?, frequency?, reasons?, figures? } }] — up to 50",
        "statement": "the CSV your applicant’s bank exported, as text or { \"csv\", \"holders\"? }; or bank data { \"accounts\", \"transactions\", \"holderName\"? }",
        "answers": "the application’s answers by the question keys of Creditcrest’s application form (loan.amount, income.amount…) or their canonical names (requested_amount…) — optional; restricted answers are dropped unread",
        "checks": "what your own checks found: identityVerified, contactVerified, age or dateOfBirth, residencyCriteriaMet, requirementsAndObjectivesMet, accountNameMatches, allIncomeAccountsIncluded",
        "history": "\"none\" for a first loan with you, or { contracts, paidLate, dishonours, worstDaysPastDue, complete }",
        "lender.outcome": "approved, declined, referred or withdrawn — yours; Creditcrest does not approve or decline",
        "lender.figures": "{ per: week | fortnight | month | year, income?, living?, housing?, credit?, commitments? } — compared as monthly figures, and only with their period",
        "policy": "your policy’s text, optional: otherwise the one in your configuration, or Creditcrest’s starting policy",
        "products": "your products, optional, in the shape of a lender’s configuration: the small and medium loan checks need them",
        "on": "the day an application is assessed as, when it gives none; today in Sydney if left out",
        "setting": "strict, balanced or broad, optional: how far each statement is read past the rules. Otherwise your configuration’s (journey.statementSetting), balanced unless set — so a run can show what another setting would have read before you change yours"
      }
    },
    "POST /v1/shadow/report": {
      "what": "A report over comparisons you kept, for any period: agreement on outcome, the rules behind each difference, how far apart the figures were, the score beside your outcomes and what could not be read — each comparison’s seal checked first, and the report sealed.",
      "body": {
        "comparisons": "the comparisons as POST /v1/shadow returned them — up to 40000",
        "from": "YYYY-MM-DD, optional",
        "to": "YYYY-MM-DD, optional"
      }
    }
  },
  "tenant_setting": "A lender whose operation runs on Creditcrest can be put in shadow: compliance.shadow is true (or { since }). Then nothing reaches an applicant and no money moves — no email or text, no contract, no debit, no identity or bank check, no real applications taken on the hosted pages or through its API — and only its own records are kept.",
  "page": "/decisioning/shadow"
}