South African ID validation technical guide | Sage Pay

Programmers guide

To start, please refer our programmer’s guide for more detail on how to apply the required methodology.

Please note:
Sage Pay may provide example/sample/demo code snippets in this technical document. Such snippets are for guidance purposes only and may not function on every developer’s system/s. Sage Pay disclaims any and all liability for the usage of any of the example/sample/demo code snippets provided -and you as the developer must accept full responsibility for the usage of any example/sample and/or demo code.

While every possible effort has been taken to ensure compatibility across multiple system configurations, the example/sample/demo code cannot be guaranteed to work on all systems, with all operating systems and
or with all system configuration/s.


A web service that uses an algorithm to validate the ID number of an employee, debtor or creditor.  Any software that allows for the capture of bank account details should implement this web service as it is critical for the success of other Sage Pay services requiring bank details such as ID number, bank account verification, bank codes or payments. This service does NOT verify that the individual is alive or that the ID number belongs to the individual.

This service is to be used on input of data of data into the application to ensure that the ID number supplied is valid.

Click here for the quick start guides for:

  • Account Service
  • Sage Pay system permissions

Technical Information

NIWS_Validation is an online, synchronous web service which allows an external system to request a validation and receive an immediate response. This service permits only a single request per web service call.

From your application call:

  • Web service:
  • Method: ValidateID
  • Service key: Account service key


Submit the following parameters.

Service key Account service key issued by Sage Pay
ID number Must be 13 digits


You will receive the following numeric code which you need to replace with the description in your application.

Numeric Response Description
0 Identity number valid
1 Id number too long
2 Id number too short
3 Id number failed check digit validation
100 Authentication failed
200 Web service error contact

Version 1/2014 last updated 1 Feb 2014