v1

latestOpenAPI 3.0.22026-07-26480119.6 KB
Company Groups

Retrieve authenticated company group information

Returns the full profile of the authenticated company group, including its configuration (eligible identifier type, max quantities) and the list of associated companies.

get/api/v1/company_groups/info

Response

Company group info returned

Example response

{
  "data": {
    "id": "1",
    "type": "company_group",
    "attributes": {
      "identifier": "my-company-group",
      "eligible_identifier_type": "cpf",
      "eligibles_quantity": 150,
      "reference_identifier_type": "cnpj",
      "eligibles_max_quantity": 200,
      "companies": [
        {
          "reference_identifier": "12345678000195",
          "reference_identifier_type": "cnpj"
        }
      ]
    }
  }
}