![codecov](https://camo.githubusercontent.com/18ca52b2bb615d218f09f3ad23e0000b236d6a7a0bbadc55bb13cf4026b5e2e1/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f46696e626974732f706c756767795f656c697869723f7374796c653d666c61742d737175617265)
Welcome to Pluggy Elixir, an API client written in Elixir to access the Open Finance services provided by Pluggy
Add pluggy_elixir
to your list of dependencies in mix.exs
:
def deps do
[
{:pluggy_elixir, "~> 0.0.1"}
]
end
Update deps
Add the credentials to your config file (ex: config.exs
)
config :pluggy_elixir,
client_id: "your-app-client-id",
client_secret: "your-app-client-secret",
See more about configurations in PluggyElixir.Config
docs.
Data |
Use Cases |
{
full_name,
tax_id,
date_of_bird,
address,
phone_numbers
}
|
Onboarding
Registration
KYC
Customer segmentation
|
Data |
Use Cases |
{
balances,
transactions: [
{
date,
values,
description,
type,
category
}
]
}
|
Income analysis
Consumption profile
Financial management
Risk modeling
Financial monitoring
Investment capacity
|
Data |
Use Cases |
{
limits,
minimum_payment,
brand,
segment,
maturity,
transactions
}
|
Consumption profile
Financial management
Credit taking capacity
Financial monitoring
Expenses by category
Consumption cycles
Recurring expenses
|
Data |
Use Cases |
{
assets,
code,
type,
quantity,
value,
historical_profitability,
taxes,
index,
balance_at_the_broker,
handling_at_the_broker
}
|
Portfolio Consolidation
Financial Profile
Transaction monitoring
Investment capacity analysis
Portfolio risk analysis
Investment automation
|
Banks |
Investment brokers |
Itaú (Personal e Corporate)
Bradesco (Personal e Corporate)
Nubank (Personal)
Santander (Personal e Corporate)
Banco do Brasil (Personal e Corporate)
Caixa (Personal e Corporate)
Inter (Personal e Corporate)
Modal Mais (Personal)
BTG Pactual (Personal)
Mercado Pago (Personal)
|
XP Investimentos
Rico
Easynvest
Órama
Genial
Agora
|
For most up-to-date and accurate documentation, please see the API Spec page.
Contributing Guide
Apache License, Version 2.0 © Finbits