Get Screening Review

Retrieve detailed screening review information for a pre-approved transaction.

GET /api/preapprovedtransactions/{id}/screening-review

Get screening review for a QuickScan transaction

cURL

curl --request GET \
  --url http://localhost/api/api/preapprovedtransactions/{id}/screening-review \
  --cookie sessionid=

import requests

url = "http://localhost/api/api/preapprovedtransactions/{id}/screening-review"

headers = {"cookie": "sessionid="}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {cookie: 'sessionid='}};

fetch('http://localhost/api/api/preapprovedtransactions/{id}/screening-review', 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 => "http://localhost/api/api/preapprovedtransactions/{id}/screening-review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "sessionid=",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost/api/api/preapprovedtransactions/{id}/screening-review"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "sessionid=")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost/api/api/preapprovedtransactions/{id}/screening-review")
  .header("cookie", "sessionid=")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/api/api/preapprovedtransactions/{id}/screening-review")

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

request = Net::HTTP::Get.new(url)
request["cookie"] = 'sessionid='

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

200

{
  "id": 123,
  "client_transaction_id": "<string>",
  "cp_a": {
    "client_subject_id": "<string>",
    "subject_name": "<string>"
  },
  "cp_b": {
    "client_subject_id": "<string>",
    "subject_name": "<string>"
  },
  "name_screen_cpa": "<string>",
  "name_screen_cpb": "<string>",
  "has_related_case": "<string>",
  "related_cases": "<string>",
  "has_true_hit_cpa": "<string>",
  "has_true_hit_cpb": "<string>",
  "has_unmarked_hit_cpa": "<string>",
  "has_unmarked_hit_cpb": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "modified_on": "2023-11-07T05:31:56Z",
  "transaction_timestamp": "2023-11-07T05:31:56Z",
  "transaction_type": "<string>",
  "amount": 123,
  "transaction_currency": "<string>",
  "payment_mode": "<string>",
  "approved_on": "2023-11-07T05:31:56Z",
  "approved_by": 123,
  "assignee": 123,
  "comment": "<string>"
}

This endpoint returns detailed screening review information for a single pre-approved transaction, including:

• Transaction details (amount, currency, parties, etc.)
• Counterparty A & B information with subject names
• NameScreen results for both parties
• NameScreenHits grouped by engine with full hit details

Authorizations

sessionid · string · cookie · required

Path Parameters

id · integer · required

A unique integer value identifying this pre approved transaction.

Response

200 - application/json

Serializer for PreApprovedTransaction model.

NOTE: name_screen_cpa and name_screen_cpb are now queried dynamically via client_transaction_id (no longer FK fields). Maintains backward compatibility.

id · integer · required · read-only

client_transaction_id · string · required

Client's transaction ID (unique identifier)

Maximum string length: 255

cp_a · object · required

Show child attributes

cp_b · object · required

Show child attributes

name_screen_cpa · string · required · read-only

name_screen_cpb · string · required · read-only

has_related_case · string · required · read-only

related_cases · string · required · read-only

has_true_hit_cpa · string · required · read-only

has_true_hit_cpb · string · required · read-only

has_unmarked_hit_cpa · string · required · read-only

has_unmarked_hit_cpb · string · required · read-only

created_on · string<date-time> · required · read-only

modified_on · string<date-time> · required · read-only

status · enum<string>

Status of the pre-approval workflow

• on_hold - on_hold
• approved - approved
• rejected - rejected
• not_screened - not_screened
• cleared - cleared

Available options: on_hold, approved, rejected, not_screened, cleared

transaction_timestamp · string<date-time> | null

transaction_type · string

Maximum string length: 255

amount · number<double> | null

transaction_currency · string | null

Transaction currency code

payment_mode · string

Maximum string length: 255

approved_on · string<date-time> | null

approved_by · integer | null

assignee · integer | null

User assigned to review this transaction

comment · string

Review comment or decision rationale