C# need url and sample for consumption world check one api with api key and secret

Hello team:

Please provide url and coding sample for consumption web api with api key and secret.


Tried using ServiceStack and RestSharp but cannot proper way to embed key and secret while consuming the api.

Best Answer

  • @cheang.tim

    Please start with "SEQ-screen-sync-individual: Perform Synchronous Screening: Individual" this will enable you to both screens an entity and retrieve the information in the same API call.

    Simultaneously I am sending you an email copying ur onboarding specialist who will give you a session on how you can start using the APIs and what APIs to use as per your use cases.

    Email to follow soon.

Answers

  • Using WC1PostRequest.cs for testing connectivity from https://developers.refinitiv.com/en/api-catalog/customer-and-third-party-screening/world-check-one-api/downloads


    Tested with default

    string postData = "{\"secondaryFields\":[],\"entityType\":\"INDIVIDUAL\",\"customFields\":[],\"groupId\":\"418f28a7-b9c9-4ae4-8530-819c61b1ca6c\",\"providerTypes\":[\"WATCHLIST\"],\"name\":\"乔治布什\"}";


    Obtained Exception

    An unhandled exception of type 'System.Net.WebException' occurred in System.dll
    Additional information: The remote server returned an error: (404) Not Found.

    Is this normal? which means "乔治布什" does not exists in WC1 database?

    Would you please provide a test case which is in your database for testing, so i can formulate the object for json conversion and display for the client.

    Thanks for answering.

  • Would you also provide another example for testing, such that i can use a proper structure type for the "children": [] in the object, since i need to convert the json into object with proper type

    [
      {
        "id": "5nzbfqao1qzg1fawy4idhb6s5",
        "name": "Banco Delta Ásia, S.A. - API (P)",
        "parentId": null,
        "hasChildren": false,
        "status": "ACTIVE",
        "children": []
      }
    ]

    Many Thanks for helping.

  • @cheang.tim

    The 404 that you're seeing is due to the usage of the dummy group Id in the code. please use your own group Id "5nzbfqao1qzg1fawy4idhb6s5" in your screening request as rightly seen in your screenshot above.

    Now, you don't have any child groups for your account which is why it is empty, to give you a quick background on this we offer our clients the functionality to have child groups for data segregation purposes, for example, if you wanna categorize your cases based on regions/types of users you can do so by using the different groups for respective screenings.

    If you want to have a child group you need to create one via the World-Check One UI and if there is no such requirement from your end you can simply use the parent group for all your screenings and it will work totally fine.


    Hope this helps.


  • Dear Team:

    1.Is it that we need to use "5nzbfqao1qzg1fawy4idhb6s5" as constant for post api ?

    2. In the example of GET API (WC1GetRequest.cs), how can i embed the target client info, which i want to check the credibility through WC1.

    Since currently, i only see the client entry in the POST API method.

    For example, i want to check the credibility of "乔治布什" through the GET API, how can i embeded the name of "乔治布什" since currently, i do not see an entry for "乔治布什" in the GET API and know whether "乔治布什" is credible or not.


    3. i can see an entry of "乔治布什" in the POST API which will be used to feedback WC1. However, i do not see how to change status in below statement. Please tell how.

    string postData = "{\"secondaryFields\":[],\"entityType\":\"INDIVIDUAL\",\"customFields\":[],\"groupId\":\""+ WC1.bdagroupID + "\",\"providerTypes\":[\"WATCHLIST\"],\"name\":\"乔治布什\"}";

    4.Please provide some guideline or data dictionary for reading result from API.

    {
      "caseId": "5nzbfkdrgika1fbguooe52ui5",
      "name": "乔治布什",
      "providerTypes": [
        "WATCHLIST"
      ],
      "customFields": [],
      "secondaryFields": [],
      "groupId": "5nzbfqao1qzg1fawy4idhb6s5",
      "entityType": "INDIVIDUAL",
      "caseSystemId": "5nzbfkdrgika1fbguooe52ui6",
      "caseScreeningState": "INITIAL",
      "lifecycleState": "UNARCHIVED",
      "creator": {
            "id": "5nzbfqao1qzg1fawy4idhb6uj",
        "firstName": "Harry",
        "lastName": "Chow",
        "fullName": "Harry Chow",
        "email": "chow.harry@delta-asia.com",
        "status": "ACTIVE",
        "userId": "5nzbfqao1qzg1fawy4idhb6uj"
      },
      "modifier": {
            "id": "5nzbfqao1qzg1fawy4idhb6uj",
        "firstName": "Harry",
        "lastName": "Chow",
        "fullName": "Harry Chow",
        "email": "chow.harry@delta-asia.com",
        "status": "ACTIVE",
        "userId": "5nzbfqao1qzg1fawy4idhb6uj"
      },
      "assignee": null,
      "creationDate": "2021-01-12T05:52:37.773Z",
      "modificationDate": "2021-01-12T05:52:37.773Z",
      "outstandingActions": false
    }


    Many thanks for helping.


  • @cheang.tim

    1. Yes, the group Id would remain constant as long as long as you don't delete it or update it with new one.

    2. For screening operation you will have to utilize the post call, get call perform various other operations such as fetching your group details, case template etc.

    I would request you to familiarize yourself with all the APIs by downloading the postman collection from our developer community and use them on the postman application.

    I would also recommend you to go through the technical documentation specially the yaml file in it to understand the entire request and response structure of the APIs.

    You can get this again from the download section using the link below:

    https://developers.refinitiv.com/en/api-catalog/customer-and-third-party-screening/world-check-one-api/downloads


    Let me know if you need a call.

  • As suggested I checked the yaml manual (6415 lines) and I tried to imported the json to postman(55 APIs) .

    However, there are too many of API end points to start with, which we only need 2 of the functional API at the moment.


    Might I ask you simply give us 2 starting end points for basic usage at the moment.


    1. API for checking a client name is credibile or not

    2. API for feedback WC1 a client to be creditable/discredit


    For which I can look into details, and found out how to setup the entry in the api.


    Even for opening this small sample postman json as below screen or the 55 API,

    which i cannot find a direct relationship for above 2 functions

    image


    image

  • Dear support:

    would you please provide me a flow chart of when to use which API if multiple request is needed, since after reading yaml and Postman example, i do not know which API to start with, which contains too many requests.

    Many Thanks for helping.