similarity

POST /api/v1/similarity/party-similarity/

Changed on Jul 17, 2026

"Party Similarity" admin task

POST params: - case_sensitive: bool - similarity_type: str[] - similarity_threshold: int - delete: bool

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/similarity/party-similarity/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

run_namestring required

case_sensitiveboolean required

similarity_type'token_set_ratio' | 'token_sort_ratio' nullable

similarity_thresholdinteger nullable

deleteboolean required

Example request

{
  "case_sensitive": true,
  "similarity_type": "token_set_ratio",
  "similarity_threshold": 0,
  "run_name": "run_name",
  "delete": true
}

Response

detailstring required

task_idstring

confirmboolean

Example response

{
  "confirm": true,
  "task_id": "task_id",
  "detail": "detail"
}

Changes

Jul 17, 20263429f921b4cb Revision changes
- breaking
  the request property became not nullable (media type: application/json)
- breaking
  the request property became not nullable (media type: application/x-www-form-urlencoded)
- breaking
  the request property became not nullable (media type: multipart/form-data)
- breaking
  the request property became not nullable (media type: application/json)
- breaking
  the request property became not nullable (media type: application/x-www-form-urlencoded)
- breaking
  the request property became not nullable (media type: multipart/form-data)
- breaking
  the request property became not nullable (media type: application/json)
- breaking
  the request property became not nullable (media type: application/x-www-form-urlencoded)
- breaking
  the request property became not nullable (media type: multipart/form-data)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/x-www-form-urlencoded)
- breaking
  the request property became required (media type: multipart/form-data)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/x-www-form-urlencoded)
- breaking
  the request property became required (media type: multipart/form-data)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/x-www-form-urlencoded)
- breaking
  the request property became required (media type: multipart/form-data)
May 24, 20218167164be9cc Revision changes
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  added the optional property to the response with the status

Operation history (3 revisions)