Changelog

The official public API Elixir SDK is available on Hex as the raims package.

If Hex is not installed yet, install it once:

mix local.hex

From your application project, check the current stable version's configuration:

mix hex.info raims

Copy the Config: line into the dependency list in deps/0 in mix.exs. Then fetch the dependencies and compile:

mix deps.get
mix compile

The SDK requires Elixir 1.18 or later with Erlang/OTP 27 or later and provides resource modules, response models, cursor pagination, and webhook verification. The Raims modules stay the same if you installed the SDK from GitHub.

To migrate a Git or local dependency, replace the previous declaration with the current Hex configuration and run mix deps.update raims. Review and keep mix.lock and test your integration before updating the application.

Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions. Read the Elixir SDK guide to install, configure the client, and receive webhooks.