W2 DocsID Check ZA Alpha
Compatible Cases
About the service
ID Check ZA Alpha is an identity verification service for South Africa.
Product Code: W2-DATA-EKYC-ZA-005
Does this service leave a credit search Footprint? Yes
Request
The following properties pertain to this service.
| Property Name | Type | Length | Optional/Mandatory | Notes |
|---|---|---|---|---|
| Forename | String | 15 | Mandatory | |
| MiddleNames | String | 15 | Optional | |
| Surname | String | 30 | Mandatory | |
| Gender | String | Optional | Must be 'M' or 'F' if provided | |
| DayOfBirth | Integer | 2 | Optional | Day, month and year birth components must all have a value, or all be null. |
| MonthOfBirth | Integer | 2 | Optional | Day, month and year birth components must all have a value, or all be null. |
| YearOfBirth | Integer | 4 | Optional | Day, month and year birth components must all have a value, or all be null. |
| HouseName | String | 26 | Mandatory if no HouseNumber given | |
| HouseNumber | String | 26 | Mandatory if no HouseName given | |
| Street | String | 40 | Mandatory | |
| County | String | 20 | Optional | |
| City | String | 20 | Optional | |
| Postcode | String | 8 | Mandatory | |
| Phone Number | String | 16 | Optional | Please provide the phone number as one contiguous set of numbers with no other characters or spaces. |
| National ID | String | 20 | Mandatory | South African national ID number for resident |
After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.
Response
Sample Response:
json
"idCheckZAAlphaResult": {
"individuals": {
"individual": {
"addresses": {},
"individualSummary": {}
},
"summary": {
"decision": "-1",
"decisionReasons": {
"decisionReasonList": [
{
"decision": "-1",
"element": "Individual/IndividualSummary/DateOfBirthMatch"
},
{
"decision": "-1",
"element": "Individual/IndividualSummary/NameMatch"
}
]
}
},
"type": "Result"
},
"searchRef": "e74c23da-fd62-42e6-87ef-8055d1952155",
"summary": {
"decisionMatrix": {
"code": "******",
"decision": {
"outcome": "1",
"reason": "Individual has only matched on name no address or DOB"
},
"name": "****************",
"rules": {
"ruleList": [
{
"id": "Individuals Datablock",
"name": "BSO/DEU/Bespoke/Nam/NameDOB",
"outcome": "-1",
"reason": "Individual has a full match to forename surname and DOB"
},
{
"id": "Telephony Datablock",
"name": "BSO/DEU/Bespoke/NamPremPC/ID/90/NameAddress",
"outcome": "-1",
"reason": "Individual has a full match to forename surname premise postcode"
}
]
}
},
"kycSummary": {
"address": {
"count": "4"
},
"alerts": {
"count": "0"
},
"dateOfBirth": {
"count": "3"
},
"fullNameAndAddress": {
"count": "0"
},
"surnameAndAddress": {
"count": "0"
}
},
"reportSummary": {
"datablocksSummary": {
"datablockSummaryList": [
{
"decision": "1",
"name": "Individuals"
}
]
}
}
}
}Sandbox
If the Sandbox query option is set to "true" then:
If the following details are set, a single fictitious PASS result is returned in IDCheckZAAlphaResult
| Property | Value |
|---|---|
| DayOfBirth: | 15 |
| Forename: | "JOHN" |
| HouseNumber: | 10 |
| MonthOfBirth: | 3 |
| NationalId: | "5603155113083" |
| Postcode: | "6229" |
| Street: | "RUDDLE" |
| Surname: | "WILLING" |
| YearOfBirth: | 1956 |
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceInterpretResult: | Pass |
| ServiceTransactionResult: | Success |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |
If the following details are set, a single fictitious FAIL result is returned in IDCheckNLAlphaResult:
| Property | Value |
|---|---|
| DayOfBirth: | 28 |
| Forename: | "SANJIN" |
| HouseNumber: | 941 |
| MonthOfBirth: | 7 |
| NationalId: | "8797458748572" |
| Postcode: | "3614" |
| Street: | "STATION ROAD" |
| Surname: | "STANKOVIC" |
| YearOfBirth: | 1933 |
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceInterpretResult: | Fail |
| ServiceTransactionResult: | Success |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |
Otherwise a blank, non-null entry will be returned in the ServiceResult.
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceInterpretResult: | NotApplicable |
| ServiceTransactionResult: | Success |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |