Beneficiary
Household details
ID
Unique system-generated GUID.
Mandatory
System
String
2
64
No
Client reference ID
Unique client-generated GUID.
Mandatory
Client generated
String
2
64
No
Household ID
The ID of the household.
Mandatory
User/system
String
2
64
No
Member count
The total number of individuals in a household.
Mandatory
User
Numeric
1
1000
A household can be created only when it has at least 1 individual assigned to the household.
Individual ID
The ID of the individual
Mandatory
User/system
String
2
64
Individual details
ID
Unique system-generated GUID.
Mandatory
System
String
2
64
No
Client reference ID
Unique client-generated GUID.
Mandatory
Client generated
String
2
64
No
Name of the individual
Name of the individual being registered as the given name, family name, and other names.
Mandatory
User
String
2
200
No
Head of the household
Capture if the registered individual is also the head of the household.
Mandatory
User
Boolean
No
Type of ID
Capture the type of ID.
Mandatory
User
Array
The list of IDs to be given by the programme/state during impel. If no forms of ID are allowed, then a system generated ID is to be selected for the ID type.
Identity number
Capture the ID number belonging to the beneficiary.
Mandatory
User
String
2
64
If the individual has no forms of ID, then a unique system generated ID must be assigned.
Validations for specific ID types to be built during impel depending on the list of acceptable IDs.
Date of birth
Date of birth in DD/MM/YYYY format.
Optional
User
String
The DoB cannot be in the future. Error Message: DoB cannot be in the future.
Age
The age of the individual.
Optional
User
Integer
If DoB is not known, allow the user to enter his/her age.
Contact number
The mobile number of the registered individual.
Optional
User
Integer
Any validations on mobile numbers to be built during impel as per country-specific requirements.
Gender
Gender of the registered individual.
Optional
User
String
A product allows three types of genders: male, female and other. Adding/deleting from this list to be done during impel in accordance with country-specific requirements.