Get Match Suggestions (Internal)

Get pending match suggestions for 'other' uploads that match pending targeted items. Requires JWT (Bearer). Path: GET /internal/api/clients/{client_id}/intake-requests/{request_id}/match-suggestions

get/internal/api/clients/{client_id}/intake-requests/{request_id}/match-suggestions

Request

Base URL
https://api.signalshq.io (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Password
Token URL: /auth/login

Path parameters

request_idstring uuid required

client_idstring uuid required

Client ID

Response

Successful Response

document_idstring uuid required

ID of the document

item_upload_idstring uuid required

ID of the intake request upload record (tenant_client_intake_request_uploads.id)

current_item_idstring uuid required

ID of the current item (other/voluntary)

request_titlestring required

Title of the intake request

Example response

[
  {
    "suggested_item": {
      "document_type": "W2",
      "instance_name": "ACME Corporation",
      "document_classification": "W2",
      "document_type_identifier": "W2",
      "classified_instance_name": "ACME Corporation",
      "match_confidence": 95.5
    },
    "request_title": "2024 Tax Documents"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.