Discover Refinitiv
MyRefinitiv Refinitiv Perspectives Careers
Created with Sketch.
All APIs Questions & Answers  Register |  Login
Ask a question
  • Questions
  • Tags
  • Badges
  • Unanswered
Search:
  • Home /
  • Screening /
  • World-Check One /

For a deeper look into our World Check One API, look into:

Overview |  Quickstart |  Documentation |  Downloads

avatar image
Question by pmahamunee · Mar 12, 2019 at 05:20 AM · world-checkworld-check-onefields

How to use Secondary and custom fields in API calls?

Hello Team,

Can you please inform us what are the secondary fields and custom fields we can pass to 'cases/screeningRequest' and 'reference/profile/' API? What is format(syntax) we can pass these fields?

People who like this

0 Show 0
Comment
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

1 Reply

  • Sort: 
avatar image
REFINITIV
Best Answer
Answer by Prabhjyot · Mar 12, 2019 at 09:10 AM

Hi @pmahamunee,

You can get the details of the custom fields and the secondary fields from the API call - 'SEQ-pre-group-case-template: Get the case template for a group'.

Please note, that the custom fields needs to be created using the World-Check One UI. Once you have created the custom fields via the UI, the same will reflect in the above mentioned API call and used.

For a custom field you will have to define your own typeID and its curresponding value. For secondary fields values, World-Check One provides in your case template (Above mentioned API call).

If you wish to not include custom fields in your request payload you can just delete them from your request payload and pass the request.

World-Check One provides the functionality of passing custom fields as part of your request payload to track additional details at your end and are solely to be used from your end. The fields that you set form custom fields will not contribute in screening against World-Check One data.


Custom Fields :
If you are using the custom field, the request payload would be in the below format -

 "customFields": [  {   "typeId": "0a3687d0-6334-14a5-98e4-2dd200000f22",   "value": "Test_custom_field"  }]


If you are not using any custom field, the value for custom field would be in below format -

 "customFields": []

Secondary Fields :
The secondary field information is passed in the below format :

 "secondaryFields":[{  "typeId": "SFCT_1",  "value": "MALE",  },  {  "typeId": "SFCT_2",  "dateTimeValue": "1962-09-07"  },  {  "typeId": "SFCT_3",  "value": "IND",  }]


If you are not using any secondary field value in the secondary field, you may pass it blank, like below -

"secondaryFields":[]

Please note: the the value of the secondary fields are below -
SFCT_1 – GENDER
SFCT_2 – DOB
SFCT_3 – COUNTRY LOCATION
SFCT_4 – PLACE OF BIRTH
SFCT_5 – NATIONALITY
SFCT_6 – REG. COUNTRY (ORGANISATION)
SFCT_7 – IMO # (VESSEL)

Hope this helps.

Comment
cao-trung.do

People who like this

1 Show 0 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Watch this question

Add to watch list
Add to your watch list to receive emailed updates for this question. Too many emails? Change your settings >
10 People are following this question.

Related Questions

"cases/{ {case-system-id}}/screeningRequest" is not updating case results when called again after case update request

secondaryFields and customFields

How to define custom field for the group. Provide steps to add through UI.

Would the World Check API be able to handle a Date and Text parameters for a field?

Upload own list to check against

  • Copyright
  • Cookie Policy
  • Privacy Statement
  • Terms of Use
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Alpha
  • App Studio
  • Block Chain
  • Bot Platform
  • Connected Risk APIs
  • DSS
  • Data Fusion
  • Data Model Discovery
  • Datastream
  • Eikon COM
  • Eikon Data APIs
  • Electronic Trading
    • Generic FIX
    • Local Bank Node API
    • Trading API
  • Elektron
    • EMA
    • ETA
    • WebSocket API
  • Intelligent Tagging
  • Legal One
  • Messenger Bot
  • Messenger Side by Side
  • ONESOURCE
    • Indirect Tax
  • Open Calais
  • Open PermID
    • Entity Search
  • Org ID
  • PAM
    • PAM - Logging
  • ProView
  • ProView Internal
  • Product Insight
  • Project Tracking
  • RDMS
  • Refinitiv Data Platform
    • Refinitiv Data Platform Libraries
  • Rose's Space
  • Screening
    • Qual-ID API
    • Screening Deployed
    • Screening Online
    • World-Check One
    • World-Check One Zero Footprint
  • Side by Side Integration API
  • TR Knowledge Graph
  • TREP APIs
    • CAT
    • DACS Station
    • Open DACS
    • RFA
    • UPA
  • TREP Infrastructure
  • TRKD
  • TRTH
  • Thomson One Smart
  • Transactions
    • REDI API
  • Velocity Analytics
  • Wealth Management Web Services
  • Workspace SDK
    • Element Framework
    • Grid
  • World-Check Data File
  • 中文论坛
  • Explore
  • Tags
  • Questions
  • Badges