POST
/
simulate
/
entities
/
{entity_id}
/
credit_scores
/
{crs_id}
curl https://dev.methodfi.com/simulate/entities/{entity_id}/credit_scores/{crs_id} \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "scores": [
      {
        "score": 800,
        "source": "equifax",
        "model": "vantage_4",
        "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"
          }
        ],
        "created_at": "2024-04-12T00:12:32.768Z"
      }
    ]
  }'

{
  "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"
}

Credit Score simulations allow you to update pending Credit Scores with custom responses for entities in the development environment.

If no action is taken within 20 seconds of creating a credit score, it will automatically update with default data.

​
Path Parameters

​
entity_id
string
required

ID of the Entity.

​
crs_id
string
required

ID of the Credit Score to update.

​
Body

​
scores
object[]

An array of score objects.

​
Returns

Returns the updated Credit Score object.

curl https://dev.methodfi.com/simulate/entities/{entity_id}/credit_scores/{crs_id} \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "scores": [
      {
        "score": 800,
        "source": "equifax",
        "model": "vantage_4",
        "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"
          }
        ],
        "created_at": "2024-04-12T00:12:32.768Z"
      }
    ]
  }'

{
  "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"
}