Secure Citizen Lookup RSAID verification call

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "IdNumber": "<string>",
  "RequestReason": "<string>",
  "CRef": "<string>",
  "Subsidiary": "<string>",
  "IdentityCache": true,
  "CachePreferred": true,
  "CacheOnly": true,
  "SAFPSRequired": true,
  "LivenessRequired": true,
  "HANISImageRequired": true,
  "FirstNames": "<string>",
  "LastName": "<string>",
  "FaceString": "<string>",
  "MobileNumber": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification"

payload = {
    "ConsentReceived": True,
    "IdNumber": "<string>",
    "RequestReason": "<string>",
    "CRef": "<string>",
    "Subsidiary": "<string>",
    "IdentityCache": True,
    "CachePreferred": True,
    "CacheOnly": True,
    "SAFPSRequired": True,
    "LivenessRequired": True,
    "HANISImageRequired": True,
    "FirstNames": "<string>",
    "LastName": "<string>",
    "FaceString": "<string>",
    "MobileNumber": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    IdNumber: '<string>',
    RequestReason: '<string>',
    CRef: '<string>',
    Subsidiary: '<string>',
    IdentityCache: true,
    CachePreferred: true,
    CacheOnly: true,
    SAFPSRequired: true,
    LivenessRequired: true,
    HANISImageRequired: true,
    FirstNames: '<string>',
    LastName: '<string>',
    FaceString: '<string>',
    MobileNumber: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'IdNumber' => '<string>',
    'RequestReason' => '<string>',
    'CRef' => '<string>',
    'Subsidiary' => '<string>',
    'IdentityCache' => true,
    'CachePreferred' => true,
    'CacheOnly' => true,
    'SAFPSRequired' => true,
    'LivenessRequired' => true,
    'HANISImageRequired' => true,
    'FirstNames' => '<string>',
    'LastName' => '<string>',
    'FaceString' => '<string>',
    'MobileNumber' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": null,
  "title": "Citizen Api Output",
  "status": 200,
  "details": "Details of the output",
  "instance": "/Citizen/RSAIDVerification",
  "response": {
    "TrackingNumber": "00000000-0000-0000-0000-000000000000",
    "CachedResult": true,
    "CacheDate": "2026-06-17T10:35:58.4824395+00:00",
    "FirstNameResult": "70",
    "LastNameResult": "70",
    "IdNumber": "8001014800080",
    "FaceResult": {
      "isIdentical": true,
      "confidence": 1
    },
    "LivenessResult": {
      "LivenessResultScore": 1,
      "LivenessResultProbability": 0.8,
      "LivenessResultQuality": 0.8,
      "LivenessResultClass": false,
      "LivenessPassResult": true,
      "LivenessMessage": "Liveness check successful"
    },
    "SAFPSResults": null,
    "FirstName": "FirstName",
    "LastName": "LastName",
    "SmartCardIssued": false,
    "IDIssueDate": "20260617",
    "IDSequenceNumber": "1",
    "DeadIndicator": false,
    "DateOfDeath": null,
    "IDBlocked": false,
    "MaritalStatus": null,
    "DateOfMarriage": null,
    "OnHanis": true,
    "OnNPR": true,
    "BirthPlaceCountryCode": "Code",
    "BirthPlaceCountry": "",
    "FacialImageAvailable": true,
    "FacialImage": "base64",
    "SCDerivedValues": null,
    "IsWalletCreated": false,
    "CRef": "string",
    "Status": "Success",
    "Message": "Message"
  }
}

Identity Verification

Secure Citizen Lookup RSAID verification call

This is a service that requests the Identity Information of a consumer for use in an identity validation process and conducts a liveness check of the selfie provided for biometric verification. A combination of either the ID number and the name and surname or the client’s photo is required to return a match. This is inline with recommendations from the SAFPS to ensure data is shared with the correct consumer.

POST

Citizen

RSAIDVerification

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "IdNumber": "<string>",
  "RequestReason": "<string>",
  "CRef": "<string>",
  "Subsidiary": "<string>",
  "IdentityCache": true,
  "CachePreferred": true,
  "CacheOnly": true,
  "SAFPSRequired": true,
  "LivenessRequired": true,
  "HANISImageRequired": true,
  "FirstNames": "<string>",
  "LastName": "<string>",
  "FaceString": "<string>",
  "MobileNumber": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification"

