Secure Citizen Anti-Money Laundering Screening

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/AMLScreening \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "CRef": "<string>",
  "ResidentType": "<string>",
  "IdentificationNumber": "<string>",
  "Firstname": "<string>",
  "Surname": "<string>",
  "BirthDate": "<string>"
}
'

import requests

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

payload = {
    "ConsentReceived": True,
    "CRef": "<string>",
    "ResidentType": "<string>",
    "IdentificationNumber": "<string>",
    "Firstname": "<string>",
    "Surname": "<string>",
    "BirthDate": "<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,
    CRef: '<string>',
    ResidentType: '<string>',
    IdentificationNumber: '<string>',
    Firstname: '<string>',
    Surname: '<string>',
    BirthDate: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/AMLScreening', 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/AMLScreening",
  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,
    'CRef' => '<string>',
    'ResidentType' => '<string>',
    'IdentificationNumber' => '<string>',
    'Firstname' => '<string>',
    'Surname' => '<string>',
    'BirthDate' => '<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/AMLScreening"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<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/AMLScreening")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<string>\"\n}"

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

{
  "CRef": "<string>",
  "Message": "<string>",
  "result": true,
  "result_code": {
    "name": "<string>",
    "id": 123
  },
  "response_object": {
    "matches": [
      {
        "entityType": "<string>",
        "gender": "<string>",
        "names": "<string>",
        "dateListed": "2023-11-07T05:31:56Z",
        "number": "<string>",
        "reasonListed": "<string>",
        "comments": "<string>",
        "additionalInformation": [
          {
            "type": "<string>",
            "value": "<string>",
            "comments": "<string>"
          }
        ],
        "countries": [
          "<string>"
        ]
      }
    ]
  }
}

POST

Citizen

AMLScreening

Secure Citizen Anti-Money Laundering Screening

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/AMLScreening \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "CRef": "<string>",
  "ResidentType": "<string>",
  "IdentificationNumber": "<string>",
  "Firstname": "<string>",
  "Surname": "<string>",
  "BirthDate": "<string>"
}
'

import requests

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

payload = {
    "ConsentReceived": True,
    "CRef": "<string>",
    "ResidentType": "<string>",
    "IdentificationNumber": "<string>",
    "Firstname": "<string>",
    "Surname": "<string>",
    "BirthDate": "<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,
    CRef: '<string>',
    ResidentType: '<string>',
    IdentificationNumber: '<string>',
    Firstname: '<string>',
    Surname: '<string>',
    BirthDate: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/AMLScreening', 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/AMLScreening",
  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,
    'CRef' => '<string>',
    'ResidentType' => '<string>',
    'IdentificationNumber' => '<string>',
    'Firstname' => '<string>',
    'Surname' => '<string>',
    'BirthDate' => '<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/AMLScreening"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<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/AMLScreening")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"CRef\": \"<string>\",\n  \"ResidentType\": \"<string>\",\n  \"IdentificationNumber\": \"<string>\",\n  \"Firstname\": \"<string>\",\n  \"Surname\": \"<string>\",\n  \"BirthDate\": \"<string>\"\n}"

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

{
  "CRef": "<string>",
  "Message": "<string>",
  "result": true,
  "result_code": {
    "name": "<string>",
    "id": 123
  },
  "response_object": {
    "matches": [
      {
        "entityType": "<string>",
        "gender": "<string>",
        "names": "<string>",
        "dateListed": "2023-11-07T05:31:56Z",
        "number": "<string>",
        "reasonListed": "<string>",
        "comments": "<string>",
        "additionalInformation": [
          {
            "type": "<string>",
            "value": "<string>",
            "comments": "<string>"
          }
        ],
        "countries": [
          "<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.

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.

ResidentType

string | null

Client should indicate resident type applicable to the consumer

Values: rsa_citizen/foreign_national

IdentificationNumber

string | null

Client to provide the identification number that corresponds with the chosen resident type.

Firstname

string | null

Input the consumers first name.

Surname

string | null

Input the consumers surname.

BirthDate

string | null

Date of birth in format of DD-MM-YYYY.

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.

result

boolean

This will indicate whether the validation was successful.

result_code

object

Show child attributes

response_object

object

Show child attributes

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

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Secure Citizen Anti-Money Laundering Screening

Authorizations

Body

Response