updateScreeningConclusion

PUT /api/customer/{customerId}/screen/{screeningId}

updateScreeningConclusion

cURL

curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "conclusions": []
}
'

import requests

url = "https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}"

payload = { "conclusions": [] }
headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Domain-ID': '<x-domain-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({conclusions: []})
};

fetch('https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}', 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://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'conclusions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

$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://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}"

	payload := strings.NewReader("{\n  \"conclusions\": []\n}")

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

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	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.put("https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conclusions\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}")

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

request = Net::HTTP::Put.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conclusions\": []\n}"

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

200

{
  "additionalInformation": {
    "djMonitoringCaseId": "<string>",
    "djMonitoringTxId": "<string>",
    "faceCompareDocumentId": "<string>",
    "faceCompareSelfieId": "<string>",
    "ocrDocumentId": "<string>"
  },
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "facInformation": {
    "faceCompareDocumentId": 123,
    "faceCompareSelfieId": 123
  },
  "hasHit": true,
  "id": 123,
  "isPeriodic": true,
  "ocrInformation": {
    "ocrDocumentId": 123
  },
  "profileId": 123,
  "quickscanName": "<string>",
  "remarks": [
    "<string>"
  ],
  "screenedWith": [],
  "screeningConclusion": [],
  "status": {
    "createdAt": {
      "date": 123,
      "day": 123,
      "hours": 123,
      "minutes": 123,
      "month": 123,
      "nanos": 123,
      "seconds": 123,
      "time": 123,
      "timezoneOffset": 123,
      "year": 123
    },
    "createdBy": {
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastName": "<string>"
    },
    "id": 123,
    "profileId": 123,
    "screeningId": 123,
    "status": {},
    "updatedAt": {
      "date": 123,
      "day": 123,
      "hours": 123,
      "minutes": 123,
      "month": 123,
      "nanos": 123,
      "seconds": 123,
      "time": 123,
      "timezoneOffset": 123,
      "year": 123
    },
    "updatedBy": {
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastName": "<string>"
    }
  },
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "valid": true
}

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

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

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Path Parameters

customerId · integer<int64> · required

customerId

screeningId · integer<int64> · required

screeningId

Body

application/json

conclusionRequestDto

conclusions · enum<string>[]

Available options: ADVERSE_MEDIA, NO_HIT, OWN_RESTRICTED_LIST, PEP, SANCTION

Response

200

*/*

OK

additionalInformation · ScreeningAdditionalInformation · object

Show child attributes

createdAt · Timestamp · object

Show child attributes

createdBy · UserInfo · object

Show child attributes

facInformation · ScreeningFACInformation · object

Show child attributes

finalStatus · enum<string>

Available options: DONE, FAILED, NEVER, PENDING

hasHit · boolean

id · integer<int64>

isPeriodic · boolean

ocrInformation · ScreeningOCRInformation · object

Show child attributes

oddStatus · enum<string>

Available options: CLOSED, OPEN

profileId · integer<int64>

quickscanName · string

quickscanType · enum<string>

Available options: CORPORATE, INDIVIDUAL

remarks · string[]

screenedWith · enum<string>[]

Available options: ARTEMISCAN, DJ, FACE_COMPARE, INTERNET_SEARCH, OCR, OWN_RESTRICTED_LIST, TR

screeningConclusion · enum<string>[]

Available options: ADVERSE_MEDIA, NO_HIT, OWN_RESTRICTED_LIST, PEP, SANCTION

status · ScreeningStatusResponseDto · object

Show child attributes

updatedAt · Timestamp · object

Show child attributes

updatedBy · UserInfo · object

Show child attributes

valid · boolean