Identity
Information that describes a real person. Identity information is a type of PII and is encrypted on weza.io servers.
Field | Data Type | Description |
surname | string | Required User’s surname Read-only after creation |
othernames | string | Required User’s first and middle names (if available) in that order. Read-only after creation |
dateOfBirth | string ( Timestamp format ) | Required
User’s date of birth in the format Example: 1970-01-01 Read-only after creation |
governmentIdNo | string | Required A person's national identification number or social security number. Read-only after creation |
sex | string ( ‘male’, ‘female’ ) | Required User’s sex Read-only after creation |
countryOfResidence | string | Required User’s country of residence. It must be a supported country. Only the following countries are currently supported on weza.io.
Read-only after creation |
phoneNumber | string ( E.164 format ) | Required User’s mobile phone number in the E.164 format. Example: +2547000000 Read-write |
emailAddress | string ( email format ) | Required User’s email address. If your lending app is a mobile application, then it should be the email address tied to the user’s mobile device. Read-write |
Last updated