ID Check ZA Alpha

 

ID Check ZA Alpha

ID Check ZA Alpha is an identity verification service for South Africa.

Properties

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.
HouseNameNumber
String
26 Mandatory if no HouseName or HouseNumber given  
HouseName
String
26 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber
String
26 Mandatory if no HouseNameNumber or 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

The following is an example response:

<IDCheckZAAlphaResult>
	 <Individuals>
		<ErrorCode>101</ErrorCode>
		<ErrorMessage>MISSING OR WRONG ENTRY: National ID number must be exactly 13 digits;
    			</ErrorMessage>
		<Individual />
		<Summary />
		<Type>Error</Type>
	 </Individuals>
	 <Passport/>
	 <SearchRef>4AA2ADEC-2821-47B5-A165-0C04CF1FBB5D</SearchRef>
	 <Summary>
		<DecisionMatrix>
		   <Code>W2DMZAF</Code>
		   <Decision>
			  <Outcome>-1</Outcome>
			  <Reason>No Matches Have Been Found Individual Has Not Passed Our Requirements
        			</Reason>
		   </Decision>
		   <Name>W2 Global South African DM</Name>
		   <Rules>
			  <RuleList>
				 <Rule>
					<Code />
					<Id>ProveID KYC-3051</Id>
					<Name>BSO/ZAF/NameAddressDOB/IDMismatch</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
				 <Rule>
					<Code />
					<Id>ProveID KYC-3048</Id>
					<Name>BSO/ZAF/NameAddressDOB/v2</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
				 <Rule>
					<Code />
					<Id>ProveID KYC-3050</Id>
					<Name>BSO/ZAF/NamePremPCodeDOB/v2</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
				 <Rule>
					<Code />
					<Id>ProveID KYC-3052</Id>
					<Name>BSO/ZAF/NameDOBOnly</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
				 <Rule>
					<Code />
					<Id>Other-3005</Id>
					<Name>BSO/AnyDatabase/Error</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
				 <Rule>
					<Code />
					<Id>ProveID-2777</Id>
					<Name>BSO/AnyDatabase/Result</Name>
					<Outcome/>
					<Reason>Reason Not Applicable as Outcome Not Triggered</Reason>
				 </Rule>
			  </RuleList>
		   </Rules>
		</DecisionMatrix>
		<KYCSummary>
		   <Address />
		   <Alerts />
		   <DateOfBirth />
		   <FullNameAndAddress />
		   <SurnameAndAddress />
		</KYCSummary>
		<ReportSummary>
		   <DatablocksSummary>
			  <DatablockSummaryList>
				 <DatablockSummary>
					<Decision/>
					<Name>Individuals</Name>
				 </DatablockSummary>
			  </DatablockSummaryList>
		   </DatablocksSummary>
		</ReportSummary>
	 </Summary>
</IDCheckZAAlphaResult>

Sandbox

This service uses Sandbox V2.

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 

DayOfBirth: 15
Forename: "JOHN"
HouseNameNumber: "10"
MonthOfBirth: 3
NationalId: "5603155113083"
Postcode: "6229"
Street: "RUDDLE"
Surname: "WILLING"
YearOfBirth: 1956

The corresponding entry in ServiceTransactions will show the following properties:

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

DayOfBirth: 28
Forename: "SANJIN"
HouseNameNumber: "941"
MonthOfBirth: 7
NationalId: "8797458748572"
Postcode: "3614"
Street: "STATION ROAD"
Surname: "STANKOVIC"
YearOfBirth: 1933

The corresponding entry in ServiceTransactions will show the following properties:

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:

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