The credit score endpoint

The Credit Score endpoint returns the latest credit score and score factors for an Entity.

Enterprise customers can customize their credit score bureau and model selections. Contact your Method CSM for more information.

The Credit Score endpoint is available as a:

Type	Use-Case
Product	On-Demand view of an Entity’s credit score.
Subscription	Continuous near real-time updates on an Entity’s credit score. Webhook Payload

CreditScore Objects

Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "credit_score.create" | "credit_score.update",
  "path": "/entities/<entity_id>/credit_scores/<crs_id>",
  "event": "<evt_id>"
}

THE CREDIT SCORE OBJECT

{
  "id": "crs_pn4ca33GXFaCE",
  "entity_id": "ent_au22b1fbFJbp8",
  "status": "completed",
  "scores": [
    {
      "score": 734,
      "source": "equifax",
      "model": "vantage_3",
      "factors": [
        {
          "code": "00034",
          "description": "Total of all balances on bankcard or revolving accounts is too high"
        },
        {
          "code": "00012",
          "description": "The date that you opened your oldest account is too recent"
        },
        {
          "code": "00063",
          "description": "Lack of sufficient relevant real estate account information"
        },
        {
          "code": "00016",
          "description": "The total of all balances on your open accounts is too high"
        }
      ],
      "created_at": "2024-04-12T00:12:32.768Z"
    }
  ],
  "error": null,
  "created_at": "2024-04-12T00:12:30.228Z",
  "updated_at": "2024-04-12T00:12:41.303Z"
}