Explainable public default-risk indicator

Returns a deterministic, explainable HelpMyAgent public-data default-risk indicator. It is not an official credit score.

0.075 USD

Charged on valid result · Empty result not charged · Errors not charged

When to use this API?

Use for

  • Returns a deterministic, explainable HelpMyAgent public-data default-risk indicator. It is not an official credit score.

Avoid when

  • Do not use this endpoint as a legal, regulated credit or guaranteed fraud-free decision unless explicitly stated otherwise.

Limitations

  • Coverage depends on the public sources listed for this endpoint.

Sources and provenance

recherche-entreprises.api.gouv.fr

recherche-entreprises.api.gouv.fr

bodacc-datadila.opendatasoft.com

bodacc-datadila.opendatasoft.com

Input / Output schemas

Simplified endpoint contracts. The complete schema remains available in OpenAPI 3.1.

OpenAPI 3.1 →

Input schema
identifierstring

Required

View full JSON Schema
{
    "type": "object",
    "properties": {
        "identifier": {
            "type": "string",
            "pattern": "^[0-9]{9}([0-9]{5})?$"
        }
    },
    "required": [
        "identifier"
    ],
    "additionalProperties": false
}
Output schema
identifierstring

Required

identifier_typestring

Required

existsboolean

Required

siren

Required

name

Required

score

Required

levelstring

Required

confidencestring

Required

known_weight_percent

componentsarray

Required

limitationsarray

View full JSON Schema
{
    "type": "object",
    "properties": {
        "identifier": {
            "type": "string"
        },
        "identifier_type": {
            "type": "string"
        },
        "exists": {
            "type": "boolean"
        },
        "siren": [],
        "name": [],
        "score": [],
        "level": {
            "type": "string"
        },
        "confidence": {
            "type": "string"
        },
        "known_weight_percent": [],
        "components": {
            "type": "array"
        },
        "limitations": {
            "type": "array"
        }
    },
    "required": [
        "identifier",
        "identifier_type",
        "exists",
        "siren",
        "name",
        "score",
        "level",
        "confidence",
        "components"
    ],
    "additionalProperties": false
}