Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Company

Get company

Get a company by ID

  • Retrieve a company using their unique identifier.
  • Recuperar uma empresa usando seu identificador exclusivo.
get/companies/{id}

Path parameters

idinteger required

Company ID

Response

Company data retrieved successfully | Dado de empresa retornado com sucesso

bankstring required
bank_accountstring required
bank_account_digitstring required
bank_account_typestring required
bank_branchstring required
business_typestring
company_type'INVESTOR' | 'ACQUIRER' | 'MODERATOR' required
created_atstring
emailstring required
idinteger
legal_naturestring
namestring required
phonestring required
receivables_expiration_daysinteger
tax_numberstring required
trade_namestring
updated_atstring

Example response

{
  "bank": "001",
  "bank_account": "567890",
  "bank_account_digit": "0",
  "bank_account_type": "Poupança",
  "bank_branch": "1234",
  "business_type": "Investor",
  "company_type": "INVESTOR",
  "created_at": "2020-01-01 12:00:00",
  "email": "john.doe@example.com",
  "id": 1,
  "legal_nature": "Investor",
  "name": "Fitbank",
  "phone": "(11)99999-9999",
  "tax_number": "11.111.111/0001-11",
  "trade_name": "Fitbank",
  "updated_at": "2020-01-01 12:00:00"
}