What else do I need to hit the API

Hello, i was trying to hit the World Check One API following the quickstart guide.
I downloaded the Postman collection and onto de environment data i completed api secret and api key with the values you gave me.
After that i hit on run inside Postman and an error occurred: `TypeError: Cannot read property sigBytes of undefined`
Reading along the quickstart i found out I also need a Product Key, a Group ID, a Group name, a Case ID and a Case System Id, but couldn't found exacly what those values are and what they mean.
Hope i explained correctly and thank you in advance
Best Answer
-
Hi @isabel.ivagnes
As discussed over the call, We would like to let you know that "One or multiple Custom Fields can be created by the Client or Group Administrator and are used to capture additional reference information relevant to the entity being screened. For example, Account Manager, Internal Reference, and Cat Code. These fields may be marked as required or optional, depending on the settings established by the group administrators"Note: Custom Fields do not affect the screening results, rather they are used to capture reference details and can also be used for filtering in the Case Manager.
To know more on Custom Fields setting we request you to please navigate to "CUSTOM FIELDS section on https://my.refinitiv.com/content/dam/myrefinitiv/products/10834/en/UserGuides/611012.pdf
Once the Custom Fields configuration is completed, you can use the "SEQ-pre-group-case-template: Get the case template for a group" API call to retrieve the Custom Fields.
And also you can use those Custom Fields value to screen an entity via "SEQ-screen-sync-simple: Perform Synchronous Screening: Simple" API call. Sample Payload outlined below:{
"caseId": "Client Case Id",
"name": "John Smith",
"providerTypes": [
"WATCHLIST"
],
"customFields": [
{
"typeId": "Custom Field Id 1",
"value": "Reference Id 1234567"
},
{
"typeId": "Custom Field Id 2",
"value": "Deal Id 1234567"
}
],
"secondaryFields": [
{
"typeId": "SFCT_1",
"value": "MALE"
},
{
"typeId": "SFCT_2",
"dateTimeValue": "1990-11-20"
}
],
"nameTransposition": true,
"groupId": "Client Group Id",
"entityType": "INDIVIDUAL"
}
0
Answers
-
Hi @isabel.ivagnes
Thanks for your query!
Looks like at least one of your environment variables isn't defined, this may have occurred due to invalid import of POSTMAN collection.So, we request you to please follow the below step and let us know the outcome:
Step1: Please delete the existing POSTMAN collection
Step2: Delete the POSTMAN environment setting
Click on environment => click on eye icon => click on edit => click on 3 dots => then click on delete
Step3: Once the collection and environment is deleted, Please re-import the POSTMAN collection and then configure the environment.
Step4: Now, try initiating the API calls.
Moreover, please find the list of API calls to know the requested details:- SEQ-pre-groups: Get my top-level groups: This API call will get you the Group ID and Group name
For more details on group settings you can refer https://developers.refinitiv.com/en/api-catalog/customer-and-third-party-screening/world-check-one-api/documentation - CaseID & CasesystemID is unique field which will be generated by the world check system once you screen a entity using the API call "SEQ-screen-sync-simple: Perform Synchronous Screening: Simple".
caseSystemId can be used further to initiate multiple API calls like "SEQ-case-investigate-case-details: Fetch full case details" "SEQ-case-investigate-results: Get screening results" etc.
Please note: you can use your own unique CaseID while making screening API call otherwise world check system will generate CaseID for you.
0 - SEQ-pre-groups: Get my top-level groups: This API call will get you the Group ID and Group name
-
Hey! thanks for the quick reply. Thanks for clarifying about groups and CaseId. I followed your steps and re-imported the Postman collection. But i got into the same error. Apart from the environment data i imported, i completed the fields api-key and api-secret. Is there anything else i'm missing in the configuration on the environment?
0 -
Hi Isabel,
Can you confirm if "isabel.ivagnes@emeritus.org" is your domain id. If yes, then please let us know the best available time so that we can schedule a meeting to discuss this issue.
Thanks0 -
Yes that is my domain id. my day starts around 9AM UTC-3. Starting from that time, what is a good time for you?
Thanks
0 -
12th July 19:00 PM IST (i.e. 10:30 AM your time) will work fine for me. Let me know if you are okay with it, i will send out an invite.
Thanks0 -
that sounds great!
Thanks
0 -
0
Categories
- All Categories
- 3 Polls
- 6 AHS
- 36 Alpha
- 166 App Studio
- 6 Block Chain
- 4 Bot Platform
- 18 Connected Risk APIs
- 47 Data Fusion
- 34 Data Model Discovery
- 690 Datastream
- 1.4K DSS
- 629 Eikon COM
- 5.2K Eikon Data APIs
- 11 Electronic Trading
- 1 Generic FIX
- 7 Local Bank Node API
- 3 Trading API
- 2.9K Elektron
- 1.4K EMA
- 255 ETA
- 559 WebSocket API
- 39 FX Venues
- 15 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 25 Messenger Bot
- 3 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 60 Open Calais
- 279 Open PermID
- 45 Entity Search
- 2 Org ID
- 1 PAM
- PAM - Logging
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 23 RDMS
- 2K Refinitiv Data Platform
- 716 Refinitiv Data Platform Libraries
- 4 LSEG Due Diligence
- LSEG Due Diligence Portal API
- 4 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.2K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 12 World-Check Customer Risk Screener
- 1K World-Check One
- 46 World-Check One Zero Footprint
- 45 Side by Side Integration API
- 2 Test Space
- 3 Thomson One Smart
- 10 TR Knowledge Graph
- 151 Transactions
- 143 REDI API
- 1.8K TREP APIs
- 4 CAT
- 27 DACS Station
- 121 Open DACS
- 1.1K RFA
- 106 UPA
- 194 TREP Infrastructure
- 229 TRKD
- 918 TRTH
- 5 Velocity Analytics
- 9 Wealth Management Web Services
- 95 Workspace SDK
- 11 Element Framework
- 5 Grid
- 19 World-Check Data File
- 1 Yield Book Analytics
- 48 中文论坛