payload = {
    "ConsentReceived": True,
    "IdNumber": "<string>",
    "RequestReason": "<string>",
    "CRef": "<string>",
    "Subsidiary": "<string>",
    "IdentityCache": True,
    "CachePreferred": True,
    "CacheOnly": True,
    "SAFPSRequired": True,
    "LivenessRequired": True,
    "HANISImageRequired": True,
    "FirstNames": "<string>",
    "LastName": "<string>",
    "FaceString": "<string>",
    "MobileNumber": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    IdNumber: '<string>',
    RequestReason: '<string>',
    CRef: '<string>',
    Subsidiary: '<string>',
    IdentityCache: true,
    CachePreferred: true,
    CacheOnly: true,
    SAFPSRequired: true,
    LivenessRequired: true,
    HANISImageRequired: true,
    FirstNames: '<string>',
    LastName: '<string>',
    FaceString: '<string>',
    MobileNumber: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'IdNumber' => '<string>',
    'RequestReason' => '<string>',
    'CRef' => '<string>',
    'Subsidiary' => '<string>',
    'IdentityCache' => true,
    'CachePreferred' => true,
    'CacheOnly' => true,
    'SAFPSRequired' => true,
    'LivenessRequired' => true,
    'HANISImageRequired' => true,
    'FirstNames' => '<string>',
    'LastName' => '<string>',
    'FaceString' => '<string>',
    'MobileNumber' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/RSAIDVerification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"IdNumber\": \"<string>\",\n  \"RequestReason\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"Subsidiary\": \"<string>\",\n  \"IdentityCache\": true,\n  \"CachePreferred\": true,\n  \"CacheOnly\": true,\n  \"SAFPSRequired\": true,\n  \"LivenessRequired\": true,\n  \"HANISImageRequired\": true,\n  \"FirstNames\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"MobileNumber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": null,
  "title": "Citizen Api Output",
  "status": 200,
  "details": "Details of the output",
  "instance": "/Citizen/RSAIDVerification",
  "response": {
    "TrackingNumber": "00000000-0000-0000-0000-000000000000",
    "CachedResult": true,
    "CacheDate": "2026-06-17T10:35:58.4824395+00:00",
    "FirstNameResult": "70",
    "LastNameResult": "70",
    "IdNumber": "8001014800080",
    "FaceResult": {
      "isIdentical": true,
      "confidence": 1
    },
    "LivenessResult": {
      "LivenessResultScore": 1,
      "LivenessResultProbability": 0.8,
      "LivenessResultQuality": 0.8,
      "LivenessResultClass": false,
      "LivenessPassResult": true,
      "LivenessMessage": "Liveness check successful"
    },
    "SAFPSResults": null,
    "FirstName": "FirstName",
    "LastName": "LastName",
    "SmartCardIssued": false,
    "IDIssueDate": "20260617",
    "IDSequenceNumber": "1",
    "DeadIndicator": false,
    "DateOfDeath": null,
    "IDBlocked": false,
    "MaritalStatus": null,
    "DateOfMarriage": null,
    "OnHanis": true,
    "OnNPR": true,
    "BirthPlaceCountryCode": "Code",
    "BirthPlaceCountry": "",
    "FacialImageAvailable": true,
    "FacialImage": "base64",
    "SCDerivedValues": null,
    "IsWalletCreated": false,
    "CRef": "string",
    "Status": "Success",
    "Message": "Message"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Example: true

This is an indicator to audit the fact that the controller has obtained consent from the subject to process their personal information and data as per the regulatory requirements pertaining to local and global privacy and data protection legislation.

IdNumber

string<string>

required

This is the ID number that a client wishes to run an identity validation query on.

Minimum string length: 1

RequestReason

string

required

Reason why lookup was requested.

Minimum string length: 1

CRef

string<string> | null

Example: "REF00001"

This is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.

Subsidiary

string<string> | null

In this field, the client should indicate who the verification is done by/for where it is not for a known client of Secure Citizen.

IdentityCache

boolean<bool>

In this field the client would indicate whether they would want to receive cache data in the event that the department of home affairs is down. If the alternate service provider is selected, this field will be defaulted to true as a cached response may be returned by the service provider.

CachePreferred

boolean

Where this is true (and Identity cache is also set to true), and a cache record exists, the cache response will be returned. Where no record is found in cache, the DHA will be called for a response. There is a maximum timeout of 60 seconds on this call. If the alternate service provider is selected, this selection will not be applicable. A cache response will be returned if DHA is unavailable.

CacheOnly

boolean

Where this is true only cache will be returned if available. If the alternate service provider is selected, this selection will not be applicable. A cache response will be returned if DHA is unavailable.

SAFPSRequired

boolean

Indicate whether the client wants to receive the SAFPS results. If the alternate service provider is selected, this field will be defaulted to false as a no SAFPS data will be returned.

LivenessRequired

boolean

In this field the client would indicate whether they want a liveness check on the image provided by the consumer.

HANISImageRequired

boolean

Specifies whether the user wants to get the HANIS image. If the alternate service provider is selected, this selection will not be applicable. A cache response will be returned if DHA is unavailable.

FirstNames

string | null

Firstnames of the person being looked up. Required if FaceString is not provided

LastName

string | null

Lastname of the person being looked up. Required if FaceString is not provided

FaceString

string | null

Image of the person being looked up. Required if FirstNames and LastName not provided

MobileNumber

string | null

Mobile Number. Mobile number provided should be 0xxx.

Response

Success

type

string | null

title

string | null

status

integer<int32>

details

string | null

instance

string | null

response

object

Show child attributes

Secure Citizen RSA ID Validation

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Secure Citizen Lookup RSAID verification call

Authorizations

Body

Response