TM Forum · Schema

CreditProfile

CreditProfile schema from TM Forum API

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tmf637-product-inventory-credit-profile-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf637-product-inventory-credit-profile-schema.json",
  "title": "CreditProfile",
  "description": "CreditProfile schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity"
    },
    {
      "type": "object",
      "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile  is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.",
      "properties": {
        "creditProfileDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date the profile was established"
        },
        "creditRiskRating": {
          "type": "integer",
          "description": "This is an integer whose value is used to rate the risk"
        },
        "creditScore": {
          "type": "integer",
          "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history"
        },
        "validFor": {
          "$ref": "#/components/schemas/TimePeriod"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "CreditProfile": "#/components/schemas/CreditProfile"
    }
  }
}