https://github.com/piggypot/onfido
Elixir wrapper for the Onfido API
https://github.com/piggypot/onfido
addresspicker elixir kyc
Last synced: 4 months ago
JSON representation
Elixir wrapper for the Onfido API
- Host: GitHub
- URL: https://github.com/piggypot/onfido
- Owner: PiggyPot
- Created: 2019-01-30T15:42:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-31T14:46:12.000Z (over 7 years ago)
- Last Synced: 2024-10-30T00:34:10.634Z (over 1 year ago)
- Topics: addresspicker, elixir, kyc
- Language: Elixir
- Size: 11.7 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Onfido
Elixir wrapper for the [Onfido](https://onfido.com) API
## Installation
```elixir
def deps do
[
{:onfido, "~> 0.2.0"}
]
end
```
2. Add configuration to your app:
```elixir
config :onfido,
api_base: "https://api.onfido.com/v2",
api_token: ""
```
## Documentation
#### Core Resources
[Applicants](https://hexdocs.pm/onfido/Onfido.Resources.Applicant.html)\
[Documents](https://hexdocs.pm/onfido/Onfido.Resources.Documents.html)\
[Checks](https://hexdocs.pm/onfido/Onfido.Resources.Check.html)\
[Reports](https://hexdocs.pm/onfido/Onfido.Resources.Report.html)\
[Webhooks](https://hexdocs.pm/onfido/Onfido.Resources.Webhook.html)
#### Other Resources
[Address Picker](https://hexdocs.pm/onfido/Onfido.Resources.AddressPicker.html)\
[SDK Token Generation](https://hexdocs.pm/onfido/Onfido.Resources.SdkToken.html)\
[Street Level Code](https://hexdocs.pm/onfido/Onfido.Resources.StreetLevelCode.html)
You can read the docs [at hex.pm](https://hexdocs.pm/onfido)
## Development Setup
If you are making changes to this codebase and want to test your code, you will need to copy the sample secret file.
```elixir
cp config/secret.sample.exs config/secret.exs
```
Then add your relevant Onfido access details here.