api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "coverage": {
          "description": "'complete' true only when every block was served; 'unavailable' names degraded blocks, 'excluded' those trimmed by include=",
          "properties": {
            "complete": {
              "type": "boolean"
            },
            "excluded": {
              "type": "array"
            },
            "unavailable": {
              "type": "array"
            }
          },
          "required": [
            "complete"
          ],
          "type": "object"
        },
        "events": {
          "description": "BODACC block, shape of /company/events: dated insolvency/deregistration/sale announcements with factual flags. Empty list = stated fact; missing dataset degrades to 'unavailable', never a 5xx",
          "properties": {
            "company": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "status"
              ],
              "type": [
                "object",
                "null"
              ]
            },
            "coverage": {
              "properties": {
                "window": {
                  "properties": {
                    "from": {
                      "type": "string"
                    },
                    "to": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "from",
                    "to"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "window"
              ],
              "type": "object"
            },
            "events": {
              "items": {
                "properties": {
                  "court": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "effective_on": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "family": {
                    "type": "string"
                  },
                  "gazette_issue": {
                    "type": "string"
                  },
                  "nature": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "notice_number": {
                    "type": "integer"
                  },
                  "published_on": {
                    "type": "string"
                  },
                  "text": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "family",
                  "gazette_issue",
                  "notice_number",
                  "published_on"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "flags": {
              "properties": {
                "has_open_insolvency_announcement": {
                  "type": "boolean"
                },
                "is_deregistered": {
                  "type": "boolean"
                },
                "latest_event": {
                  "properties": {
                    "date": {
                      "type": "string"
                    },
                    "family": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "date",
                    "family"
                  ],
                  "type": [
                    "object",
                    "null"
                  ]
                }
              },
              "required": [
                "has_open_insolvency_announcement",
                "is_deregistered",
                "latest_event"
              ],
              "type": "object"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "siren": {
              "type": "string"
            },
            "total": {
              "type": "integer"
            },
            "truncated": {
              "type": "boolean"
            },
            "unavailable": {
              "type": "string"
            }
          },
          "required": [
            "company",
            "coverage",
            "events",
            "flags",
            "provenance",
            "siren",
            "total",
            "truncated"
          ],
          "type": "object"
        },
        "identity": {
          "description": "Mandatory base block, shape of /company/resolve, from the monthly INSEE Sirene snapshot. The report is only billed when this block exists",
          "properties": {
            "acronym": {
              "type": [
                "string",
                "null"
              ]
            },
            "coverage": {
              "properties": {
                "missing": {
                  "type": "array"
                }
              },
              "required": [
                "missing"
              ],
              "type": "object"
            },
            "created_on": {
              "type": "string"
            },
            "headquarters": {
              "properties": {
                "address": {
                  "properties": {
                    "city": {
                      "type": "string"
                    },
                    "line": {
                      "type": "string"
                    },
                    "postal_code": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "city",
                    "line",
                    "postal_code"
                  ],
                  "type": "object"
                },
                "created_on": {
                  "type": "string"
                },
                "siret": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                }
              },
              "required": [
                "address",
                "created_on",
                "siret",
                "status"
              ],
              "type": "object"
            },
            "is_employer": {
              "type": [
                "boolean",
                "null"
              ]
            },
            "last_processed_on": {
              "type": "string"
            },
            "legal_form": {
              "properties": {
                "code": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "required": [
                "code",
                "label"
              ],
              "type": "object"
            },
            "main_activity": {
              "properties": {
                "code": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "nomenclature": {
                  "type": "string"
                }
              },
              "required": [
                "code",
                "label",
                "nomenclature"
              ],
              "type": "object"
            },
            "name": {
              "type": "string"
            },
            "natural_person": {
              "type": [
                "object",
                "null"
              ]
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "siren": {
              "type": "string"
            },
            "social_economy": {
              "type": [
                "boolean",
                "null"
              ]
            },
            "status": {
              "type": "string"
            },
            "workforce": {
              "properties": {
                "bracket": {
                  "type": "string"
                },
                "year": {
                  "type": "integer"
                }
              },
              "required": [
                "bracket",
                "year"
              ],
              "type": "object"
            }
          },
          "required": [
            "coverage",
            "provenance",
            "siren",
            "status"
          ],
          "type": "object"
        },
        "lei": {
          "description": "GLEIF block (CC0): global legal identity matched from the SIREN, plus 'ultimate_parent', the consolidating group head - the check an endpoint-by-endpoint review misses. Accounting parent, NOT beneficial ownership. total_matches 0 = no LEI, a stated fact",
          "properties": {
            "entity_status": {
              "type": [
                "string",
                "null"
              ]
            },
            "legal_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "lei": {
              "type": [
                "string",
                "null"
              ]
            },
            "limits": {
              "type": "string"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "registration_status": {
              "type": [
                "string",
                "null"
              ]
            },
            "total_matches": {
              "type": "integer"
            },
            "ultimate_parent": {
              "properties": {
                "link": {
                  "properties": {
                    "entity": {
                      "properties": {
                        "legal_country": {
                          "type": "string"
                        },
                        "legal_name": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "legal_country",
                        "legal_name"
                      ],
                      "type": "object"
                    },
                    "lei": {
                      "type": "string"
                    },
                    "relationship_status": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "entity",
                    "lei",
                    "relationship_status"
                  ],
                  "type": "object"
                },
                "status": {
                  "type": "string"
                }
              },
              "required": [
                "link",
                "status"
              ],
              "type": "object"
            },
            "unavailable": {
              "type": "string"
            },
            "verified_against_sirene": {
              "type": [
                "boolean",
                "null"
              ]
            }
          },
          "required": [
            "entity_status",
            "legal_name",
            "lei",
            "limits",
            "provenance",
            "registration_status",
            "total_matches",
            "verified_against_sirene"
          ],
          "type": "object"
        },
        "peppol": {
          "description": "Peppol block, shape of /company/peppol: e-invoicing reachability and accepted document types from the dated directory export. 'reachable: false' is a paid, dated fact; missing dataset = 'unavailable', never a 5xx",
          "properties": {
            "company": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "status"
              ],
              "type": [
                "object",
                "null"
              ]
            },
            "coverage": {
              "properties": {
                "directory_as_of": {
                  "type": "string"
                },
                "note": {
                  "type": "string"
                }
              },
              "required": [
                "directory_as_of",
                "note"
              ],
              "type": "object"
            },
            "participants": {
              "items": {
                "properties": {
                  "country": {
                    "type": "string"
                  },
                  "document_types": {
                    "items": {
                      "properties": {
                        "display_name": {
                          "type": "string"
                        },
                        "identifier": {
                          "type": "string"
                        },
                        "label": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "display_name",
                        "identifier",
                        "label"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "id": {
                    "type": "string"
                  },
                  "names": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "registered_on": {
                    "type": "string"
                  },
                  "scheme": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "country",
                  "document_types",
                  "id",
                  "names",
                  "registered_on",
                  "scheme",
                  "value"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "reachable": {
              "type": "boolean"
            },
            "unavailable": {
              "type": "string"
            }
          },
          "required": [
            "company",
            "coverage",
            "participants",
            "provenance",
            "reachable"
          ],
          "type": "object"
        },
        "siren": {
          "type": "string"
        },
        "summary": {
          "description": "Factual synthesis derived mechanically from the served blocks - never a rating or risk score. A missing field means the block was excluded or unavailable, stated in coverage",
          "properties": {
            "has_open_insolvency_announcement": {
              "type": "boolean"
            },
            "lei": {
              "type": "string"
            },
            "peppol_reachable": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "vat_status": {
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        },
        "vat": {
          "description": "VAT block, shape of /company/vat: FR VAT number derived from the SIREN, checked live against VIES (the report's only network call). VIES down = status 'unverifiable' with a reason, never a 5xx",
          "properties": {
            "address": {
              "type": "string"
            },
            "checked_at": {
              "type": "string"
            },
            "country": {
              "type": "string"
            },
            "coverage": {
              "type": "string"
            },
            "derived_from_siren": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "reason": {
              "type": "string"
            },
            "status": {
              "type": "string"
            },
            "syntax_valid": {
              "type": "boolean"
            },
            "vat_number": {
              "type": "string"
            }
          },
          "required": [
            "checked_at",
            "country",
            "provenance",
            "status",
            "syntax_valid",
            "vat_number"
          ],
          "type": "object"
        }
      },
      "required": [
        "coverage",
        "identity",
        "siren",
        "summary"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}