...
Name | Type | Description |
|---|---|---|
day | int | The day component of a date of birth. |
month | int | The month component of a date of birth. |
year | int | The full year component of a date of birth, for example 1975, i.e. not 75. |
RegistrationDetailsV2
| Name | Type | Description | Restrictions |
|---|---|---|---|
| currentResidentialAddress | Address | The person's current residential address. | |
| dateCreated | DateTime | The timestamp of when this verification attempt was created. | |
| dob | string | The person's date of birth. | |
| string | The person's email address. | May be null. Must Must be a valid email address following the Standard Hibernate validation and checking Top Level Domain (TLD) is valid. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt | |
| extraData | List<NameValuePair> | Any extra data elements that were supplied with the original registration. Identifier such as document numbers will not be present in the list, even if they were supplied at registration time. | Zero or more elements. |
| homePhone | string | If present, must be 10 digits only. | |
| mobilePhone | string | If present, must be 10 digits only. | |
| name | Name | The person's name. | |
| previousResidentialAddress | Address | The person's previous residential address. | |
| workPhone | string | If present, must be 10 digits only. |
Address
The Address object is intended to serve as a container for address information for countries with a variety of different address schemes and formats. The fields that are present or required will depend on the country that is specified. Similarly, fields may have different validation rules depending on the country, for example, the field "postcode" must be a four digit string for an Australian address, but it must be a five digit string for a US address. For requirements for individual countries, please contact greenID.
| Name | Type | Description | Contract |
|---|---|---|---|
| alley | string | ||
| amalgamatedMunicipality | string | ||
| area | String | ||
| avenue | String | ||
| block | String | ||
| canton | String | ||
| chome | String | ||
| city | String | ||
| country | String | The country code. This must be the ISO 3166 country code. The country code can be given in either the alpha-2, alpha-3 or numeric format. | Please refer to https://www.iso.org/obp/ui/#search for a full (and up to date) list of ISO 3166 country codes. |
| county | String | ||
| deliveryNumber | String | ||
| department | String | ||
| direction | String | ||
| dispatchingInformation | String | ||
| district | String | ||
| divisionFive | String | ||
| divisionFour | String | ||
| divisionOne | String | ||
| divisionThree | String | ||
| divisionTwo | String | ||
| flatNumber | String | ||
| level | String | ||
| locality | String | ||
| location | String | ||
| mailCentre | String | ||
| municipality | String | ||
| neighbourhood | String | ||
| organisation | String | ||
| parish | String | ||
| personName | String | ||
| poBox | String | ||
| postcode | String | ||
| prefecture | String | ||
| propertyName | String | ||
| province | String | ||
| quarter | String | ||
| region | String | ||
| ruralArea | String | ||
| ruralLocality | String | ||
| sector | String | ||
| sectorNumber | String | ||
| state | String | ||
| streetName | String | ||
| streetNumber | String | ||
| streetType | String | ||
| subdistrict | String | ||
| subregion | String | ||
| suburb | String | ||
| town | String | ||
| townCity | String | ||
| township | String | ||
| urbanLocality | String | ||
| village | String |
Name
The Name complex type has the following structure:
Member | Type | Required? | Description | Contract |
|---|---|---|---|---|
honorific | String 255 Chars | No | The honorific component of a person’s name, eg. “Mr”, “Miss”, etc. | |
givenName | String 255 Chars | Yes | A person’s given name. | Cannot be null. Cannot be the empty string. |
middleNames | String 255 Chars | No | A person’s middle names. Note that there can be multiple names. | |
surname | String 255 Chars | Yes | A person’s surname or last name. | Cannot be null. Cannot be the empty string. |
VerificationResultV2
...