# verify-address

> Simple address verification

Latest version **1.0.1** (published 2015-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install verify-address
pnpm add verify-address
yarn add verify-address
bun add verify-address
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-08-08 |
| First published | 2015-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Basil Siddiqui |
| Maintainers | bsiddiqui |
| Keywords | address, address, lob, verification, verify |

## Links

- npm: https://www.npmjs.com/package/verify-address
- Repository: https://github.com/bsiddiqui/verify-address
- Issues: https://github.com/bsiddiqui/verify-address/issues
- npm.io page: https://npm.io/package/verify-address

## Dependencies (2)

- [got](https://npm.io/package/got.md) ^4.1.1
- [Base64](https://npm.io/package/Base64.md) ~0.3.0

## Recent versions

- 1.0.1 (latest) — 2015-08-08
- 1.0.0 — 2015-08-07
- 0.1.0 — 2015-08-07

## README

# verify-address
[![Build Status](https://travis-ci.org/bsiddiqui/verify-address.svg?branch=master)](https://travis-ci.org/bsiddiqui/verify-address) [![Code Climate](https://codeclimate.com/github/bsiddiqui/verify-address/badges/gpa.svg)](https://codeclimate.com/github/bsiddiqui/verify-address) [![Test Coverage](https://codeclimate.com/github/bsiddiqui/verify-address/badges/coverage.svg)](https://codeclimate.com/github/bsiddiqui/verify-address) [![Version](https://badge.fury.io/js/verify-address.svg)](http://badge.fury.io/js/verify-address) [![Downloads](http://img.shields.io/npm/dm/verify-address.svg)](https://www.npmjs.com/package/verify-address)

Super lightweight address verification courtesy of [Lob](https://lob.com).

## Install
```
$ npm install --save verify-address
```

## Usage
```js
var verify = require('address-verify')

verify({
  address_line1: '255 King St',
  address_line2: '414',
  address_city: 'San Francisco',
  address_state: 'CA',
  address_zip: '94107',
  address_country: 'US'
}, console.log)
// => { valid: true, address: {...}}
```

## API

#### `verify(address, callback)` -> `undefined`

##### address
*Required*
Type: `object`

The address to verify
* address_line1: optional
* address_line2: optional
* address_city: optional
* address_state: optional
* address_zip: optional
* address_country: optional (2 letter country short-name code (ISO 3316))

##### callback
*Required*
Type: `function`
Arguments: `err, response`

The `response` contains:

###### valid

Type: `boolean`

Whether the address is valid or not

###### address

Type: `object`

###### message

Type: `string`

Details if only a partial match is found and more information is needed

---
_Source: https://npm.io/package/verify-address · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._