Sign in

v24

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

Create a new individual

post/individuals

Request body

source_idstring

Optional identifier for tracking the source system or integration from your system.

workspace_idstring required

Unique identifier of the workspace where the individual is being registered.

Example request

{
  "person": {
    "birthday": "15/05/1985",
    "email": "john.doe@example.com",
    "first_name": "John",
    "gender": "M",
    "last_name": "Doe",
    "maiden_name": "John Doe",
    "nationality": "FRA",
    "phone_number": "+33 1 23 45 67 89"
  },
  "source_id": "ID54410069066",
  "technical_data": {
    "callback_url": "https://example.com/callback",
    "callback_url_notification": "https://example.com/notify",
    "filtering_score_aml_suspicions": 0.75,
    "language": "fra",
    "portal_steps": [
      "identity_verification",
      "selfie",
      "face_match"
    ],
    "raw_data": true
  },
  "workspace_id": "wk_123"
}

Response

Individual created successfully

auth_urlstring uri

URL to authenticate the individual, usually for document signing or onboarding.

created_atstring date-time

Timestamp of the individual's creation in ISO 8601 format.

idstring uuid

Unique identifier of the individual.

numberinteger

Internal sequential number or reference for the individual.

portal_urlstring uri

Admin or internal portal URL for viewing the individual's details.

source_idstring

Optional identifier indicating the source of the individual record.

statestring

Current operational state in the workflow (e.g., WAITING, IN_PROGRESS, COMPLETED).

statusstring

Overall processing status of the individual (e.g., rejected, need_review, approved).

webview_urlstring uri

Public-facing webview URL for the individual’s identification process.

workspace_idstring

Identifier of the workspace to which the individual belongs.

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"
    }
  ],
  "auth_url": "https://id.dataleon.ai/a/123",
  "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
    }
  ],
  "created_at": "2025-05-05 12:34:56.789000+00:00",
  "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
          ]
        }
      ]
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identity_card": {
    "back_document_signed_url": "https://cdn.example.com/back.jpg",
    "birth_place": "Paris",
    "birthday": "01/01/1990",
    "country": "FR",
    "expiration_date": "2030-01-01",
    "first_name": "John",
    "front_document_signed_url": "https://cdn.example.com/front.jpg",
    "gender": "M",
    "id": "doc_001",
    "issue_date": "2020-01-01",
    "last_name": "Doe",
    "mrz_line_1": "P<FRADOE<<JOHN<<<<<<<<<<<<<<<<<<<",
    "mrz_line_2": "1234567890FRA9001019M2301012<<<<<<<<<<<<<<04",
    "type": "passport"
  },
  "number": 42,
  "person": {
    "birthday": "01/01/1990",
    "email": "john.doe@example.com",
    "face_image_signed_url": "https://cdn.example.com/face.jpg",
    "first_name": "John",
    "full_name": "John Doe",
    "gender": "M",
    "last_name": "Doe",
    "maiden_name": "Smith",
    "nationality": "FRA",
    "phone_number": "+33612345678"
  },
  "portal_url": "https://portal.dataleon.ai/w/123",
  "properties": [
    {
      "name": "property_name",
      "type": "string",
      "value": "property_value"
    }
  ],
  "risk": {
    "code": "20030",
    "reason": "Document mismatch",
    "score": 0.92
  },
  "source_id": "ID54410069066",
  "state": "WAITING",
  "status": "rejected",
  "tags": [
    {
      "key": "tag_name",
      "type": "string",
      "value": "tag_value"
    }
  ],
  "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/w/123",
  "workspace_id": "wk_123"
}