Skip to content
On this page

ID Check ZA Alpha

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 NameTypeLengthOptional/MandatoryNotes
ForenameString15Mandatory
MiddleNamesString15Optional
SurnameString30Mandatory
GenderStringOptionalMust be 'M' or 'F' if provided
DayOfBirthInteger2OptionalDay, month and year birth components must all have a value, or all be null.
MonthOfBirthInteger2OptionalDay, month and year birth components must all have a value, or all be null.
YearOfBirthInteger4OptionalDay, month and year birth components must all have a value, or all be null.
HouseNameString26Mandatory if no HouseNumber given
HouseNumberString26Mandatory if no HouseName given
StreetString40Mandatory
CountyString20Optional
CityString20Optional
PostcodeString8Mandatory
Phone NumberString16OptionalPlease provide the phone number as one contiguous set of numbers with no other characters or spaces.
National IDString20MandatorySouth 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

PropertyValue
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:

PropertyValue
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:

PropertyValue
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:

PropertyValue
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:

PropertyValue
HaltTriggered:False
ServiceInterpretResult:NotApplicable
ServiceTransactionResult:Success
ServiceTransactionResultMessage:"This call was generated using sandbox mode"
ValidationResult:Pass