# numverify

[![Build Status](https://travis-ci.org/sotojuan/numverify.svg?branch=master)](https://travis-ci.org/sotojuan/numverify)

> Numverify API client

## Install

In your `mix.exs`:

```elixir
def application do
  [applications: [:numverify]]
end

defp deps do
  [
    {:numverify, "~> 1.0.0"}
  ]
end
```

Then run `mix deps.get`.

## Usage

For information about the endpoints themselves please refer to the [Numverify docs](https://numverify.com/documentation).

To use this package you must have a Numverify access key either as a `NUMVERIFY_KEY` environment variable or in the `Application` configuration. For example:

```elixir
Application.put_env(:numverify, :key, "my key")
```

## API

`Numverify.validate(opts)`

Validate the given `opts`, a map of inputs to the API. A `number` field must be present.

`Numverify.countries`

Returns a map of countries and their telephone codes.

`Numverify.is_valid?(number)`

Convenience function to quickly test the validity of a number.

Returns `true` if the number is valid, `false` if not, and `nil` if there was
an error.

## License

MIT © [Juan Soto](https://juansoto.me)