Company search

The company search service returns a list of companies that match with the results inputed by the user by body params the more specific parameters informed, the more assertive are the results provided by the route.

You need to inform one of the parameters name or number to search a company.

Company search

The company search service is a resource that allows users to search for companies based on specific parameters. This route accepts the parameters listed below.
Permission required: Services query

POSThttps://api.public.caf.io/v1/services

Header parameters

Body

application/json

service*string

The name of the requested service, for Company Search need be "kybCompanySearch"

parametersobject

The data expected by the service Company Search

metadataobject

All fields passed to the metadata will be returned in the response, this field is useful to bring an internal identifier of the request for example

Response

200400401403500

Success

Body

application/json

requestIdstring

messagestring

dataobject

Data returned with companies inside

Request

JavaScriptCurl

const response = await fetch('https://api.public.caf.io/v1/services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "service": "kybCompanySearch"
    }),
});
const data = await response.json();

Response

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "kybCompanySearch",
    "serviceData": {
      "companies": [
        {
          "id": "R0ItMC0xNDA4NDk3OV9KY1JtaTVPWGl5ekQtb0UxTV8yV1pB",
          "score": 100,
          "availableServices": {
            "creditReportId": "GB-0-14084975",
            "businessIdentityId": "JcRmi5OXtyzD-oE1M_2WZA"
          },
          "company": {
            "name": "Apple INC.",
            "country": "BR",
            "address": "18 WIMBORNE ROAD, PENCOED, BRIDGEND, MID GLAMORGAN, CF35 6SG",
            "status": "Active",
            "number": 14084973
          }
        }
      ]
    }
  }
}