Companies API

Overview

The Companies API  provides referring operations for handling companies. Companies have recruiters who post job opportunities. The public part of this API provides only one operation at the moment, which is the registration of a company. You can also check all the documentation through Swagger.


Operations

CRUD HTTP methods
Create POST

Creating/Registering a Company

curl -H 'Content-type: Content-Type: application/json' -H  'app-token: XYZ' \
     -X POST --url 'http://api.catho.com.br/v1/companies' \
     -d @/tmp/payload.json

The POST body (pointed out in the example above as the file /tmp/payload.json) is something like:

{
  "corporate_group_id": 2,
  "documents": [
    {
      "type": "CNPJ",
      "value": "47603015000108"
    }
  ],
  "legal_name": "Catho Online LTDA.",
  "trade_name": "Catho",
  "description": "Internet company in the recruitment business",
  "website": "http://www.catho.com.br/",
  "classification": {
    "economic_activity_legacy": "Finance",
    "economic_activity": "63.19-4-00",
    "economic_activity_secundary": [
      "63.19-4-00"
    ],
    "hiring_type": "HR",
    "size": "MICRO",
    "nationality": "NATIONAL",
    "commercial_processes": [
      "EXPORTATION",
      "IMPORTATION"
    ],
    "organizations": [
      "CATHO",
      "MANAGER"
    ]
  },
  "statistics": {
    "global_employees_quantity": 910,
    "local_employees_quantity": 10
  },
  "work_places": [
    {
      "main": true,
      "status": "ACTIVE",
      "phones": [
        "(11) 5555-5555"
      ],
      "address": {
        "street": "Alameda Juarí",
        "number": "262",
        "complement": "4º andar",
        "neighborhood": "Tamboré",
        "city": "Barueri",
        "state": "SP",
        "country": "Brasil",
        "postal_code": "06460-090"
      }
    }
  ]
}

If the operation was successful, the HTTP status code returned will be a 201 with the body:

{
  "id": 123
}

In the event of a failure, possible errors can be seen in the following section.


Errors

Some error may occur when trying to register a company. Below is a message list of errors that may occur.

Message
O campo Grupo econômico precisa ser do tipo Número, Null.
Documents without CNPJ, CPF, Protocol or DUNS.
O campo Razão social precisa ter o tamanho mínimo 1.
O campo Nome fantasia precisa ter o tamanho mínimo 1.
O campo Tipo de contratação precisa ter um dos valores: HR, COMPANY.
O campo Tamanho precisa ter um dos valores: Micro, Pequena, Média, Grande.
O campo Nacionalidade precisa ter um dos valores: NATIONAL, MULTINATIONAL.
O campo Processos comerciais precisa ter um dos valores: IMPORTATION, EXPORTATION.
O campo Organizações precisa ter um dos valores: Catho, Manager.
O campo Número de funcionários total precisa ser do tipo Número.
O campo Número de funcionários no local precisa ser do tipo Número.
O campo Status do escritório precisa ter um dos valores: Ativo, Inativo.
O campo Logradouro precisa ter o tamanho mínimo 1.
O campo Número do endereço precisa ter o tamanho mínimo 1.
O campo Bairro precisa ter o tamanho mínimo 1.
O campo Cidade precisa ter o tamanho mínimo 1.
O campo Estado precisa ter o tamanho mínimo 1.
O campo País precisa ter o tamanho mínimo 1.
O campo CEP precisa ter o tamanho mínimo 1.
Já existe uma empresa cadastrada com este documento.

Endpoints

We currently have only one base URL, as below:

Production: http://api.catho.com.br/v1/companies