Skip to main content
POST
/
simulate
/
entities
/
{entity_id}
/
connect
curl https://dev.methodfi.com/v2024-04-04/simulate/entities/{entity_id}/connect \\
  -X POST \\
  -H "Method-Version: 2024-04-04" \\
  -H "Authorization: Bearer sk_test_xxx" \\
  -H "Content-Type: application/json" \\
  -d '{
    "behaviors": ["new_credit_card_account"]
    }'

{
  "success": true,
  "data": null,
  "message": null
}
Use this simulation to queue connect behaviors that run the next time you execute the Connect product for an entity.
Simulation endpoints are only available in the development environment. Teams with live treasury access cannot use them.
A maximum of 5 connect behaviours can be configured for a given entity.

​
Path Parameters

​
entity_id
string
required
ID of the entity whose connect you want to simulate.

​
Body

​
behaviors
enum[]
required
List of behaviors to queue. Each behavior is consumed the next time the Connect product runs for this entity.
new_credit_card_account
Simulates a new credit card account being opened.new_auto_loan_account
Simulates a new auto loan account being opened.new_mortgage_account
Simulates a new mortgage account being opened.new_student_loan_account
Simulates a new student loan account being opened.new_personal_loan_account
Simulates a new personal loan account being opened.
curl https://dev.methodfi.com/v2024-04-04/simulate/entities/{entity_id}/connect \\
  -X POST \\
  -H "Method-Version: 2024-04-04" \\
  -H "Authorization: Bearer sk_test_xxx" \\
  -H "Content-Type: application/json" \\
  -d '{
    "behaviors": ["new_credit_card_account"]
    }'

{
  "success": true,
  "data": null,
  "message": null
}