# getCompanyCartography

**Identifier:** `pappers_getCompanyCartography`

**Provider:** [Pappers](https://kirha.com/providers/pappers.md)

Get the corporate mapping/cartography of a French company showing relationships and ownership structure.

## Run it with the CLI

```bash
kirha tools run pappers_getCompanyCartography \
  --input '{
    "siren": "<siren>"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "pappers_getCompanyCartography",
  "input": {
    "siren": "<siren>"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "degree": {
      "description": "Manually choose a degree for cartography (<=2 or >2)",
      "maximum": 4,
      "minimum": 1,
      "type": "number"
    },
    "includeCitedCompanies": {
      "default": false,
      "description": "Include companies cited jointly with the searched company in acts and statutes",
      "type": "boolean"
    },
    "siren": {
      "description": "Company SIREN number (9 digits)",
      "maxLength": 9,
      "minLength": 9,
      "pattern": "^\\d{9}$",
      "type": "string"
    }
  },
  "required": [
    "siren"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "companies": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "siren": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "siren",
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "companyToCompanyLinks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "fromCompanyId": {
            "type": "string"
          },
          "toCompanyId": {
            "type": "string"
          }
        },
        "required": [
          "fromCompanyId",
          "toCompanyId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "companyToPersonLinks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "companyId": {
            "type": "string"
          },
          "personId": {
            "type": "string"
          }
        },
        "required": [
          "companyId",
          "personId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "modifications": {
      "additionalProperties": false,
      "properties": {},
      "type": "object"
    },
    "people": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "firstName": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "level": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "firstName",
          "lastName",
          "level"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "totalCompanies": {
      "type": "number"
    },
    "totalLinks": {
      "type": "number"
    },
    "totalPeople": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "companies",
    "people",
    "companyToPersonLinks",
    "companyToCompanyLinks",
    "totalCompanies",
    "totalPeople",
    "totalLinks"
  ],
  "type": "object"
}
```

-----

[All Pappers tools](https://kirha.com/providers/pappers.md) · [< Back to tools list](https://kirha.com/tools.md)