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.
- Install
pipenv('pip3 install pipenv' might be enough, on Debian) - Run
pipenv install - Set an environment variable
DMF_CONFIGpointing to the absolute path ofconfig.py(your configuration file, which you should create based onconfig.py.tmpl). - Run
pipenv shell - Start the server:
python serve.py - The API is now available at
http://localhost:5001