Skip to main content
POST
Secure Citizen Get Registration Status Service

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.

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.

IdNumber
string | null

The ID Number that you are wanting to query

MobileNumber
string | null

The Mobile Number that you are wanting to query

Response

Success

CRef
string<string> | null

This field will return the reference provided by the client to track the transaction.

Status
enum<string>

Status values (static strings) to be used for external connection management

Available options:
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
Message
string<string> | null

This will return a status of the transaction s well as external tracking information.

IdNumber
string

Individual's Identity Number

StatusCode
enum<integer>

These include NotFound, Unclaimed, Claimed and Suspicious in terms of user characterisation

Available options:
0,
1,
2,
3
StatusDescription
string | null

Status of this request

DHAImageAvailable
boolean | null

DHA Image Status

DHAFaceVerified
boolean | null

DHA Face Verification Status

SelfieUrl
string | null

Your provided Selfie

FirstName
string | null

Firstname of the secure citizen as per the Identification document

LastName
string | null

Lastname of the secure citizen as per the Identification document