> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
## OpenAPI
````yaml products/didx-verify/api-reference/v1/openapi.json post /Citizen/RSAIDVerification
openapi: 3.0.1
info:
title: SecureCitizen.Citizen.Api
description: >-
This is the API documentation for Secure Citizen products. Should you
require further information please contact us on the email provided.
contact:
name: Api Contant Name
email: support@securecitizen.co.za
license:
name: Proprietary
url: https://www.securecitizen.co.za
version: v1
x-logo:
url: >-
https://securecitizen.co.za/wp-content/uploads/2022/11/Untitled-design-14.svg
altText: Secure Citizen
servers:
- url: https://citizen.uat.securecitizen.cloud
security: []
tags:
- name: Citizen
description: This details information we can replace to describe this endpoint
- name: CitizenV
description: This details information we can replace to describe this endpoint
- name: CustomClient
description: This details information we can replace to describe this endpoint
- name: Partner
description: This details information we can replace to describe this endpoint
paths:
/Citizen/RSAIDVerification:
post:
tags:
- Citizen
summary: Secure Citizen Lookup RSAID verification call
description: "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.\r\nA combination of either the ID number and the name and surname or the client's photo is required to return a match.\r\nThis is inline with recommendations from the SAFPS to ensure data is shared with the correct consumer."
operationId: RSAIDVerification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RSAIDVerificationRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RSAVerificationProblemDetails'
examples:
'8001014800080':
value:
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
'8001014800081':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8001014800081'
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
'8001014800082':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '0'
LastNameResult: '0'
IdNumber: null
FaceResult: null
LivenessResult: null
SAFPSResults: null
FirstName: null
LastName: null
SmartCardIssued: null
IDIssueDate: null
IDSequenceNumber: null
DeadIndicator: null
DateOfDeath: null
IDBlocked: null
MaritalStatus: null
DateOfMarriage: null
OnHanis: null
OnNPR: null
BirthPlaceCountryCode: null
BirthPlaceCountry: ''
FacialImageAvailable: null
FacialImage: null
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: 800 - IDNR is valid, but is not found on the NPR
'8001014800083':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '0'
LastNameResult: '0'
IdNumber: 'null'
FaceResult: null
LivenessResult: null
SAFPSResults: null
FirstName: null
LastName: null
SmartCardIssued: null
IDIssueDate: null
IDSequenceNumber: null
DeadIndicator: null
DateOfDeath: null
IDBlocked: null
MaritalStatus: null
DateOfMarriage: null
OnHanis: null
OnNPR: null
BirthPlaceCountryCode: null
BirthPlaceCountry: ''
FacialImageAvailable: null
FacialImage: null
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: 600 - IDNR marked for 'Deletion' on the NPR
'8001014800084':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '0'
LastNameResult: '0'
IdNumber: 'null'
FaceResult: null
LivenessResult: null
SAFPSResults: null
FirstName: null
LastName: null
SmartCardIssued: null
IDIssueDate: null
IDSequenceNumber: null
DeadIndicator: null
DateOfDeath: null
IDBlocked: null
MaritalStatus: null
DateOfMarriage: null
OnHanis: null
OnNPR: null
BirthPlaceCountryCode: null
BirthPlaceCountry: ''
FacialImageAvailable: null
FacialImage: null
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: 10088 - NPR Not available, only photo is returned
'8001014800085':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '0'
LastNameResult: '0'
IdNumber: null
FaceResult: null
LivenessResult: null
SAFPSResults: null
FirstName: null
LastName: null
SmartCardIssued: null
IDIssueDate: null
IDSequenceNumber: null
DeadIndicator: null
DateOfDeath: null
IDBlocked: null
MaritalStatus: null
DateOfMarriage: null
OnHanis: null
OnNPR: null
BirthPlaceCountryCode: null
BirthPlaceCountry: ''
FacialImageAvailable: null
FacialImage: null
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: >-
Failure to get response - Error: Task cancelled, DHA is
down
'8001014800086':
value:
type: null
title: Citizen Api Output
status: 200
details: Details of the output
instance: /Citizen/RSAIDVerification
response:
TrackingNumber: 00000000-0000-0000-0000-000000000000
CachedResult: false
CacheDate: null
FirstNameResult: '0'
LastNameResult: '0'
IdNumber: 'null'
FaceResult: null
LivenessResult: null
SAFPSResults: null
FirstName: null
LastName: null
SmartCardIssued: null
IDIssueDate: null
IDSequenceNumber: null
DeadIndicator: null
DateOfDeath: null
IDBlocked: null
MaritalStatus: null
DateOfMarriage: null
OnHanis: null
OnNPR: null
BirthPlaceCountryCode: null
BirthPlaceCountry: ''
FacialImageAvailable: null
FacialImage: null
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: SAFPS Fetch Timed out. No cache record found.
'8001014800087':
value:
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.4826304+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8001014800087'
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: Successfully fetched cached data
'9501019575081':
value:
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.482658+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9501019575081'
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: Successfully fetched cached data
'8704234766086':
value:
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.4826846+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8704234766086'
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: true
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: Successfully fetched cached data
'8711234891087':
value:
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.4827121+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8711234891087'
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: true
MaritalStatus: null
DateOfMarriage: null
OnHanis: true
OnNPR: true
BirthPlaceCountryCode: Code
BirthPlaceCountry: ''
FacialImageAvailable: true
FacialImage: base64
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: Successfully fetched cached data
'8011234891082':
value:
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.4827372+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8011234891082'
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: false
OnNPR: true
BirthPlaceCountryCode: Code
BirthPlaceCountry: ''
FacialImageAvailable: true
FacialImage: base64
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: Successfully fetched cached data
'9905034997081':
value:
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.4827649+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9905034997081'
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: false
FacialImage: base64
SCDerivedValues: null
IsWalletCreated: false
CRef: string
Status: Success
Message: Successfully fetched cached data
'8508274995087':
value:
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.4827902+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8508274995087'
FaceResult:
isIdentical: true
confidence: 1
LivenessResult:
LivenessResultScore: 1
LivenessResultProbability: 0.8
LivenessResultQuality: 0.8
LivenessResultClass: false
LivenessPassResult: true
LivenessMessage: Liveness check successful
SAFPSResults:
- FirstName: TEST
Surname: USER
BirthDate: '2026-06-17T10:35:58.4827896+00:00'
Filings:
- ReferenceNo: SH00000001
Category: Impersonation
- ReferenceNo: VICTIM00000001
Category: Victim of impersonation
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: Successfully fetched cached data
'9603044983080':
value:
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.4828226+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9603044983080'
FaceResult:
isIdentical: true
confidence: 1
LivenessResult:
LivenessResultScore: 1
LivenessResultProbability: 0.8
LivenessResultQuality: 0.8
LivenessResultClass: false
LivenessPassResult: true
LivenessMessage: Liveness check successful
SAFPSResults:
- FirstName: TEST
Surname: USER
BirthDate: '2026-06-17T10:35:58.4828221+00:00'
Filings:
- ReferenceNo: PR00000001
Category: ''
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: Successfully fetched cached data
'8801014800083':
value:
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.4828531+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8801014800083'
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: 800 - IDNR is valid, but is not found on the NPR
'8609264983081':
value:
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.4828809+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '8609264983081'
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: 600 - IDNR marked for 'Deletion' on the NPR
'9507207820189':
value:
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.4829061+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9507207820189'
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: 10088 - NPR Not available, only photo is returned
'9704306756089':
value:
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.4829348+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9704306756089'
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: >-
Failure to get response - Error: Task cancelled, DHA is
down
'9804274800081':
value:
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.4831577+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9804274800081'
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: SAFPS Fetch Timed out. No cache record found.
'9306164800080':
value:
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.4832044+00:00'
FirstNameResult: '70'
LastNameResult: '70'
IdNumber: '9306164800080'
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: Successfully fetched cached data
'401':
description: Unauthenticated
'403':
description: Unauthorized access to this resource
'500':
description: Cat-as-trophy
security:
- oauth2:
- sc-citizen
components:
schemas:
RSAIDVerificationRequest:
required:
- ConsentReceived
- IdNumber
- RequestReason
type: object
properties:
CRef:
title: Client Reference
type: string
description: "Example: \"REF00001\"\r\n\r\nThis 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."
format: string
nullable: true
ConsentReceived:
title: Consent Received
type: boolean
description: "Example: true\r\n\r\nThis 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."
format: bool
Subsidiary:
title: Subsidiary
type: string
description: >-
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.
format: string
nullable: true
IdNumber:
title: ID Number
minLength: 1
type: string
description: >-
This is the ID number that a client wishes to run an identity
validation query on.
format: string
IdentityCache:
title: Identity Caching
type: boolean
description: >-
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.
format: bool
CachePreferred:
title: Cache Preferred
type: boolean
description: >-
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:
title: Cache Only
type: boolean
description: >-
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:
title: SAFPS Required
type: boolean
description: >-
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:
title: LivenessRequired
type: boolean
description: >-
In this field the client would indicate whether they want a liveness
check on the image provided by the consumer.
HANISImageRequired:
title: HANIS Image Required
type: boolean
description: >-
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:
title: Firstnames
type: string
description: >-
Firstnames of the person being looked up. Required if FaceString is not provided
nullable: true
LastName:
title: Lastname
type: string
description: >-
Lastname of the person being looked up. Required if FaceString is not provided
nullable: true
FaceString:
title: Face String
type: string
description: >-
Image of the person being looked up. Required if FirstNames and LastName not
provided
nullable: true
RequestReason:
title: Request Reason
minLength: 1
type: string
description: Reason why lookup was requested.
MobileNumber:
title: Mobile Number
type: string
description: Mobile Number. Mobile number provided should be 0xxx.
nullable: true
additionalProperties: false
RSAVerificationProblemDetails:
type: object
properties:
type:
type: string
nullable: true
title:
type: string
nullable: true
status:
type: integer
format: int32
details:
type: string
nullable: true
instance:
type: string
nullable: true
response:
$ref: '#/components/schemas/RSAIDVerificationResponse'
additionalProperties: false
RSAIDVerificationResponse:
type: object
properties:
CRef:
title: Client Reference
type: string
description: >-
This field will return the reference provided by the client to track
the transaction.
format: string
nullable: true
Status:
$ref: '#/components/schemas/ExternalStatusEnums'
Message:
title: Message
type: string
description: >-
This will return a status of the transaction s well as external
tracking information.
format: string
nullable: true
TrackingNumber:
title: Tracking Number
type: string
description: Tracking number of the transaction
nullable: true
CachedResult:
title: Cached Result
type: boolean
description: Indicator whether the result came from cache or not.
CacheDate:
title: Cached Date
type: string
description: >-
This is the date that the record was added or refreshed on the SAFPS
Cache Database. The Cache entry is refreshed with new enquiries to
the Department of Home Affairs. The date will always reflect the
most recent entry.
format: date-time
nullable: true
FirstNameResult:
title: First Name Result
type: string
description: >-
Percentage of the similarity between FirstName provided and DHA
result
nullable: true
LastNameResult:
title: Last Name Result
type: string
description: >-
Percentage of the similarity between FirstName provided and DHA
result
nullable: true
IdNumber:
title: Id number
type: string
description: Id number of the individual
nullable: true
FaceResult:
$ref: '#/components/schemas/VerifyResult'
LivenessResult:
$ref: '#/components/schemas/IDRNDParialResponse'
SAFPSResults:
title: Safps Results
type: array
items:
$ref: '#/components/schemas/SAFPSResult'
description: List containing results from safps
nullable: true
FirstName:
title: FirstName
type: string
description: First name as stated by DHA
nullable: true
LastName:
title: LastName
type: string
description: Last name as stated by DHA
nullable: true
SmartCardIssued:
title: SmartCardIssued
type: boolean
description: Indicator whether individual has a smart card
nullable: true
IDIssueDate:
title: IDIssueDate
type: string
description: Date when ID was issued
format: date-time
nullable: true
IDSequenceNumber:
title: IDSequenceNumber
type: string
description: Sequence number of the provided ID
nullable: true
DeadIndicator:
title: DeadIndicator
type: boolean
description: Indicator whether individual is dead or not
nullable: true
DateOfDeath:
title: DateOfDeath
type: string
description: Date when individual died
format: date-time
nullable: true
IDBlocked:
title: IDBlocked
type: boolean
description: Indicator whether individual's ID is blocked or not
nullable: true
MaritalStatus:
title: MaritalStatus
type: string
description: Marital status of an individual
nullable: true
DateOfMarriage:
title: DateOfMarriage
type: string
description: The date when the individual married
format: date-time
nullable: true
OnHanis:
title: OnHanis
type: boolean
description: Indicates whether individual is on HANIS
nullable: true
OnNPR:
title: OnNPR
type: boolean
description: Indicates whether individual is on NPR
nullable: true
BirthPlaceCountryCode:
title: BirthPlaceCountryCode
type: string
description: Country code where individual was born in
nullable: true
BirthPlaceCountry:
title: BirthPlaceCountry
type: string
description: Country where individual was born in
nullable: true
FacialImageAvailable:
title: FacialImageAvailable
type: boolean
description: Indicator whether individual has image with DHA
nullable: true
FacialImage:
title: FacialImage
type: string
description: Individual's image from the DHA
nullable: true
SCDerivedValues:
$ref: '#/components/schemas/SCDerivedValues'
IsWalletCreated:
title: IsWalletCreated
type: boolean
description: >-
Is wallet created. Only true when all validations pass and a wallet
is created.
additionalProperties: false
ExternalStatusEnums:
title: Status
enum:
- Success
- Failure
- Unknown
- AuthFailure
- DataDeserializationError
- EmptyResults
- ErrorContactSupport
- FaceDetectionFailure
- FaceComparisonFailure
- NoStatusDefined
- FaceDetectionQualityTooLow
- FaceDetectionTooManyFaces
- FaceDetectionNoFacesFound
- FaceComparisonError
- FaceComparisonNotSame
- GoldenSourceImageNull
- ProvidedImageNull
- GoldenSourceNoFacesFound
- ProvidedImageNoFacesFound
- GoldenSourceHasTooManyFaces
- ProvidedImageHasTooManyFaces
- GoldenSourceQualityTooLow
- ProvidedImageQualityTooLow
- GoldenSourceGUIDIncorrect
- ProvidedImageGUIDIncorrect
- FaceAPIGeneralError
- FaceAPIPublicUrlInputError
- FaceBadInput
- GoldenSourceIncorrectStringFormat
- ProvidedImageIncorrectStringFormat
- SAFPSNPROk
- SAFPSHANISOk
- SAFPSNIISOk
- SAFPSNPRSlow
- SAFPSHANISSlow
- SAFPSNIISSlow
- SAFPSFailure
- SAFPSPossibleFailure
- SAFPSNPRFailure
- SAFPSHANISFailure
- SAFPSNIISFailure
- FaceTooClose
- EyesClosed
- FaceCloseToBorder
- FaceCropped
- FaceIsOccluded
- FaceNotFound
- TooManyFaces
- FaceTooSmall
- AbsoluteFaceTooSmall
- RelativeFaceTooSmall
- FaceAngleTooLarge
- FailedToPredictLandmarks
- Active
- CSuccess
- AsyncCSuccess
- IdentificationNumberInvalid
- IdentificationNumberAgeBelow18
- UnableToVerifyIdentificationNumberOnDocument
- UnableToVerifyIdentificationNumberAtGoldenSource
- GoldenSourceUnavailable
- MandatoryInformationMissing
- NPRSuccess
- HANISNotAvailable
- InvalidIDNCheckDigitTestNotPassed
- NPRNotAvailableOnlyPhotoIsReturned
- IDNRIsNotCurrentlyAValidNPRIDNR
- IDNRIsMarkedForDeletion
type: string
description: >-
Status values (static strings) to be used for external connection
management
format: string
VerifyResult:
type: object
properties:
isIdentical:
type: boolean
confidence:
type: number
format: double
additionalProperties: false
IDRNDParialResponse:
type: object
properties:
LivenessResultScore:
title: Liveness Result Score
type: number
description: >-
This is the raw liveness score generated by the system. It's an
unbounded linear value where higher scores indicate a greater
likelihood that the input (e.g., a face) is from a live person. This
score is primarily used for calibration and tuning purposes, such as
adjusting the system's sensitivity to false positives or negatives.
format: double
LivenessResultProbability:
title: Liveness Result Probability
type: number
description: >-
This represents the system's calculated probability that the input
is from a live person, expressed as a value between 0 and 1. A value
greater than 0.5 typically indicates a live input, while a value
below 0.5 suggests a spoof or fake. This probability is the main
metric used to make liveness decisions.
format: double
LivenessResultQuality:
title: Liveness Result Quality
type: number
description: >-
This field assesses the quality of the input image in the context of
liveness detection. The quality score ranges from 0 (poor quality)
to 1 (high quality). A score below 0.5 generally indicates that the
image is unsuitable for reliable liveness analysis. Note that in
some contexts, this field may be deprecated in favor of more
detailed image quality warnings.
format: double
LivenessResultClass:
title: Liveness Result Class
type: boolean
description: >-
This field classifies the input based on its suitability for
liveness detection. For example, a value of 1 might indicate a
good-quality image suitable for analysis, while 0 could denote a
poor-quality image. However, this field is considered obsolete in
some versions of the model, with a recommendation to use the quality
score instead.
LivenessPassResult:
title: Liveness Pass Result
type: boolean
description: >-
This boolean field indicates whether the liveness check was passed.
A value of true means the input was determined to be live, while
false indicates a failure in the liveness check. This is a
straightforward pass/fail result based on the system's analysis.
readOnly: true
LivenessMessage:
title: Liveness Message
type: string
description: >-
This field likely provides a textual message or status related to
the liveness check, such as "Live," "Spoof," or "Invalid." It offers
a human-readable interpretation of the liveness result, which can be
useful for logging or user feedback.
nullable: true
readOnly: true
additionalProperties: false
SAFPSResult:
type: object
properties:
FirstName:
title: First Name
type: string
description: SAFPS look up first name
nullable: true
Surname:
title: Surname
type: string
description: SAFPS look up surname
nullable: true
BirthDate:
title: Birth Date
type: string
description: SAFPS look up birth date
format: date-time
nullable: true
Filings:
title: List of Filings
type: array
items:
$ref: '#/components/schemas/SAFPSFiling'
description: List containing categories and reference numbers
nullable: true
additionalProperties: false
SCDerivedValues:
type: object
properties:
DOB:
type: string
nullable: true
Age:
type: string
nullable: true
Gender:
type: string
nullable: true
Citizenship:
type: string
nullable: true
additionalProperties: false
SAFPSFiling:
type: object
properties:
ReferenceNo:
title: Reference Number
type: string
description: A reference to the file
nullable: true
Category:
title: Category
type: string
description: What category the files falls into
nullable: true
additionalProperties: false
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://sts.uat.securecitizen.cloud/connect/authorize
tokenUrl: https://sts.uat.securecitizen.cloud/connect/token
scopes:
sc-citizen: SecureCitizen.Citizen.Api
````