Busca de empresa

Requisitos de autenticação:

• Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
• Para maior segurança, alguns endpoints também podem suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io
• Para informações sobre a implementação de mTLS, acesse Usando mTLS

O serviço de busca de empresas retorna uma lista de empresas que correspondem aos resultados informados pelo usuário por meio dos parâmetros do corpo. Quanto mais específicos forem os parâmetros fornecidos, mais precisos serão os resultados.

Você precisa informar um dos parâmetros Nome ou número para buscar uma empresa.

Company search

post

/

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: Create Services

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Your access token. See more in the 'Authentication' topic of this section.

Corpo

servicestringObrigatório

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

Default: kybCompanySearchExample: kybCompanySearch

metadataobjectOpcional

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

Respostas

200

Success

application/json

requestIdstringOpcional

messagestringOpcional

400

Invalid provided body

application/json

401

Invalid token

application/json

403

The token does not have permission to access this resource

application/json

500

Internal server error

application/json

post/

POST /v1/services/ HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "service": "kybCompanySearch",
  "parameters": {
    "name": "text",
    "country": "text",
    "number": "text",
    "state": "text"
  },
  "metadata": {}
}

{
  "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
          }
        }
      ]
    },
    "metadata": {}
  }
}