Skip to main content

Basic Entity Search

GET 
/search/entity/byname/json

Basic Entity Search generates a data response containing all possible entities available in Handshakes database based on the user’s input, which is a company or person’s name or ID number. The result for each entity includes its name(s), entity type, registration number(s), and Handshakes Global Identifiers ("EntityGuid").

The entity’s registration number(s) or Handshakes Global Identifiers ("EntityGuid") can then be used as input to other APIs, such as to retrieve standard reports.

Available for: All Handshakes datasets, except for China Company Registry (CRCN)

Response format: JSON

Request​

Query Parameters

    searchText stringrequired

    Provide the name or ID number of the subject entity.
    If entity name is provided, the search is a partial text search that matches names containing words that begin with the words in the search text.
    Eg "silver pte" can return "Silverstarfish Pte Ltd" or "Star Silverfish Pte Ltd" but not "Starsilver Pte Ltd".
    If entity ID is provided, the search is an exact search.

    sourceshortname stringrequired

    Possible values: [CRSG, CRMY, CRVN]

    Name of the Handshakes dataset to search in. For available values to input, refer to output source_short_name of SEARCH: Data Source Search endpoint.

    filterby string

    Possible values: [Person, Firm]

    By including this parameter, the results will be filtered to list only entities of the defined type.

Header Parameters

    Authorization stringrequired

    Refer to Getting your Access Token to get access to the authorization token. Include the following prefix when using the authorization token: Bearer.

Responses​

Schema
    entity_guid string
    entity_type string
    name_list string[]
    uen_list string[]