Increase.Simulations.Entities (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Entity.

These endpoints only work against the sandbox environment and let you fast-forward events that would otherwise take hours or days in production (settlement, acknowledgement, returns, and so on). See https://increase.com/documentation/api/overview#sandbox for details.

Summary

Functions

update_validation(client, entity_id, params \\ %{}, opts \\ [])

Simulate updates to an [Entity's validation]. In production, Know Your Customer validations [run automatically] for eligible programs. While developing, use this API to simulate issues with information submissions.

Functions

update_validation(client, entity_id, params \\ %{}, opts \\ [])

@spec update_validation(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) :: {:ok, Increase.Entities.Entity.t()} | {:error, Increase.Error.t()}

Simulate updates to an [Entity's validation]. In production, Know Your Customer validations [run automatically] for eligible programs. While developing, use this API to simulate issues with information submissions.

POST /simulations/entities/{entity_id}/update_validation