/
Data Anonymising- RegistrationUpdateServiceV2.wipeData

Data Anonymising- RegistrationUpdateServiceV2.wipeData


This method gives customers the ability to anonymise (wipe), hide and delete records, by supplying two lists: verificationIds and actions. 

Web Service Endpoints

Test environment

https://test-au.vixverify.com/Registrations-Registrations/RegistrationUpdateServicePasswordV2?wsdl

Production environment

https://au.vixverify.com/Registrations-Registrations/RegistrationUpdateServicePasswordV2?wsdl

Actions:

wipe - This action enables the removal of PII data from the given record. This action cannot be undone. The following data will be anonymised when this action is performed:

  • name
  • address
  • dob
  • email
  • phone
  • documents
  • mobile images
  • extra Data items
  • encrypted Data items

hide   - This action hides the record from display in the admin panel. It's possible for a user with the 'enable.hidden.user' permission to display hidden users in the admin panel.

delete - This action removes the records association to the customer.

Input Parameters

NameTypeRequiredDescription
accountIdStringYesGreenID issues each customer with an accountId, which is a unique identifier by which greenID knows the caller.  This accountId must be supplied with every call to any method in this API.
passwordStringYesEach customer is issued a password that must be supplied with every call to any web method in this API.
verificationIdsList<verificationId>YesA list of verificationId elements, verificationId is described below.
actionsList<action>YesA list of action elements. Action is described below.
verificationIdStringYesA unique identifier that greenID and the caller use to refer to a verification attempt for an individual person.
actionStringYes

Available options for action are:

  • wipe
  • hide
  • delete

Return Value

This method returns UpdateStatus object. The following members will be populated.

changeApplied -  this is a boolean value

error - this is a boolean value

status - this is a tokenised String containing verificationId with the status of the action.


Example soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.registrations.edentiti.com/">
	<soapenv:Header/>
	<soapenv:Body>
		<ser:wipeData>
			<!--Optional:-->
			<accountId>cucumber-dvs</accountId>
			<password>password</password>
			<verificationIds>
				<!--One or more repetitions:-->
				<verificationId>E915pMUz</verificationId>
				<verificationId>1234ABCD</verificationId>
			</verificationIds>
			<actions>
				<action>wipe</action>
				<action>hide</action>
				<action>delete</action>
			</actions>
	</ser:wipeData>
	</soapenv:Body>
</soapenv:Envelope>
Example soap response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <ns2:wipeDataResponse xmlns:ns2="http://services.registrations.edentiti.com/">
         <return>
            <changeApplied>true</changeApplied>
            <error>false</error>
            <status>E915pMUz:hide:success</status>
            <type/>
         </return>
         <return>
            <changeApplied>true</changeApplied>
            <error>false</error>
            <status>E915pMUz:wipe:success</status>
            <type/>
         </return>
      </ns2:wipeDataResponse>
   </env:Body>
</env:Envelope>


Related content

Registering a user
Registering a user
More like this
Web Service Endpoints
Web Service Endpoints
More like this
Data Testing
Data Testing
Read with this
Encrypted Identifiers
Encrypted Identifiers
More like this
Notification of Verification
Notification of Verification
Read with this
Retrieving the Verification State
Retrieving the Verification State
More like this