Skip to content

Latest commit

 

History

History

dmf

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
api_client
api_client
 
 
Dockerfile
Dockerfile
 
 
Pipfile
Pipfile
 
 
Pipfile.lock
Pipfile.lock
 
 
README.md
README.md
 
 
__init__.py
__init__.py
 
 
api.mdown
api.mdown
 
 
config.py.tmpl
config.py.tmpl
 
 
serve.py
serve.py
 
 

README.md

Social Security data API wrapper for Python

This API provides a standardized interface for accessing social security data.

The API currently provides one endpoint, /dmf, which checks a Social Security Death Master File for a record associated with a particular Social Security number.

The goal of the API is to provide SSN validation functions without leaking unnecessary data to client applications.

The API comes with a backend for Veris, which can be swapped out for other backends as necessary.

Installation

  1. Install pipenv ('pip3 install pipenv' might be enough, on Debian)
  2. Run pipenv install
  3. Set an environment variable DMF_CONFIG pointing to the absolute path of config.py (your configuration file, which you should create based on config.py.tmpl).
  4. Run pipenv shell
  5. Start the server: python serve.py
  6. The API is now available at http://localhost:5001