> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Probabilistic (fuzzy) identity match > Scores existing contacts against the supplied partial record using Jaro-Winkler field similarity and returns ranked candidates with a confidence score (0–1), a band (`auto_merge` | `review`), a per-field similarity breakdown, and a recommended action. Closes the deterministic-only gap: the identity graph keys on exact match_types (external_id / phone / email / anonymous_id), so two records of the same person that arrived with no shared exact key cannot be unified by rules alone. Supply at least one of email, phone, first_name, last_name, or company — an all-empty body is rejected. This surface is READ-ONLY: it scores and ranks, it never merges or mutates a contact. Owner / admin / developer with the `contacts:read` scope (the payload embeds contact PII). ## OpenAPI ````yaml /openapi.yaml post /api/v1/cdp/identity-resolution/probabilistic-match openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway paths: /api/v1/cdp/identity-resolution/probabilistic-match: post: tags: - CDP summary: Probabilistic (fuzzy) identity match description: >- Scores existing contacts against the supplied partial record using Jaro-Winkler field similarity and returns ranked candidates with a confidence score (0–1), a band (`auto_merge` | `review`), a per-field similarity breakdown, and a recommended action. Closes the deterministic-only gap: the identity graph keys on exact match_types (external_id / phone / email / anonymous_id), so two records of the same person that arrived with no shared exact key cannot be unified by rules alone. Supply at least one of email, phone, first_name, last_name, or company — an all-empty body is rejected. This surface is READ-ONLY: it scores and ranks, it never merges or mutates a contact. Owner / admin / developer with the `contacts:read` scope (the payload embeds contact PII). requestBody: required: true content: application/json: schema: type: object minProperties: 1 properties: email: type: string minLength: 3 maxLength: 254 phone: type: string minLength: 3 maxLength: 64 description: Accepts E.164 or display formats; normalized server-side. first_name: type: string minLength: 1 maxLength: 200 last_name: type: string minLength: 1 maxLength: 200 company: type: string minLength: 1 maxLength: 200 limit: type: integer minimum: 1 maximum: 50 default: 10 description: Max candidates returned (post-scoring). review_threshold: type: number minimum: 0 maximum: 1 default: 0.6 description: >- Confidence floor for the `review` band. Must be <= auto_merge_threshold. auto_merge_threshold: type: number minimum: 0 maximum: 1 default: 0.9 description: >- Confidence at/above which a candidate is banded `auto_merge`. responses: '200': description: Ranked match candidates (may be empty) content: application/json: schema: type: object properties: data: type: object properties: input: type: object additionalProperties: type: string description: Echo of the non-empty fields the caller matched on. candidates: type: array items: type: object properties: contact_id: type: string external_id: type: string nullable: true email: type: string nullable: true phone: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true company: type: string nullable: true confidence: type: number description: Overall confidence, 0–1. band: type: string enum: - auto_merge - review recommended_action: type: string enum: - merge - review matched_fields: type: array items: type: string field_scores: type: array items: type: object properties: field: type: string similarity: type: number weight: type: number count: type: integer blocking_candidates: type: integer review_threshold: type: number auto_merge_threshold: type: number meta: $ref: '#/components/schemas/ResponseMeta' '422': description: >- Validation error (empty body, or review_threshold > auto_merge_threshold) components: schemas: ResponseMeta: type: object required: - request_id - timestamp additionalProperties: false properties: request_id: type: string description: Unique request identifier (also returned as X-Request-Id header) timestamp: type: string format: date-time docs_url: type: string format: uri nullable: true securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````