Document API

Search Company

Description

The searches for business on VietnamCredit. The Search company API returns up to 100 items per search results page.

Url request: api.vietnamcredit.com.vn/api/Search/filters

Method: GET

Request Parameters

The following are common parameters used with Search Company.

Name	Description	Required
`CompanyName`	Business name associated with the item. You can enter all or part of the name. Type: String Default: None	No
`RegistrationNumber`	Registration number associated with the item. You can enter all or part of the number. Type: String Default: None	No
`CountryCode`	Country code associated with the item. You can enter all or part of the code. Type: String Default: None	No
`Address`	Address associated with the item. You can enter all or part of the address. Type: String Default: None	No
`Page`	Returns a specific page of items from the available search results. Up to 100 items are returned per page. If you do not include `PageIndex` in your request, the first page is returned. The total number of pages found is returned in the `TotalPages` response element. Type: Integer Default: 1	Yes
`PageSize`	The total number of records returned in one request. Max value 100 records Type: Integer Default: 50	Yes

Response

The following are common elements that are returned.

Name	Description
`Success`	True: success False: fail
`Message`	Notification returned
`PageSize`	The total number of records returned in request
`PageIndex`	The current page is retrieving data
`TotalPages`	Total page
`TotalCount`	Total businesses found
`Data`	Container for item information, including Id, Name, TaxCode, TotalEmployees, AddressesHeadOffice, DefaultRisk, EstablishmentYear, RegisteredName, TradeName, EstablishmentDate, Website, RegistrationNumber, NameCEO, and RegistrationAddress.

Example Requests and Responses

Example Request

api.vietnamcredit.com.vn/api/Search/filters?page=1&pageSize=50

Example Responses

{
  "message": null,
  "success": true,
  "pageSize": 50,
  "pageIndex": 1,
  "totalCount": 2,
  "totalPages": 1,
  "data": [
    {
      "id": 6882,
      "crid": "CR0006882",
      "name": "HCMC GENERAL IMPORT EXPORT AND INVEZTMENT YOINT ZTOCK COMPANY",
      "registeredName": "CONG TY CO PHAN XUAT NHAP KHAU TONG HOP VA DAU TU THANH PHO HO CHI MINH (IMEXCO)",
      "tradeName": "HCMC GENERAL IMPORT EXPORT AND INVEZTMENT YOINT ZTOCK COMPANY",
      "businessID": "0845845456",      
      "headOfficeAddress": "22nd Floor, Keangnam Landmark 72 Building, E6, Pham Hung Street, Me Tri Ward, South Tu Liem District, Ha Noi City, Vietnam",
      "registrationNumber": "0845845456",
      "phoneNumber": "84462512564",
      "available": "true"                 
    },
    {
      "id": 6882,
      "crid": CR0006882,
      "name": "HCMC GENERAL IMPORT EXPORT AND INVEZTMENT YOINT ZTOCK COMPANY",
      "registeredName": "CONG TY CO PHAN XUAT NHAP KHAU TONG HOP VA DAU TU THANH PHO HO CHI MINH (IMEXCO)",
      "tradeName": "HCMC GENERAL IMPORT EXPORT AND INVEZTMENT YOINT ZTOCK COMPANY",
      "businessID": "1311121289",    
      "headOfficeAddress": "1st Floor - 24T2 Bld., Trung Hoa-Nhan Chinh, Hoang Dao Thuy Str, Cau Giay District, Ha Noi City, Vietnam",          
      "registrationNumber": "1311121289",        
      "phoneNumber": "84462512882/ 62512882/ 62512883",
      "available": "false"
    }
  ]
}