...
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
Need a summary
| Name | Type | Description | Restrictions |
|---|---|---|---|
| currentResidentialAddress | Address | The person's current residential address. | |
| dateCreated | DateTime | ||
| dob | string | The person's date of birth. | |
| string | May be null. Must be a valid email address. | ||
| extraData | List<NameValuePair> | ||
| 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
| 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 | The flat number component of an address. For example, in the address “1/5 Fake St”, “1” is the flat number. | |
| level | String | ||
| locality | String | ||
| location | String | ||
| mailCentre | String | ||
| municipality | String | ||
| neighbourhood | String | ||
| organisation | String | ||
| parish | String | ||
| personName | String | ||
| poBox | String | ||
| postcode | String | The postcode component of the individual's address. Must be a valid Australian postcode. | Must be 4 numbers between 0 and 9 (i.e. as a regular expression: ^[\d]{4}$) |
| prefecture | String | ||
| propertyName | String | ||
| province | String | ||
| quarter | String | ||
| region | String | ||
| ruralArea | String | ||
| ruralLocality | String | ||
| sector | String | ||
| sectorNumber | String | ||
| state | String | The state component of the individual's address. Must be a valid Australian state or territory. | One of:
|
| streetName | String | The name of the street. | Cannot be null. Cannot be an empty string. |
| streetNumber | String | The street number component of an address. In the example above, “5” is the street number. | |
| streetType | String | A valid Australian street type. | A valid Australian street type, or its recognised abbreviation. For a full list of acceptable values, please see Street Types. |
| subdistrict | String | ||
| subregion | String | ||
| suburb | String | The suburb or town component of the individual's address. | Cannot be null. Cannot be an empty string. For New Zealand addresses, this field should contain the suburb; the "city" address element is not required by any current greenID New Zealand data sources. |
| 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
...