Address

Target release	16.x.x
Epic
Document status	COMPLETED
Document owner	@Nikhil Pawar
Designer	@Nayan Ambali
Developers	@Nikhil Pawar
QA	@SSN
Technical design	Technical Description of Address API

Goals

Address module would serve as a KYC feature in Mifos by giving Mifos users the ability to store the address of clients.
This is an optional feature which can be turned on/off via Number_of_address_required_for_a_client parameter inc_configurations table.
The address fields are generic and made configurable i.e the organisation can choose which field to be included as address using the m_field_configuration table.

Background and strategic fit

While developing Credit Bureau module, we felt the need of having a structured way of accessing and storing the address of clients. This need was felt because credit bureaus required the address of clients in order to answer credit check inquiry.

By developing Address API, the address would be stored and retrieved in more structured and hassle free manner. It would also accommodate latitude and longitude which facilitate geolocation for the android app as well.

Assumptions

Following user stories have been written by assuming that the address configuration is enabled by storing the non-zero value in c_configuration table.

Requirements

	Title	User Story	Importance	Notes

	Title	User Story	Importance	Notes
1	Insert address for existing client	The user can update the client records by different type of addresses like permanent, current address using client_id as identifier	Must Have	The flexibility to add different types of addresses for single client would depend on the value been supplied to Number_of_address_required_for_a_client parameter inc_configurations table
2	Update address of existing clients	The API would also give the ability to modify address fields,type of address.	MUST Have
3	Retrieve address	The API would also give the ability to retrieve different type of address which are linked to client	MUST HAVE
4	Make the address fields as mandatory while making new clients	When a new client is being made, along with other fields,address fields should also be supplied, else the client would not be activated	MUST HAVE
5	Provision for storing time series of addresses	All the addresses of the clients should be displayed from the beginning of time	Optional

User interaction and design

Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question	Outcome

Question	Outcome
Can this be made extensible for other entities like office,group, center etc	possibilities being discussed.

Not Doing

Versioning of addresses