v24

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-201455128.8 KB
Companies

Get a company by ID

get/companies/{company_id}

Path parameters

company_idstring required

ID of the company

Query parameters

scopestring

Scope filter (id or scope)

documentboolean

Include document signed url

Response

Company details

portal_urlstring

Admin or internal portal URL for viewing the company's details, typically used by internal users.

source_idstring

Optional identifier indicating the source of the company record, useful for tracking or integration purposes.

webview_urlstring

Public-facing webview URL for the company’s identification process, allowing external access to the company data.

Example response

{
  "aml_suspicions": [
    {
      "caption": "Suspicious activity",
      "country": "FR",
      "gender": "M",
      "relation": "linked",
      "schema": "v1",
      "score": 0.85,
      "source": "https://aml-checker.example.com/api/v1/suspicion/12345",
      "status": "pending",
      "type": "pep"
    }
  ],
  "certificat": {
    "created_at": "2025-05-01T12:00:00Z",
    "filename": "certificate.pdf",
    "id": "cert_123"
  },
  "checks": [
    {
      "message": "Name matched successfully",
      "name": "name_match",
      "validate": true,
      "weight": 1
    }
  ],
  "company": {
    "address": "123 Rue de Paris, 75001 Paris, France",
    "closure_date": "2025-12-31",
    "commercial_name": "ACME",
    "contact": {
      "department": "Finance",
      "email": "alice.martin@example.com",
      "first_name": "Alice",
      "last_name": "Martin",
      "phone_number": "+33 1 23 45 67 89"
    },
    "country": "FR",
    "email": "contact@acme.com",
    "employees": 42,
    "employer_identification_number": "EIN987654321",
    "legal_form": "LLC",
    "name": "ACME Corp",
    "phone_number": "+33 1 23 45 67 89",
    "registration_date": "2010-05-20",
    "registration_id": "123456789",
    "share_capital": "100000 EUR",
    "status": "active",
    "tax_identification_number": "FR123456789",
    "type": "main",
    "website_url": "https://www.acme.com"
  },
  "documents": [
    {
      "checks": [
        {
          "message": "Name matched successfully",
          "name": "name_match",
          "validate": true,
          "weight": 1
        }
      ],
      "created_at": "2025-05-01T12:00:00Z",
      "document_type": "generic",
      "id": "doc_123",
      "name": "generic_doc",
      "signed_url": "https://cdn.example.com/doc.pdf",
      "state": "SUBMITTED",
      "status": "approved",
      "values": [
        {
          "confidence": 0.95,
          "name": "Full Name",
          "value": [
            100,
            200
          ]
        }
      ]
    }
  ],
  "members": [
    {
      "address": "456 Avenue de Lyon, 69000 Lyon, France",
      "birthday": "1980-06-15T00:00:00.000000+00:00",
      "birthplace": "Paris",
      "country": "FR",
      "documents": [
        {
          "checks": [
            {
              "message": "Name matched successfully",
              "name": "name_match",
              "validate": true,
              "weight": 1
            }
          ],
          "created_at": "2025-05-01T12:00:00Z",
          "document_type": "generic",
          "id": "doc_123",
          "name": "generic_doc",
          "signed_url": "https://cdn.example.com/doc.pdf",
          "state": "SUBMITTED",
          "status": "approved",
          "values": [
            {
              "confidence": 0.95,
              "name": "Full Name",
              "value": [
                100,
                200
              ]
            }
          ]
        }
      ],
      "email": "john.doe@example.com",
      "first_name": "John",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "is_beneficial_owner": true,
      "last_name": "Doe",
      "liveness_verification": true,
      "name": "ACME Corp",
      "ownership_percentage": 50,
      "phone_number": "+33 1 23 45 67 89",
      "postal_code": "69000",
      "registration_id": "987654321",
      "relation": "shareholder",
      "roles": "legal_representative",
      "source": "user",
      "state": "PROCESSED",
      "status": "approved",
      "type": "person",
      "workspace_id": "wk_123"
    }
  ],
  "portal_url": "https://portal.dataleon.ai/e/123",
  "properties": [
    {
      "name": "property_name",
      "type": "string",
      "value": "property_value"
    }
  ],
  "risk": {
    "code": "20030",
    "reason": "Document mismatch",
    "score": 0.92
  },
  "source_id": "src-001",
  "technical_data": {
    "api_version": 2,
    "approved_at": "2025-05-01T12:00:00Z",
    "approved_by": "user:john.doe",
    "callback_url": "https://example.com/callback",
    "callback_url_notification": "https://example.com/notify",
    "disable_notification_date": "2025-07-12T13:10:00Z",
    "export_type": "json",
    "filtering_score_aml_suspicions": 0.75,
    "finished_at": "2025-05-05T13:10:00Z",
    "ip": "192.168.1.1",
    "language": "fra",
    "location_ip": "203.0.113.45",
    "need_review_by": "user:reviewer01",
    "portal_steps": [
      "identity_verification",
      "selfie",
      "face_match"
    ],
    "qr_code": "false",
    "raw_data": true,
    "rejected_by": "user:jane.doe",
    "session_duration": 45,
    "started_at": "2025-05-05T13:00:00Z",
    "transfer_at": "2025-07-12T14:00:00Z",
    "transfer_mode": "API"
  },
  "webview_url": "https://id.dataleon.ai/e/123"
}