← Back to Adapters

Score Stakeholder (Behaviour)

Behaviour scoring per stakeholder — returns risk profile (PD, LGD) for a single person by external party ID

Score Stakeholder (Behaviour)

Behaviour scoring adapter for individual stakeholders. Returns a risk profile for a single person identified by their external party ID. Called once per eligible stakeholder in the household during credit evaluation.

Endpoint:

  • GET /scoring/{externalPartyId} — Score a single stakeholder

Score Stakeholder

GET /scoring/{externalPartyId} — Retrieve the behaviour risk profile for one stakeholder.

Path parameter:

  • externalPartyId (required): Stable external identifier for the party

Response — StakeholderScoringResponse:

  • riskProfile (required): Array of RiskAssessment entries, typically:
    • PD — Probability of Default (percentage, e.g., 0.01)
    • LGD — Loss Given Default (percentage, e.g., 0.10)
    • Other possible types: EAD, BEHAVIOR, OTHER

Each RiskAssessment entry contains:

  • type (required): Risk metric type (PD, LGD, EAD, BEHAVIOR, OTHER)
  • reference (required): Subject the assessment relates to — { kind, id }. Stakeholder scoring is PARTY-scoped.
  • basicEntityInformation (required): Record identity — entityType: RISK_PROFILE, id, optional externalId/externalSource, and customFields (provider-specific fields; the process handler may enrich these with partyId after receiving the response)
  • score: Numeric value with unit (PERCENTAGE, AMOUNT, SCORE, BASIS_POINTS)
  • classification: Provider-specific risk label (e.g., A, B, HIGH_RISK)
  • assessedAt (required): When the assessment was produced (ISO 8601 date-time)
  • source: Provenance — system, model name, and model version

Multi-Instance Collection

The handler calls this endpoint once per eligible stakeholder in the household.