Perform detailed object search

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "idNumber": "<string>",
  "CRef": "<string>",
  "bankAccountNumber": "<string>",
  "contactNumber": "<string>",
  "emailAddress": "<string>",
  "requestedBy": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch"

payload = {
    "ConsentReceived": True,
    "idNumber": "<string>",
    "CRef": "<string>",
    "bankAccountNumber": "<string>",
    "contactNumber": "<string>",
    "emailAddress": "<string>",
    "requestedBy": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    idNumber: '<string>',
    CRef: '<string>',
    bankAccountNumber: '<string>',
    contactNumber: '<string>',
    emailAddress: '<string>',
    requestedBy: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'idNumber' => '<string>',
    'CRef' => '<string>',
    'bankAccountNumber' => '<string>',
    'contactNumber' => '<string>',
    'emailAddress' => '<string>',
    'requestedBy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "CRef": "<string>",
  "Message": "<string>",
  "results": [
    {
      "subjectSurname": "<string>",
      "subjectName": "<string>",
      "subjectDateOfBirth": "<string>",
      "subjectGender": "<string>",
      "subjectTitle": "<string>",
      "incidents": [
        {
          "incidentReference": "<string>",
          "incidentCategory": {
            "categoryNumber": "<string>",
            "categoryName": "<string>",
            "subCategoryNumber": "<string>",
            "subCategoryName": "<string>",
            "additionalDetails": "<string>"
          },
          "incidentLogDate": "<string>",
          "incidentDate": "<string>",
          "memberReference": "<string>",
          "member": "<string>",
          "reportedBy": "<string>",
          "savings": "<string>",
          "loss": "<string>",
          "details": "<string>",
          "forensicInformation": "<string>",
          "productAppliedFor": "<string>",
          "degreeOfFraud": "<string>",
          "idDocuments": [
            {
              "type": "<string>",
              "number": "<string>",
              "issueDate": "<string>",
              "country": "<string>"
            }
          ],
          "contactNumbers": [
            {
              "type": "<string>",
              "number": "<string>"
            }
          ],
          "addresses": [
            {
              "type": "<string>",
              "province": "<string>",
              "city": "<string>",
              "suburb": "<string>",
              "postalCode": "<string>",
              "streetName": "<string>",
              "streetNumber": "<string>"
            }
          ],
          "emailAddresses": [
            {
              "type": "<string>",
              "email": "<string>"
            }
          ],
          "bankAccounts": [
            {
              "bank": "<string>",
              "accountType": "<string>",
              "accountNo": "<string>"
            }
          ],
          "employers": [
            {
              "employerName": "<string>",
              "employerTelNo": "<string>",
              "occupation": "<string>",
              "companyRegisteredName": "<string>",
              "companyRegisteredNumber": "<string>"
            }
          ],
          "policeCases": [
            {
              "policeCaseNumber": "<string>",
              "policeStation": "<string>",
              "policeReportDate": "<string>",
              "officer": "<string>",
              "caseType": "<string>",
              "caseStatus": "<string>",
              "reasonForFiling": "<string>",
              "reasonForExtension": "<string>",
              "policeContactNumber": "<string>",
              "policeEmail": "<string>",
              "policeFax": "<string>",
              "details": "<string>"
            }
          ],
          "devices": [
            {
              "deviceType": "<string>",
              "imeiNumber": "<string>",
              "imisNumber": "<string>",
              "ipAddress": "<string>",
              "model": "<string>",
              "make": "<string>",
              "network": "<string>",
              "country": "<string>",
              "serialNumber": "<string>",
              "deviceBlacklisted": "<string>",
              "numberBlocked": "<string>"
            }
          ],
          "onlineDetails": [
            {
              "platformUsername": "<string>",
              "reportedToPlatformURL": "<string>",
              "reportedToPlatformUsername": "<string>",
              "platformURL": "<string>",
              "platformTypeOther": "<string>",
              "websiteURL": "<string>",
              "reportedToPlatform": "<string>",
              "reportedToDomainAdmin": "<string>",
              "domainAdmin": "<string>",
              "platformAccountStatus": "<string>",
              "platformURLStatus": "<string>",
              "platformType": "<string>",
              "platformUsernameStatus": "<string>",
              "websiteURLStatus": "<string>"
            }
          ],
          "cryptoDetails": [
            {
              "currencyType": "<string>",
              "currencyTypeOther": "<string>",
              "walletAddress": "<string>",
              "cryptoExchange": "<string>",
              "amount": "<string>",
              "exchangeWebsite": "<string>",
              "walletStatus": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "trackingNumber": "<string>"
}

Compliance & Screening

Perform detailed object search

This API is used to look up the South African Fraud Prevention Service(SAFPS) database and return any listings that are found against a South African ID Number, contact number, email address or bank account.

The following listings are returned by SAFPS:

Protective Registration (PR) – Indicates that the subject has taken out a PR with SAFPS, and the controller will require their PR number to validate their onboards or applications. This listing identifier is formatted as PR00088118.
Victim – Indicates that the subject has fallen victim to fraudulent activity. This listing identifier is formatted as VICTIM00349654.
SAFPS Hit (SH) – Indicates that the subject has been flagged for conducting fraudulent activity on the SAFPS database. This listing identifier is formatted as SH00349652.

POST

Citizen

SAFPSDetailedObjectSearch

Perform detailed object search

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "idNumber": "<string>",
  "CRef": "<string>",
  "bankAccountNumber": "<string>",
  "contactNumber": "<string>",
  "emailAddress": "<string>",
  "requestedBy": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch"

payload = {
    "ConsentReceived": True,
    "idNumber": "<string>",
    "CRef": "<string>",
    "bankAccountNumber": "<string>",
    "contactNumber": "<string>",
    "emailAddress": "<string>",
    "requestedBy": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    idNumber: '<string>',
    CRef: '<string>',
    bankAccountNumber: '<string>',
    contactNumber: '<string>',
    emailAddress: '<string>',
    requestedBy: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'idNumber' => '<string>',
    'CRef' => '<string>',
    'bankAccountNumber' => '<string>',
    'contactNumber' => '<string>',
    'emailAddress' => '<string>',
    'requestedBy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/SAFPSDetailedObjectSearch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"idNumber\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"contactNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"requestedBy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "CRef": "<string>",
  "Message": "<string>",
  "results": [
    {
      "subjectSurname": "<string>",
      "subjectName": "<string>",
      "subjectDateOfBirth": "<string>",
      "subjectGender": "<string>",
      "subjectTitle": "<string>",
      "incidents": [
        {
          "incidentReference": "<string>",
          "incidentCategory": {
            "categoryNumber": "<string>",
            "categoryName": "<string>",
            "subCategoryNumber": "<string>",
            "subCategoryName": "<string>",
            "additionalDetails": "<string>"
          },
          "incidentLogDate": "<string>",
          "incidentDate": "<string>",
          "memberReference": "<string>",
          "member": "<string>",
          "reportedBy": "<string>",
          "savings": "<string>",
          "loss": "<string>",
          "details": "<string>",
          "forensicInformation": "<string>",
          "productAppliedFor": "<string>",
          "degreeOfFraud": "<string>",
          "idDocuments": [
            {
              "type": "<string>",
              "number": "<string>",
              "issueDate": "<string>",
              "country": "<string>"
            }
          ],
          "contactNumbers": [
            {
              "type": "<string>",
              "number": "<string>"
            }
          ],
          "addresses": [
            {
              "type": "<string>",
              "province": "<string>",
              "city": "<string>",
              "suburb": "<string>",
              "postalCode": "<string>",
              "streetName": "<string>",
              "streetNumber": "<string>"
            }
          ],
          "emailAddresses": [
            {
              "type": "<string>",
              "email": "<string>"
            }
          ],
          "bankAccounts": [
            {
              "bank": "<string>",
              "accountType": "<string>",
              "accountNo": "<string>"
            }
          ],
          "employers": [
            {
              "employerName": "<string>",
              "employerTelNo": "<string>",
              "occupation": "<string>",
              "companyRegisteredName": "<string>",
              "companyRegisteredNumber": "<string>"
            }
          ],
          "policeCases": [
            {
              "policeCaseNumber": "<string>",
              "policeStation": "<string>",
              "policeReportDate": "<string>",
              "officer": "<string>",
              "caseType": "<string>",
              "caseStatus": "<string>",
              "reasonForFiling": "<string>",
              "reasonForExtension": "<string>",
              "policeContactNumber": "<string>",
              "policeEmail": "<string>",
              "policeFax": "<string>",
              "details": "<string>"
            }
          ],
          "devices": [
            {
              "deviceType": "<string>",
              "imeiNumber": "<string>",
              "imisNumber": "<string>",
              "ipAddress": "<string>",
              "model": "<string>",
              "make": "<string>",
              "network": "<string>",
              "country": "<string>",
              "serialNumber": "<string>",
              "deviceBlacklisted": "<string>",
              "numberBlocked": "<string>"
            }
          ],
          "onlineDetails": [
            {
              "platformUsername": "<string>",
              "reportedToPlatformURL": "<string>",
              "reportedToPlatformUsername": "<string>",
              "platformURL": "<string>",
              "platformTypeOther": "<string>",
              "websiteURL": "<string>",
              "reportedToPlatform": "<string>",
              "reportedToDomainAdmin": "<string>",
              "domainAdmin": "<string>",
              "platformAccountStatus": "<string>",
              "platformURLStatus": "<string>",
              "platformType": "<string>",
              "platformUsernameStatus": "<string>",
              "websiteURLStatus": "<string>"
            }
          ],
          "cryptoDetails": [
            {
              "currencyType": "<string>",
              "currencyTypeOther": "<string>",
              "walletAddress": "<string>",
              "cryptoExchange": "<string>",
              "amount": "<string>",
              "exchangeWebsite": "<string>",
              "walletStatus": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "trackingNumber": "<string>"
}

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

Example: “8511054170052”

This is the 13-digit South African Identification Number of the subject. This number will be used to perform lookups on the SAFPS database for listings.

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.

bankAccountNumber

string | null

Example: “045687123”

This is the bank account number of the subject. This number will be used to perform lookups on the SAFPS database for listings. Results may include listings unrelated to the subject in question.

contactNumber

string | null

Example: “27821234567”

This is the contact number of the subject. This number will be used to perform lookups on the SAFPS database for listings. Results may include listings unrelated to the subject in question.

emailAddress

string | null

Example: “john.doe@email.com”

This is the address of the subject. This email address will be used to perform lookups on the SAFPS database for listings. Results may include listings unrelated to the subject in question.

requestedBy

string | null

Example: “Goliath National Bank”

This is the name of the controller (Company or business) whom is calling the API.

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.

results

Results · object[] | null

Array of results returned by SAFPS. May contain multiple unrelated entries due to cross-referencing.

Show child attributes

trackingNumber

string | null

The unique tracking nnumber(GUID) generated and supplied for the transaction. This is used for audit, billing and support purposes.

Perform detailed search. This endpoint is deprecated and soon will be removed. Please migrate to /SAFPSDetailedObjectSearch Secure Citizen Bank Account Verification

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Perform detailed object search

Authorizations

Body

Response