Skip to main content
POST
Secure Citizen Lookup Refugee verification call

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.

FileNumber
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.

LivenessRequired
boolean

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

NIISImageRequired
boolean

This specifies whether the client would like the image of the consumer found in the National Immigration Information System.

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