(Tcl) Refinitiv World-Check One - Synchronous Screening (POST)

See more Refinitiv Examples

Sends a signed POST request to do simple synchronous screening.

Note: This example requires Chilkat v9.5.0.89 or later.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set json [new_CkJsonObject]

# Create the following JSON:
# 
# {
#   "keyId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
#   "hmacKey": "xxxxzI3vi58xxxCBxxx1+P/d8tGxx7KuLqN/KMPNxxxxekhj8/bx83+1YQSUxxxxYyv939ceY06GvhYRKmxxxx==",
#   "algorithm": "hmac-sha256",
#   "headers": [
#     "(request-target)",
#     "host",
#     "date",
#     "content-type",
#     "content-length"
#   ]
# }

# Substitute your actual API key and API secret in place of "api-key" and "api-secret"
CkJsonObject_UpdateString $json "keyId" "api-key"
CkJsonObject_UpdateString $json "hmacKey" "api-secret"
CkJsonObject_UpdateString $json "algorithm" "hmac-sha256"
CkJsonObject_UpdateString $json "headers[0]" "(request-target)"
CkJsonObject_UpdateString $json "headers[1]" "host"
CkJsonObject_UpdateString $json "headers[2]" "date"
CkJsonObject_UpdateString $json "headers[3]" "content-type"
CkJsonObject_UpdateString $json "headers[4]" "content-length"

set http [new_CkHttp]

# Setting the AuthSignature property causes the following header to be computed and added:
# Authorization: Signature keyId="...", algorithm="hmac-sha256", headers="(request-target) host date content-type content-length", signature="..."
CkHttp_put_AuthSignature $http [CkJsonObject_emit $json]

# Build the following JSON to be sent in the POST request body.

# {
#     "groupId": "{{group-id}}",
#     "entityType": "ORGANISATION",
#     "caseId": "",
#     "providerTypes": [
#         "WATCHLIST"
#     ],
#     "name": "COMPANY NAME",
#     "nameTransposition": false,
#     "secondaryFields": [],
#     "customFields": []
# }

# Use this online tool to generate code from sample JSON: 
# Generate Code to Create JSON

set jsonBody [new_CkJsonObject]

CkJsonObject_UpdateString $jsonBody "groupId" "{{group-id}}"
CkJsonObject_UpdateString $jsonBody "entityType" "ORGANISATION"
CkJsonObject_UpdateString $jsonBody "caseId" ""
CkJsonObject_UpdateString $jsonBody "providerTypes[0]" "WATCHLIST"
CkJsonObject_UpdateString $jsonBody "name" "COMPANY NAME"
CkJsonObject_UpdateBool $jsonBody "nameTransposition" 0
CkJsonObject_UpdateNewArray $jsonBody "secondaryFields"
CkJsonObject_UpdateNewArray $jsonBody "customFields"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api-worldcheck.refinitiv.com/v2/cases/screeningRequest" "application/json" $jsonBody]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkJsonObject $jsonBody
    exit
}

puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"

set jsonResp [new_CkJsonObject]

CkJsonObject_Load $jsonResp [CkHttpResponse_bodyStr $resp]

CkJsonObject_put_EmitCompact $jsonResp 0
puts [CkJsonObject_emit $jsonResp]

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

delete_CkJsonObject $json
delete_CkHttp $http
delete_CkJsonObject $jsonBody
delete_CkJsonObject $jsonResp