Skip to main content
POST
Secure Citizen Drivers License Verification

Authorizations

Authorization
string
header
required

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

Body

application/json
FirstNames
string
required
Minimum string length: 1
LastName
string
required
Minimum string length: 1
IdNumber
string
required
Minimum string length: 1
CRef
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

result
boolean
response_object
object
result_code
object