Skip to main content
POST
Secure Citizen Fingerprint Validation

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
required

Requested users ID Number

Minimum string length: 1
fP1No
integer<int32>
required
fP1WSQImage
string
required
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.

CacheEnabled
boolean

Allows third party to enable support for offline response data

fP2No
integer<int32>
fP2WSQImage
string | null

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.

RequestedBy
string | null

This will indicate who requested the data that is being provided.

AuthorizedBy
string | null

This will indicate who authorized the provision of the requested data

GoldenSource
object
OfflineCacheResult
object