term_credit_scores

get_options

POST

/api/v2/term_credit_scores/get_options

Code
Get available credit score options for a revision.

get_options › Request Body

Request to get available credit score options for a revision

request-get_options

revision_id

string · required

The ID of the revision to get credit score options for

get_options › Responses

200

Response containing available credit score options for a revision

response-get_options

revision_id

string · required

The ID of the revision

policy_id

string · required

The ID of the policy

object · required

Summary of the current policy term

object[] · required

List of historical policy terms

object · required

Policy type settings related to credit scores

object[] · required

Credit reports for named insureds

object[] · required

Available credit score options

object · required

Validation status for the revision

POST/api/v2/term_credit_scores/get_options

curl --request POST \
  --url /api/v2/term_credit_scores/get_options \
  --header 'Content-Type: application/json' \
  --data '
{
  "revision_id": "revision_id"
}
'

Example Request Body

{
  "revision_id": "revision_id"
}

json

Example Responses

{
  "revision_id": "revision_id",
  "policy_id": "policy_id",
  "current_term": {
    "id": "id",
    "sequential_number": 0,
    "effective_date": "2024-08-25",
    "expiration_date": "2024-08-25",
    "term_credit_score": "term_credit_score",
    "term_credit_score_manually_updated": true,
    "term_type": "term_type",
    "term_length": 0,
    "is_renewal": true
  },
  "historical_terms": [
    {
      "id": "id",
      "sequential_number": 0,
      "effective_date": "2024-08-25",
      "expiration_date": "2024-08-25",
      "term_credit_score": "term_credit_score",
      "term_credit_score_manually_updated": true,
      "term_type": "term_type",
      "term_length": 0,
      "is_renewal": true
    }
  ],
  "policy_type_settings": {
    "term_credit_score_combination_strategy": "term_credit_score_combination_strategy",
    "term_credit_score_fallback": 0,
    "terms_credit_score_valid": 0,
    "terms_credit_score_pull_interval": 0
  },
  "named_insured_reports": [
    {
      "contact": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "type": "type",
        "emails": [
          {}
        ],
        "phones": [
          {}
        ],
        "addresses": [
          {}
        ]
      },
      "reports": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "contact_id": "00000000-0000-0000-0000-000000000000",
          "report_number": "report_number",
          "score": "score",
          "vendor_id": "00000000-0000-0000-0000-000000000000",
          "report_date": "2024-08-25",
          "revision_ids": [
            "00000000-0000-0000-0000-000000000000"
          ],
          "policy_ids": [
            "00000000-0000-0000-0000-000000000000"
          ]
        }
      ]
    }
  ],
  "options": [
    {
      "option_type": "historical",
      "score": 0,
      "tier": "tier",
      "available": true,
      "unavailability_reason": "unavailability_reason",
      "source_term_id": "source_term_id"
    }
  ],
  "validation_status": {
    "revision_open": true,
    "on_effective_date": true,
    "has_permissions": true
  }
}

json

application/json

update_selection

POST

/api/v2/term_credit_scores/update_selection

Code
Update the credit score selection for a revision.

update_selection › Request Body

Request to update the credit score selection for a revision

request-update_selection

revision_id

string · required

The ID of the revision to update

selected_option

string · enum · required

The selected credit score option type

Enum values:

historical

calculated

update_selection › Responses

200

Response containing the results of updating a credit score selection

response-update_selection

policy_term_id

string · required

The ID of the policy term that was updated

revision_id

string · required

The ID of the revision

selected_option

string · enum · required

The selected credit score option type

Enum values:

historical

calculated

applied_score

string · required

The credit score that was applied to the term

applied_tier

string · required

The credit tier corresponding to the applied score

previous_score

string | null · required

The previous credit score value, if any

note_id

string · required

The ID of the note created for this change

tasks terms